BugReporter.cpp revision 96f1061fbe59faff5b266a3a04061cefcfe03e2f
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" 2100605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek#include "clang/AST/ParentMap.h" 2216f0049415ec596504891259e2a83e19871c0d52Chris Lattner#include "clang/AST/StmtObjC.h" 2355fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/Analysis/CFG.h" 2461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek#include "clang/Analysis/ProgramPoint.h" 2555fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/Basic/SourceManager.h" 2655fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/StaticAnalyzer/Core/BugReporter/BugType.h" 279b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/BugReporter/PathDiagnostic.h" 2855fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "clang/StaticAnalyzer/Core/PathSensitive/ExprEngine.h" 29331b0ac44b9eb0ffcba66b4f3f3f9adb27c2434fTed Kremenek#include "llvm/ADT/DenseMap.h" 30802e02463b880f53a6e645bde78cc412481ce9e0Ted Kremenek#include "llvm/ADT/IntrusiveRefCntPtr.h" 3155fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "llvm/ADT/OwningPtr.h" 3255fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "llvm/ADT/STLExtras.h" 3355fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "llvm/ADT/SmallString.h" 34cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose#include "llvm/ADT/Statistic.h" 3555fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "llvm/Support/raw_ostream.h" 3610aa55410bbecbb658ce14a5f801d50cf06d12dfTed Kremenek#include <queue> 3761f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 3861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekusing namespace clang; 399ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremenekusing namespace ento; 4061f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 41cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan RoseSTATISTIC(MaxBugClassSize, 42cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose "The maximum number of bug reports in the same equivalence class"); 43cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan RoseSTATISTIC(MaxValidBugClassSize, 44cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose "The maximum number of bug reports in the same equivalence class " 45cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose "where at least one report is valid (not suppressed)"); 46cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose 478966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed KremenekBugReporterVisitor::~BugReporterVisitor() {} 481b431023814196f87515a540ebcb9e9f1a9176a1Ted Kremenek 4999ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikievoid BugReporterContext::anchor() {} 5099ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie 51cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 523106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// Helper routines for walking the ExplodedGraph and fetching statements. 53cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 5461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 559c378f705405d37f49795d5e915989de774fe11fTed Kremenekstatic const Stmt *GetPreviousStmt(const ExplodedNode *N) { 560f8579274a010f360a371b53101859d9d6052314Anna Zaks for (N = N->getFirstPred(); N; N = N->getFirstPred()) 570f8579274a010f360a371b53101859d9d6052314Anna Zaks if (const Stmt *S = PathDiagnosticLocation::getStmt(N)) 58b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek return S; 591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 60b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek return 0; 61b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek} 62b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek 635f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenekstatic inline const Stmt* 649c378f705405d37f49795d5e915989de774fe11fTed KremenekGetCurrentOrPreviousStmt(const ExplodedNode *N) { 650f8579274a010f360a371b53101859d9d6052314Anna Zaks if (const Stmt *S = PathDiagnosticLocation::getStmt(N)) 66b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek return S; 671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 68b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek return GetPreviousStmt(N); 69b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek} 701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 71b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek//===----------------------------------------------------------------------===// 72c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek// Diagnostic cleanup. 73c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek//===----------------------------------------------------------------------===// 74c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek 75b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenekstatic PathDiagnosticEventPiece * 76b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted KremenekeventsDescribeSameCondition(PathDiagnosticEventPiece *X, 77b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek PathDiagnosticEventPiece *Y) { 78b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek // Prefer diagnostics that come from ConditionBRVisitor over 79b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek // those that came from TrackConstraintBRVisitor. 80b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek const void *tagPreferred = ConditionBRVisitor::getTag(); 81b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek const void *tagLesser = TrackConstraintBRVisitor::getTag(); 82b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 83b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek if (X->getLocation() != Y->getLocation()) 84b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek return 0; 85b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 86b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek if (X->getTag() == tagPreferred && Y->getTag() == tagLesser) 87b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek return X; 88b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 89b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek if (Y->getTag() == tagPreferred && X->getTag() == tagLesser) 90b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek return Y; 91b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 92b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek return 0; 93b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek} 94b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 953800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek/// An optimization pass over PathPieces that removes redundant diagnostics 963800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek/// generated by both ConditionBRVisitor and TrackConstraintBRVisitor. Both 973800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek/// BugReporterVisitors use different methods to generate diagnostics, with 983800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek/// one capable of emitting diagnostics in some cases but not in others. This 993800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek/// can lead to redundant diagnostic pieces at the same point in a path. 1003800165e56107df7430520aa98afdf7065db2dd2Ted Kremenekstatic void removeRedundantMsgs(PathPieces &path) { 101b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek unsigned N = path.size(); 102b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek if (N < 2) 103b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek return; 1043800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek // NOTE: this loop intentionally is not using an iterator. Instead, we 1053800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek // are streaming the path and modifying it in place. This is done by 1063800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek // grabbing the front, processing it, and if we decide to keep it append 1073800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek // it to the end of the path. The entire path is processed in this way. 108b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek for (unsigned i = 0; i < N; ++i) { 109b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek IntrusiveRefCntPtr<PathDiagnosticPiece> piece(path.front()); 110b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek path.pop_front(); 111b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 112b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek switch (piece->getKind()) { 113b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek case clang::ento::PathDiagnosticPiece::Call: 1143800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek removeRedundantMsgs(cast<PathDiagnosticCallPiece>(piece)->path); 115b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek break; 116b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek case clang::ento::PathDiagnosticPiece::Macro: 1173800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek removeRedundantMsgs(cast<PathDiagnosticMacroPiece>(piece)->subPieces); 118b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek break; 119b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek case clang::ento::PathDiagnosticPiece::ControlFlow: 120b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek break; 121b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek case clang::ento::PathDiagnosticPiece::Event: { 122b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek if (i == N-1) 123b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek break; 124b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 125b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek if (PathDiagnosticEventPiece *nextEvent = 126ed866e73bab7733f5226f84c52edefe23d694b2fTed Kremenek dyn_cast<PathDiagnosticEventPiece>(path.front().getPtr())) { 127b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek PathDiagnosticEventPiece *event = 128b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek cast<PathDiagnosticEventPiece>(piece); 129b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek // Check to see if we should keep one of the two pieces. If we 130b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek // come up with a preference, record which piece to keep, and consume 131b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek // another piece from the path. 132b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek if (PathDiagnosticEventPiece *pieceToKeep = 133b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek eventsDescribeSameCondition(event, nextEvent)) { 134b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek piece = pieceToKeep; 135b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek path.pop_front(); 136b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek ++i; 137b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek } 138b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek } 139b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek break; 140b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek } 141b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek } 142b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek path.push_back(piece); 143b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek } 144b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek} 145b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 146d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek/// A map from PathDiagnosticPiece to the LocationContext of the inlined 147d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek/// function call it represents. 148bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenektypedef llvm::DenseMap<const PathPieces *, const LocationContext *> 149d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek LocationContextMap; 150d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek 151c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek/// Recursively scan through a path and prune out calls and macros pieces 152c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek/// that aren't needed. Return true if afterwards the path contains 153afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose/// "interesting stuff" which means it shouldn't be pruned from the parent path. 154d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenekstatic bool removeUnneededCalls(PathPieces &pieces, BugReport *R, 155d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek LocationContextMap &LCM) { 156c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek bool containsSomethingInteresting = false; 157c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek const unsigned N = pieces.size(); 158c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek 159c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek for (unsigned i = 0 ; i < N ; ++i) { 160c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek // Remove the front piece from the path. If it is still something we 161c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek // want to keep once we are done, we will push it back on the end. 162c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek IntrusiveRefCntPtr<PathDiagnosticPiece> piece(pieces.front()); 163c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek pieces.pop_front(); 164c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek 165afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose // Throw away pieces with invalid locations. Note that we can't throw away 166afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose // calls just yet because they might have something interesting inside them. 167afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose // If so, their locations will be adjusted as necessary later. 168a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek if (piece->getKind() != PathDiagnosticPiece::Call && 169a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek piece->getLocation().asLocation().isInvalid()) 170a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek continue; 171a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek 172725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek switch (piece->getKind()) { 173725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek case PathDiagnosticPiece::Call: { 174725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek PathDiagnosticCallPiece *call = cast<PathDiagnosticCallPiece>(piece); 17580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Check if the location context is interesting. 176bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek assert(LCM.count(&call->path)); 177bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (R->isInteresting(LCM[&call->path])) { 17880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks containsSomethingInteresting = true; 17980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 18080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 181368f3b070e8cb657a65bfa443d60256676d269e7Jordan Rose 182d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek if (!removeUnneededCalls(call->path, R, LCM)) 183368f3b070e8cb657a65bfa443d60256676d269e7Jordan Rose continue; 184a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek 185725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek containsSomethingInteresting = true; 186725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek break; 187725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek } 188725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek case PathDiagnosticPiece::Macro: { 189725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek PathDiagnosticMacroPiece *macro = cast<PathDiagnosticMacroPiece>(piece); 190d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek if (!removeUnneededCalls(macro->subPieces, R, LCM)) 191725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek continue; 192c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek containsSomethingInteresting = true; 193725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek break; 194725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek } 195725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek case PathDiagnosticPiece::Event: { 196725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek PathDiagnosticEventPiece *event = cast<PathDiagnosticEventPiece>(piece); 197a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek 198725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek // We never throw away an event, but we do throw it away wholesale 199725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek // as part of a path if we throw the entire path away. 20022505ef15e32db31a4f834a387cf73a913bc8f66Ted Kremenek containsSomethingInteresting |= !event->isPrunable(); 201725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek break; 202725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek } 203725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek case PathDiagnosticPiece::ControlFlow: 204725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek break; 205c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek } 206c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek 207c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek pieces.push_back(piece); 208c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek } 209c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek 210c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek return containsSomethingInteresting; 211c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek} 212c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek 213d474da062565596015558856333423199aed5eb1Jordan Rose/// Returns true if the given decl has been implicitly given a body, either by 214d474da062565596015558856333423199aed5eb1Jordan Rose/// the analyzer or by the compiler proper. 215d474da062565596015558856333423199aed5eb1Jordan Rosestatic bool hasImplicitBody(const Decl *D) { 216d474da062565596015558856333423199aed5eb1Jordan Rose assert(D); 217d474da062565596015558856333423199aed5eb1Jordan Rose return D->isImplicit() || !D->hasBody(); 218d474da062565596015558856333423199aed5eb1Jordan Rose} 219d474da062565596015558856333423199aed5eb1Jordan Rose 220afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose/// Recursively scan through a path and make sure that all call pieces have 221afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose/// valid locations. Note that all other pieces with invalid locations should 222afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose/// have already been pruned out. 223afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rosestatic void adjustCallLocations(PathPieces &Pieces, 224afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose PathDiagnosticLocation *LastCallLocation = 0) { 225afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose for (PathPieces::iterator I = Pieces.begin(), E = Pieces.end(); I != E; ++I) { 226ed866e73bab7733f5226f84c52edefe23d694b2fTed Kremenek PathDiagnosticCallPiece *Call = dyn_cast<PathDiagnosticCallPiece>(*I); 227afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose 228afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose if (!Call) { 229ed866e73bab7733f5226f84c52edefe23d694b2fTed Kremenek assert((*I)->getLocation().asLocation().isValid()); 230afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose continue; 231afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose } 232afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose 233afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose if (LastCallLocation) { 234d474da062565596015558856333423199aed5eb1Jordan Rose bool CallerIsImplicit = hasImplicitBody(Call->getCaller()); 235d474da062565596015558856333423199aed5eb1Jordan Rose if (CallerIsImplicit || !Call->callEnter.asLocation().isValid()) 236afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose Call->callEnter = *LastCallLocation; 237d474da062565596015558856333423199aed5eb1Jordan Rose if (CallerIsImplicit || !Call->callReturn.asLocation().isValid()) 238afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose Call->callReturn = *LastCallLocation; 239afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose } 240afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose 241afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose // Recursively clean out the subclass. Keep this call around if 242afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose // it contains any informative diagnostics. 243afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose PathDiagnosticLocation *ThisCallLocation; 244187f8bd88bfc92cf3fea62b7d8db5f92edce410aJordan Rose if (Call->callEnterWithin.asLocation().isValid() && 245d474da062565596015558856333423199aed5eb1Jordan Rose !hasImplicitBody(Call->getCallee())) 246afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose ThisCallLocation = &Call->callEnterWithin; 247afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose else 248afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose ThisCallLocation = &Call->callEnter; 249afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose 250afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose assert(ThisCallLocation && "Outermost call has an invalid location"); 251afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose adjustCallLocations(Call->path, ThisCallLocation); 252afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose } 253afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose} 254afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose 255c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek//===----------------------------------------------------------------------===// 2563106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// PathDiagnosticBuilder and its associated routines and helper objects. 257b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek//===----------------------------------------------------------------------===// 258b479dadea93b93d3f0a335c3518b703f140b3f50Ted Kremenek 259babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremeneknamespace { 260ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass NodeMapClosure : public BugReport::NodeResolver { 261c9963132736782d0c9178c744b3e2307cfb98a08Jordan Rose InterExplodedGraphMap &M; 2627dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenekpublic: 263c9963132736782d0c9178c744b3e2307cfb98a08Jordan Rose NodeMapClosure(InterExplodedGraphMap &m) : M(m) {} 2641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2659c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *getOriginalNode(const ExplodedNode *N) { 266c9963132736782d0c9178c744b3e2307cfb98a08Jordan Rose return M.lookup(N); 2677dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek } 2687dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek}; 2691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 270ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass PathDiagnosticBuilder : public BugReporterContext { 2717dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek BugReport *R; 272ef3643fbbbf66247c5e205497fae0f46e240c143David Blaikie PathDiagnosticConsumer *PDC; 2737dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek NodeMapClosure NMC; 2741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 27559950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek const LocationContext *LC; 27659950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek 2778966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek PathDiagnosticBuilder(GRBugReporter &br, 278c9963132736782d0c9178c744b3e2307cfb98a08Jordan Rose BugReport *r, InterExplodedGraphMap &Backmap, 279ef3643fbbbf66247c5e205497fae0f46e240c143David Blaikie PathDiagnosticConsumer *pdc) 2808966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek : BugReporterContext(br), 28159950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek R(r), PDC(pdc), NMC(Backmap), LC(r->getErrorNode()->getLocationContext()) 28259950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek {} 2831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2849c378f705405d37f49795d5e915989de774fe11fTed Kremenek PathDiagnosticLocation ExecutionContinues(const ExplodedNode *N); 2851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2869c378f705405d37f49795d5e915989de774fe11fTed Kremenek PathDiagnosticLocation ExecutionContinues(llvm::raw_string_ostream &os, 2879c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *N); 2881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2898e6431adab313e283a992698f6fc7afe62420999Anna Zaks BugReport *getBugReport() { return R; } 2908e6431adab313e283a992698f6fc7afe62420999Anna Zaks 291212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care Decl const &getCodeDecl() { return R->getErrorNode()->getCodeDecl(); } 29259950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek 29359950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek ParentMap& getParentMap() { return LC->getParentMap(); } 2941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 295c3f83ad7adaff2623986aa1c3e57833babd03d50Ted Kremenek const Stmt *getParent(const Stmt *S) { 296c3f83ad7adaff2623986aa1c3e57833babd03d50Ted Kremenek return getParentMap().getParent(S); 297c3f83ad7adaff2623986aa1c3e57833babd03d50Ted Kremenek } 2981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2998966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek virtual NodeMapClosure& getNodeResolver() { return NMC; } 3007297134f128423fce2e88f92421ed135bded7d4eDouglas Gregor 301d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek PathDiagnosticLocation getEnclosingStmtLocation(const Stmt *S); 3021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 303ef3643fbbbf66247c5e205497fae0f46e240c143David Blaikie PathDiagnosticConsumer::PathGenerationScheme getGenerationScheme() const { 304ef3643fbbbf66247c5e205497fae0f46e240c143David Blaikie return PDC ? PDC->getGenerationScheme() : PathDiagnosticConsumer::Extensive; 3057dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek } 3067dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek 307babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek bool supportsLogicalOpControlFlow() const { 308babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek return PDC ? PDC->supportsLogicalOpControlFlow() : true; 3091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 310babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek}; 311babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek} // end anonymous namespace 312babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek 31300605e0f011ed99225a22026344c5fc1b3212cd7Ted KremenekPathDiagnosticLocation 3149c378f705405d37f49795d5e915989de774fe11fTed KremenekPathDiagnosticBuilder::ExecutionContinues(const ExplodedNode *N) { 3150f8579274a010f360a371b53101859d9d6052314Anna Zaks if (const Stmt *S = PathDiagnosticLocation::getNextStmt(N)) 31659950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek return PathDiagnosticLocation(S, getSourceManager(), LC); 31700605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek 3180cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks return PathDiagnosticLocation::createDeclEnd(N->getLocationContext(), 3190cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks getSourceManager()); 320082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek} 3211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 32200605e0f011ed99225a22026344c5fc1b3212cd7Ted KremenekPathDiagnosticLocation 3239c378f705405d37f49795d5e915989de774fe11fTed KremenekPathDiagnosticBuilder::ExecutionContinues(llvm::raw_string_ostream &os, 3249c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *N) { 325babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek 326143ca222583a4a355fdc89af852deef287499300Ted Kremenek // Slow, but probably doesn't matter. 327b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek if (os.str().empty()) 328b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek os << ' '; 3291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 33000605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek const PathDiagnosticLocation &Loc = ExecutionContinues(N); 3311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 33200605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek if (Loc.asStmt()) 333b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek os << "Execution continues on line " 334642116259e8df6286063a17361c20e95b5017a0aChandler Carruth << getSourceManager().getExpansionLineNumber(Loc.asLocation()) 3358966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek << '.'; 3364f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek else { 3374f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek os << "Execution jumps to the end of the "; 3384f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek const Decl *D = N->getLocationContext()->getDecl(); 3394f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek if (isa<ObjCMethodDecl>(D)) 3404f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek os << "method"; 3414f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek else if (isa<FunctionDecl>(D)) 3424f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek os << "function"; 3434f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek else { 3444f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek assert(isa<BlockDecl>(D)); 3454f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek os << "anonymous block"; 3464f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek } 3474f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek os << '.'; 3484f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek } 3491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 350082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek return Loc; 351143ca222583a4a355fdc89af852deef287499300Ted Kremenek} 352143ca222583a4a355fdc89af852deef287499300Ted Kremenek 35396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rosestatic const Stmt *getEnclosingParent(const Stmt *S, const ParentMap &PM) { 354ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek if (isa<Expr>(S) && PM.isConsumedExpr(cast<Expr>(S))) 35596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose return PM.getParentIgnoreParens(S); 3561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 357ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek const Stmt *Parent = PM.getParentIgnoreParens(S); 35896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!Parent) 35996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose return 0; 3601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 36196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose switch (Parent->getStmtClass()) { 36296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose case Stmt::ForStmtClass: 36396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose case Stmt::DoStmtClass: 36496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose case Stmt::WhileStmtClass: 36596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose case Stmt::ObjCForCollectionStmtClass: 36696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose return Parent; 36796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose default: 36896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 36996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 3701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 37196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose return 0; 372ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek} 373ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek 37496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rosestatic PathDiagnosticLocation 37596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan RosegetEnclosingStmtLocation(const Stmt *S, SourceManager &SMgr, const ParentMap &P, 37696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const LocationContext *LC) { 37796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!S) 37896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose return PathDiagnosticLocation(); 3791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 38096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose while (const Stmt *Parent = getEnclosingParent(S, P)) { 381af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek switch (Parent->getStmtClass()) { 3825fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek case Stmt::BinaryOperatorClass: { 3835fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek const BinaryOperator *B = cast<BinaryOperator>(Parent); 3845fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek if (B->isLogicalOp()) 38596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose return PathDiagnosticLocation(Parent, SMgr, LC); 3865fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek break; 3871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 388af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::CompoundStmtClass: 389af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::StmtExprClass: 390220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 3911d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek case Stmt::ChooseExprClass: 3921d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek // Similar to '?' if we are referring to condition, just have the edge 3931d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek // point to the entire choose expression. 3941d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek if (cast<ChooseExpr>(Parent)->getCond() == S) 395220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(Parent, SMgr, LC); 3961d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek else 397220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 39856ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall case Stmt::BinaryConditionalOperatorClass: 3991d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek case Stmt::ConditionalOperatorClass: 4001d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek // For '?', if we are referring to condition, just have the edge point 4011d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek // to the entire '?' expression. 40256ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall if (cast<AbstractConditionalOperator>(Parent)->getCond() == S) 403220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(Parent, SMgr, LC); 4041d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek else 405220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 406af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::DoStmtClass: 407220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 408af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::ForStmtClass: 409af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek if (cast<ForStmt>(Parent)->getBody() == S) 410220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 4111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump break; 412af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::IfStmtClass: 413af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek if (cast<IfStmt>(Parent)->getCond() != S) 414220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 4158bd4d037d837e7922c3661d6158229da58a03887Ted Kremenek break; 416af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::ObjCForCollectionStmtClass: 417af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek if (cast<ObjCForCollectionStmt>(Parent)->getBody() == S) 418220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 419af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek break; 420af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::WhileStmtClass: 421af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek if (cast<WhileStmt>(Parent)->getCond() != S) 422220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 423af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek break; 424af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek default: 425af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek break; 426af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek } 427af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek 428d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek S = Parent; 429d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek } 4301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 431d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek assert(S && "Cannot have null Stmt for PathDiagnosticLocation"); 432e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek 433220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 434d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek} 435d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek 43696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan RosePathDiagnosticLocation 43796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan RosePathDiagnosticBuilder::getEnclosingStmtLocation(const Stmt *S) { 43896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose assert(S && "Null Stmt passed to getEnclosingStmtLocation"); 43996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose return ::getEnclosingStmtLocation(S, getSourceManager(), getParentMap(), LC); 44096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose} 44196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 442cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 443d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose// "Visitors only" path diagnostic generation algorithm. 444d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose//===----------------------------------------------------------------------===// 445d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rosestatic bool GenerateVisitorsOnlyPathDiagnostic(PathDiagnostic &PD, 446d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose PathDiagnosticBuilder &PDB, 447d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose const ExplodedNode *N, 448d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose ArrayRef<BugReporterVisitor *> visitors) { 449d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // All path generation skips the very first node (the error node). 450d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // This is because there is special handling for the end-of-path note. 451d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose N = N->getFirstPred(); 452d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose if (!N) 453d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose return true; 454d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose 455d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose BugReport *R = PDB.getBugReport(); 456d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose while (const ExplodedNode *Pred = N->getFirstPred()) { 457d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose for (ArrayRef<BugReporterVisitor *>::iterator I = visitors.begin(), 458d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose E = visitors.end(); 459d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose I != E; ++I) { 460d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // Visit all the node pairs, but throw the path pieces away. 461d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose PathDiagnosticPiece *Piece = (*I)->VisitNode(N, Pred, PDB, *R); 462d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose delete Piece; 463d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose } 464d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose 465d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose N = Pred; 466d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose } 467d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose 468d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose return R->isValid(); 469d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose} 470d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose 471d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose//===----------------------------------------------------------------------===// 4723106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// "Minimal" path diagnostic generation algorithm. 473cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 47456a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zakstypedef std::pair<PathDiagnosticCallPiece*, const ExplodedNode*> StackDiagPair; 47556a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zakstypedef SmallVector<StackDiagPair, 6> StackDiagVector; 47656a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks 477368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaksstatic void updateStackPiecesWithMessage(PathDiagnosticPiece *P, 47856a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks StackDiagVector &CallStack) { 479368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks // If the piece contains a special message, add it to all the call 480368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks // pieces on the active stack. 481368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks if (PathDiagnosticEventPiece *ep = 482368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks dyn_cast<PathDiagnosticEventPiece>(P)) { 483368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks 48456a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks if (ep->hasCallStackHint()) 48556a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks for (StackDiagVector::iterator I = CallStack.begin(), 48656a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks E = CallStack.end(); I != E; ++I) { 48756a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks PathDiagnosticCallPiece *CP = I->first; 48856a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks const ExplodedNode *N = I->second; 4898fe4525680ce72e90cee3e58b5654e3ae955447fNAKAMURA Takumi std::string stackMsg = ep->getCallStackMessage(N); 49056a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks 491368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks // The last message on the path to final bug is the most important 492368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks // one. Since we traverse the path backwards, do not add the message 493368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks // if one has been previously added. 49456a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks if (!CP->hasCallStackMessage()) 49556a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks CP->setCallStackMessage(stackMsg); 49656a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks } 497368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks } 498368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks} 499cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 50077d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenekstatic void CompactPathDiagnostic(PathPieces &path, const SourceManager& SM); 50114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 5028347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rosestatic bool GenerateMinimalPathDiagnostic(PathDiagnostic& PD, 5033106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PathDiagnosticBuilder &PDB, 5043bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose const ExplodedNode *N, 505d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek LocationContextMap &LCM, 5063bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ArrayRef<BugReporterVisitor *> visitors) { 5078966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek 5083106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek SourceManager& SMgr = PDB.getSourceManager(); 50959950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek const LocationContext *LC = PDB.LC; 5109c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *NextNode = N->pred_empty() 5113106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek ? NULL : *(N->pred_begin()); 512368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks 51356a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks StackDiagVector CallStack; 514368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks 5153106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek while (NextNode) { 5161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump N = NextNode; 51759950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek PDB.LC = N->getLocationContext(); 5180f8579274a010f360a371b53101859d9d6052314Anna Zaks NextNode = N->getFirstPred(); 5191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 52061f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek ProgramPoint P = N->getLocation(); 52180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 52280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks do { 5237a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<CallExitEnd> CE = P.getAs<CallExitEnd>()) { 52480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticCallPiece *C = 52580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticCallPiece::construct(N, *CE, SMgr); 526d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek // Record the mapping from call piece to LocationContext. 527bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 52880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(C); 52980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.pushActivePath(&C->path); 53080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks CallStack.push_back(StackDiagPair(C, N)); 53180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 5329373937945e1e075dfa08169eaccc1ad0b31f699Anna Zaks } 533183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose 5347a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<CallEnter> CE = P.getAs<CallEnter>()) { 53580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Flush all locations, and pop the active path. 53680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks bool VisitedEntireCall = PD.isWithinCall(); 53780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.popActivePath(); 53880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 53980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Either we just added a bunch of stuff to the top-level path, or 54080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // we have a previous CallExitEnd. If the former, it means that the 54180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // path terminated within a function call. We must then take the 54280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // current contents of the active path and place it within 54380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // a new PathDiagnosticCallPiece. 54480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticCallPiece *C; 54580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (VisitedEntireCall) { 54680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks C = cast<PathDiagnosticCallPiece>(PD.getActivePath().front()); 54780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } else { 54880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const Decl *Caller = CE->getLocationContext()->getDecl(); 54980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks C = PathDiagnosticCallPiece::construct(PD.getActivePath(), Caller); 550d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek // Record the mapping from call piece to LocationContext. 551bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 55280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 55380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 55480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks C->setCallee(*CE, SMgr); 55580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (!CallStack.empty()) { 55680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks assert(CallStack.back().first == C); 55780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks CallStack.pop_back(); 55880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 55980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 560368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks } 5611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5627a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<BlockEdge> BE = P.getAs<BlockEdge>()) { 56380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const CFGBlock *Src = BE->getSrc(); 56480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const CFGBlock *Dst = BE->getDst(); 56580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const Stmt *T = Src->getTerminator(); 5661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 56780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (!T) 56880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 5691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 57080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticLocation Start = 57180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticLocation::createBegin(T, SMgr, 57280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks N->getLocationContext()); 5731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 57480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks switch (T->getStmtClass()) { 57561f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek default: 57661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek break; 5771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 57861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek case Stmt::GotoStmtClass: 5791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump case Stmt::IndirectGotoStmtClass: { 5800f8579274a010f360a371b53101859d9d6052314Anna Zaks const Stmt *S = PathDiagnosticLocation::getNextStmt(N); 5811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 58261f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek if (!S) 58380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 5841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 585297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek std::string sbuf; 5861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump llvm::raw_string_ostream os(sbuf); 587d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek const PathDiagnosticLocation &End = PDB.getEnclosingStmtLocation(S); 5881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 58900605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek os << "Control jumps to line " 59080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks << End.asLocation().getExpansionLineNumber(); 59180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 59280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 59361f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek break; 59461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek } 5951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump case Stmt::SwitchStmtClass: { 59761f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek // Figure out what case arm we took. 598297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek std::string sbuf; 599297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek llvm::raw_string_ostream os(sbuf); 6001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6019c378f705405d37f49795d5e915989de774fe11fTed Kremenek if (const Stmt *S = Dst->getLabel()) { 602220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation End(S, SMgr, LC); 6031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6045a429954aedd8a830a70fcea2cb51561673e4fc3Ted Kremenek switch (S->getStmtClass()) { 60580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks default: 60680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << "No cases match in the switch statement. " 60780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks "Control jumps to line " 60880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks << End.asLocation().getExpansionLineNumber(); 60980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 61080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks case Stmt::DefaultStmtClass: 61180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << "Control jumps to the 'default' case at line " 61280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks << End.asLocation().getExpansionLineNumber(); 61380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 61480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 61580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks case Stmt::CaseStmtClass: { 61680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << "Control jumps to 'case "; 61780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const CaseStmt *Case = cast<CaseStmt>(S); 61880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const Expr *LHS = Case->getLHS()->IgnoreParenCasts(); 61980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 62080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Determine if it is an enum. 62180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks bool GetRawInt = true; 62280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 62380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (const DeclRefExpr *DR = dyn_cast<DeclRefExpr>(LHS)) { 62480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // FIXME: Maybe this should be an assertion. Are there cases 62580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // were it is not an EnumConstantDecl? 62680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const EnumConstantDecl *D = 62703509aea098772644bf4662dc1c88634818ceeccZhongxing Xu dyn_cast<EnumConstantDecl>(DR->getDecl()); 6281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 62980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (D) { 63080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks GetRawInt = false; 63180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << *D; 6325a429954aedd8a830a70fcea2cb51561673e4fc3Ted Kremenek } 63380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 6349ec64d6e2fe575b297e1eaa5051efc2983373e25Eli Friedman 63580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (GetRawInt) 63680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << LHS->EvaluateKnownConstInt(PDB.getASTContext()); 6379ec64d6e2fe575b297e1eaa5051efc2983373e25Eli Friedman 63880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << ":' at line " 63980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks << End.asLocation().getExpansionLineNumber(); 64080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 64161f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek } 64280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 64380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 64480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 64561f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek } 646567839273dfc395a459cbe77d5f8d128b9ae85bfTed Kremenek else { 647c3517ebb48a51e146badc08bc3684520c41da6c8Ted Kremenek os << "'Default' branch taken. "; 6481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const PathDiagnosticLocation &End = PDB.ExecutionContinues(os, N); 64980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 65080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 651567839273dfc395a459cbe77d5f8d128b9ae85bfTed Kremenek } 6521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 65361f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek break; 65461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek } 6551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6562673c9ff76ebdb72b7f846e2ff1e0f4256372e19Ted Kremenek case Stmt::BreakStmtClass: 6572673c9ff76ebdb72b7f846e2ff1e0f4256372e19Ted Kremenek case Stmt::ContinueStmtClass: { 658297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek std::string sbuf; 659297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek llvm::raw_string_ostream os(sbuf); 66000605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(os, N); 66180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 66280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 6632673c9ff76ebdb72b7f846e2ff1e0f4256372e19Ted Kremenek break; 6642673c9ff76ebdb72b7f846e2ff1e0f4256372e19Ted Kremenek } 6651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 66680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Determine control-flow for ternary '?'. 66756ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall case Stmt::BinaryConditionalOperatorClass: 668706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek case Stmt::ConditionalOperatorClass: { 669297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek std::string sbuf; 670297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek llvm::raw_string_ostream os(sbuf); 6711d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek os << "'?' condition is "; 6721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 673706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek if (*(Src->succ_begin()+1) == Dst) 674082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek os << "false"; 675706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek else 676082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek os << "true"; 6771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 67800605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 6791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6801d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek if (const Stmt *S = End.asStmt()) 6811d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek End = PDB.getEnclosingStmtLocation(S); 6821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 68380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 68480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 685babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek break; 686babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek } 6871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 68880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Determine control-flow for short-circuited '&&' and '||'. 689babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek case Stmt::BinaryOperatorClass: { 690babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek if (!PDB.supportsLogicalOpControlFlow()) 691babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek break; 6921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 69303509aea098772644bf4662dc1c88634818ceeccZhongxing Xu const BinaryOperator *B = cast<BinaryOperator>(T); 694babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek std::string sbuf; 695babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek llvm::raw_string_ostream os(sbuf); 696babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek os << "Left side of '"; 6971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6982de56d1d0c3a504ad1529de2677628bdfbb95cd4John McCall if (B->getOpcode() == BO_LAnd) { 699f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "&&" << "' is "; 7001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 701f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek if (*(Src->succ_begin()+1) == Dst) { 702f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "false"; 703220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation End(B->getLHS(), SMgr, LC); 7040cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PathDiagnosticLocation Start = 70580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticLocation::createOperatorLoc(B, SMgr); 70680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 70780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 7081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 709f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek else { 710f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "true"; 711220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Start(B->getLHS(), SMgr, LC); 712f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 71380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 71480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 7151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 716babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek } 717babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek else { 7182de56d1d0c3a504ad1529de2677628bdfbb95cd4John McCall assert(B->getOpcode() == BO_LOr); 719f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "||" << "' is "; 7201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 721f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek if (*(Src->succ_begin()+1) == Dst) { 722f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "false"; 723220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Start(B->getLHS(), SMgr, LC); 724f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 72580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 72680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 727f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek } 728f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek else { 729f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "true"; 730220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation End(B->getLHS(), SMgr, LC); 7310cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PathDiagnosticLocation Start = 73280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticLocation::createOperatorLoc(B, SMgr); 73380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 73480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 735f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek } 736babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek } 7371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 738706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek break; 739706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek } 7401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump case Stmt::DoStmtClass: { 742706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek if (*(Src->succ_begin()) == Dst) { 743297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek std::string sbuf; 744297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek llvm::raw_string_ostream os(sbuf); 7451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 746c3517ebb48a51e146badc08bc3684520c41da6c8Ted Kremenek os << "Loop condition is true. "; 747d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(os, N); 7481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 749d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek if (const Stmt *S = End.asStmt()) 750d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek End = PDB.getEnclosingStmtLocation(S); 7511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 75280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 75380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 754082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek } 755082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek else { 75600605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 7571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 758d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek if (const Stmt *S = End.asStmt()) 759d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek End = PDB.getEnclosingStmtLocation(S); 7601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 76180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 76280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, "Loop condition is false. Exiting loop")); 7633106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 7641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7653106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 7663106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 7671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7683106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek case Stmt::WhileStmtClass: 7691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump case Stmt::ForStmtClass: { 7703106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (*(Src->succ_begin()+1) == Dst) { 7713106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek std::string sbuf; 7723106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek llvm::raw_string_ostream os(sbuf); 7731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7743106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek os << "Loop condition is false. "; 7753106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(os, N); 7763106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (const Stmt *S = End.asStmt()) 7773106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek End = PDB.getEnclosingStmtLocation(S); 7781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 77980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 78080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 7813106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 7823106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek else { 7833106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 7843106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (const Stmt *S = End.asStmt()) 7853106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek End = PDB.getEnclosingStmtLocation(S); 7861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 78780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 78880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, "Loop condition is true. Entering loop body")); 7893106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 7901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7913106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 7923106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 7931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7943106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek case Stmt::IfStmtClass: { 7953106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 7961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7973106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (const Stmt *S = End.asStmt()) 7983106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek End = PDB.getEnclosingStmtLocation(S); 7991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8003106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (*(Src->succ_begin()+1) == Dst) 80180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 80280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, "Taking false branch")); 8031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 80480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 80580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, "Taking true branch")); 8061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8073106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 8083106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 80980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 8103106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 81180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } while(0); 8121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 813dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek if (NextNode) { 8148e6431adab313e283a992698f6fc7afe62420999Anna Zaks // Add diagnostic pieces from custom visitors. 8158e6431adab313e283a992698f6fc7afe62420999Anna Zaks BugReport *R = PDB.getBugReport(); 8163bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose for (ArrayRef<BugReporterVisitor *>::iterator I = visitors.begin(), 8173bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose E = visitors.end(); 8183bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose I != E; ++I) { 819368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks if (PathDiagnosticPiece *p = (*I)->VisitNode(N, NextNode, PDB, *R)) { 8202042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek PD.getActivePath().push_front(p); 821368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks updateStackPiecesWithMessage(p, CallStack); 822368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks } 823dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 8248966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 8253106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 8261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8278347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose if (!PDB.getBugReport()->isValid()) 8288347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose return false; 8298347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 83014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // After constructing the full PathDiagnostic, do a pass over it to compact 83114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // PathDiagnosticPieces that occur within a macro. 83277d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek CompactPathDiagnostic(PD.getMutablePieces(), PDB.getSourceManager()); 8338347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose return true; 8343106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 8353106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 8363106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 8375fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek// "Extensive" PathDiagnostic generation. 8385fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek//===----------------------------------------------------------------------===// 8395fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek 8405fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenekstatic bool IsControlFlowExpr(const Stmt *S) { 8415fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek const Expr *E = dyn_cast<Expr>(S); 8421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8435fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek if (!E) 8445fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek return false; 8451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump E = E->IgnoreParenCasts(); 8471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 84856ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall if (isa<AbstractConditionalOperator>(E)) 8495fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek return true; 8501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8515fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek if (const BinaryOperator *B = dyn_cast<BinaryOperator>(E)) 8525fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek if (B->isLogicalOp()) 8535fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek return true; 8541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return false; 8565fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek} 8575fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek 85814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremeneknamespace { 859ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass ContextLocation : public PathDiagnosticLocation { 8608f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek bool IsDead; 8618f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenekpublic: 8628f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek ContextLocation(const PathDiagnosticLocation &L, bool isdead = false) 8638f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek : PathDiagnosticLocation(L), IsDead(isdead) {} 8641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump void markDead() { IsDead = true; } 8668f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek bool isDead() const { return IsDead; } 8678f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek}; 8681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 869e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenekstatic PathDiagnosticLocation cleanUpLocation(PathDiagnosticLocation L, 870e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek const LocationContext *LC, 871e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek bool firstCharOnly = false) { 872e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek if (const Stmt *S = L.asStmt()) { 873e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek const Stmt *Original = S; 874e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek while (1) { 875e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek // Adjust the location for some expressions that are best referenced 876e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek // by one of their subexpressions. 877e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek switch (S->getStmtClass()) { 878e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek default: 879e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek break; 880e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::ParenExprClass: 881e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::GenericSelectionExprClass: 882e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek S = cast<Expr>(S)->IgnoreParens(); 883e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek firstCharOnly = true; 884e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek continue; 885e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::BinaryConditionalOperatorClass: 886e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::ConditionalOperatorClass: 887e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek S = cast<AbstractConditionalOperator>(S)->getCond(); 888e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek firstCharOnly = true; 889e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek continue; 890e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::ChooseExprClass: 891e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek S = cast<ChooseExpr>(S)->getCond(); 892e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek firstCharOnly = true; 893e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek continue; 894e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::BinaryOperatorClass: 895e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek S = cast<BinaryOperator>(S)->getLHS(); 896e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek firstCharOnly = true; 897e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek continue; 898e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek } 899e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek 900e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek break; 901e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek } 902e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek 903e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek if (S != Original) 904e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek L = PathDiagnosticLocation(S, L.getManager(), LC); 905e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek } 906e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek 907e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek if (firstCharOnly) 908e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek L = PathDiagnosticLocation::createSingleLocation(L); 909e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek 910e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek return L; 911e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek} 912e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek 913ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass EdgeBuilder { 9148f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek std::vector<ContextLocation> CLocs; 9158f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek typedef std::vector<ContextLocation>::iterator iterator; 91614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PathDiagnostic &PD; 91714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PathDiagnosticBuilder &PDB; 91814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PathDiagnosticLocation PrevLoc; 9191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9208f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek bool IsConsumedExpr(const PathDiagnosticLocation &L); 9211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 92214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek bool containsLocation(const PathDiagnosticLocation &Container, 92314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek const PathDiagnosticLocation &Containee); 9241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 92514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PathDiagnosticLocation getContextLocation(const PathDiagnosticLocation &L); 9261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 92914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek void popLocation() { 9308f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek if (!CLocs.back().isDead() && CLocs.back().asLocation().isFileID()) { 9315c7168cbe8a0eabd05e0e12e469090d2cabd27c0Ted Kremenek // For contexts, we only one the first character as the range. 932e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek rawAddEdge(cleanUpLocation(CLocs.back(), PDB.LC, true)); 9335c7168cbe8a0eabd05e0e12e469090d2cabd27c0Ted Kremenek } 93414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek CLocs.pop_back(); 93514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 9361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 93714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenekpublic: 93814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek EdgeBuilder(PathDiagnostic &pd, PathDiagnosticBuilder &pdb) 93914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek : PD(pd), PDB(pdb) { 9401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 941a301a6773db085575ac51e3c966858180390c25bTed Kremenek // If the PathDiagnostic already has pieces, add the enclosing statement 942a301a6773db085575ac51e3c966858180390c25bTed Kremenek // of the first piece as a context as well. 943802e02463b880f53a6e645bde78cc412481ce9e0Ted Kremenek if (!PD.path.empty()) { 944ed866e73bab7733f5226f84c52edefe23d694b2fTed Kremenek PrevLoc = (*PD.path.begin())->getLocation(); 9451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 94614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (const Stmt *S = PrevLoc.asStmt()) 947e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek addExtendedContext(PDB.getEnclosingStmtLocation(S).asStmt()); 94814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 94914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 95014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 95114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek ~EdgeBuilder() { 95214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek while (!CLocs.empty()) popLocation(); 9530cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks 954a301a6773db085575ac51e3c966858180390c25bTed Kremenek // Finally, add an initial edge from the start location of the first 955a301a6773db085575ac51e3c966858180390c25bTed Kremenek // statement (if it doesn't already exist). 9560cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PathDiagnosticLocation L = PathDiagnosticLocation::createDeclBegin( 95759950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek PDB.LC, 9580cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PDB.getSourceManager()); 9590cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks if (L.isValid()) 9600cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks rawAddEdge(L); 96114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 96214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 9635de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek void flushLocations() { 9645de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek while (!CLocs.empty()) 9655de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek popLocation(); 9665de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek PrevLoc = PathDiagnosticLocation(); 9675de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek } 9685de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek 9693ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose void addEdge(PathDiagnosticLocation NewLoc, bool alwaysAdd = false, 9703ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose bool IsPostJump = false); 9711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9728bd4d037d837e7922c3661d6158229da58a03887Ted Kremenek void rawAddEdge(PathDiagnosticLocation NewLoc); 9731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 97414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek void addContext(const Stmt *S); 975183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose void addContext(const PathDiagnosticLocation &L); 976e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek void addExtendedContext(const Stmt *S); 9771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump}; 97814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} // end anonymous namespace 97914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 98014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 98114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted KremenekPathDiagnosticLocation 98214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted KremenekEdgeBuilder::getContextLocation(const PathDiagnosticLocation &L) { 98314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (const Stmt *S = L.asStmt()) { 98414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (IsControlFlowExpr(S)) 98514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return L; 9861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return PDB.getEnclosingStmtLocation(S); 98814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 9891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 99014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return L; 99114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 99214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 99314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenekbool EdgeBuilder::containsLocation(const PathDiagnosticLocation &Container, 99414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek const PathDiagnosticLocation &Containee) { 99514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 99614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (Container == Containee) 99714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return true; 9981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 99914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (Container.asDecl()) 100014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return true; 10011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 100214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (const Stmt *S = Containee.asStmt()) 100314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (const Stmt *ContainerS = Container.asStmt()) { 100414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek while (S) { 100514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (S == ContainerS) 100614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return true; 100714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek S = PDB.getParent(S); 100814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 100914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return false; 101014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 101114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 101214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // Less accurate: compare using source ranges. 101314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek SourceRange ContainerR = Container.asRange(); 101414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek SourceRange ContaineeR = Containee.asRange(); 10151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 101614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek SourceManager &SM = PDB.getSourceManager(); 1017402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SourceLocation ContainerRBeg = SM.getExpansionLoc(ContainerR.getBegin()); 1018402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SourceLocation ContainerREnd = SM.getExpansionLoc(ContainerR.getEnd()); 1019402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SourceLocation ContaineeRBeg = SM.getExpansionLoc(ContaineeR.getBegin()); 1020402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SourceLocation ContaineeREnd = SM.getExpansionLoc(ContaineeR.getEnd()); 10211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1022642116259e8df6286063a17361c20e95b5017a0aChandler Carruth unsigned ContainerBegLine = SM.getExpansionLineNumber(ContainerRBeg); 1023642116259e8df6286063a17361c20e95b5017a0aChandler Carruth unsigned ContainerEndLine = SM.getExpansionLineNumber(ContainerREnd); 1024642116259e8df6286063a17361c20e95b5017a0aChandler Carruth unsigned ContaineeBegLine = SM.getExpansionLineNumber(ContaineeRBeg); 1025642116259e8df6286063a17361c20e95b5017a0aChandler Carruth unsigned ContaineeEndLine = SM.getExpansionLineNumber(ContaineeREnd); 10261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 102714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek assert(ContainerBegLine <= ContainerEndLine); 10281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert(ContaineeBegLine <= ContaineeEndLine); 10291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 103014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return (ContainerBegLine <= ContaineeBegLine && 103114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek ContainerEndLine >= ContaineeEndLine && 103214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek (ContainerBegLine != ContaineeBegLine || 1033a77c031cb66f75d22672070052cc6e0205289ff8Chandler Carruth SM.getExpansionColumnNumber(ContainerRBeg) <= 1034a77c031cb66f75d22672070052cc6e0205289ff8Chandler Carruth SM.getExpansionColumnNumber(ContaineeRBeg)) && 103514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek (ContainerEndLine != ContaineeEndLine || 1036a77c031cb66f75d22672070052cc6e0205289ff8Chandler Carruth SM.getExpansionColumnNumber(ContainerREnd) >= 10376488dc31153be6f98b404c7860be6c66bb4ec917Ted Kremenek SM.getExpansionColumnNumber(ContaineeREnd))); 103814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 103914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 104014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenekvoid EdgeBuilder::rawAddEdge(PathDiagnosticLocation NewLoc) { 104114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (!PrevLoc.isValid()) { 104214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PrevLoc = NewLoc; 104314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 104414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 10451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1046e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek const PathDiagnosticLocation &NewLocClean = cleanUpLocation(NewLoc, PDB.LC); 1047e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek const PathDiagnosticLocation &PrevLocClean = cleanUpLocation(PrevLoc, PDB.LC); 10481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1049a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek if (PrevLocClean.asLocation().isInvalid()) { 1050a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek PrevLoc = NewLoc; 1051a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek return; 1052a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek } 1053a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek 10548c8b0ad9601d6ccf3d7b2a3f77a896ef4fb4e6e9Ted Kremenek if (NewLocClean.asLocation() == PrevLocClean.asLocation()) 105514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 10561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 105714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // FIXME: Ignore intra-macro edges for now. 1058402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth if (NewLocClean.asLocation().getExpansionLoc() == 1059402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth PrevLocClean.asLocation().getExpansionLoc()) 106014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 106114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 10622042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece(NewLocClean, PrevLocClean)); 10638c8b0ad9601d6ccf3d7b2a3f77a896ef4fb4e6e9Ted Kremenek PrevLoc = NewLoc; 106414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 106514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 10663ea09a802f973c2726b2a489ae08a4bded93410bJordan Rosevoid EdgeBuilder::addEdge(PathDiagnosticLocation NewLoc, bool alwaysAdd, 10673ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose bool IsPostJump) { 10681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1069a301a6773db085575ac51e3c966858180390c25bTed Kremenek if (!alwaysAdd && NewLoc.asLocation().isMacroID()) 1070a301a6773db085575ac51e3c966858180390c25bTed Kremenek return; 10711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 107214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek const PathDiagnosticLocation &CLoc = getContextLocation(NewLoc); 107314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 107414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek while (!CLocs.empty()) { 10758f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek ContextLocation &TopContextLoc = CLocs.back(); 10761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 107714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // Is the top location context the same as the one for the new location? 107814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (TopContextLoc == CLoc) { 10798f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek if (alwaysAdd) { 10803ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose if (IsConsumedExpr(TopContextLoc)) 10813ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose TopContextLoc.markDead(); 10828f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek 108314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek rawAddEdge(NewLoc); 10848f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek } 108514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 10863ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose if (IsPostJump) 10873ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose TopContextLoc.markDead(); 108814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 108914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 109014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 109114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (containsLocation(TopContextLoc, CLoc)) { 10928f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek if (alwaysAdd) { 109314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek rawAddEdge(NewLoc); 10941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10953ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose if (IsConsumedExpr(CLoc)) { 10963ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose CLocs.push_back(ContextLocation(CLoc, /*IsDead=*/true)); 10978f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek return; 10988f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek } 10998f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek } 11001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11013ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose CLocs.push_back(ContextLocation(CLoc, /*IsDead=*/IsPostJump)); 11021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return; 110314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 110414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 110514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // Context does not contain the location. Flush it. 110614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek popLocation(); 110714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 11081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11095c7168cbe8a0eabd05e0e12e469090d2cabd27c0Ted Kremenek // If we reach here, there is no enclosing context. Just add the edge. 11105c7168cbe8a0eabd05e0e12e469090d2cabd27c0Ted Kremenek rawAddEdge(NewLoc); 111114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 111214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 11138f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenekbool EdgeBuilder::IsConsumedExpr(const PathDiagnosticLocation &L) { 11148f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek if (const Expr *X = dyn_cast_or_null<Expr>(L.asStmt())) 11158f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek return PDB.getParentMap().isConsumedExpr(X) && !IsControlFlowExpr(X); 11161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11178f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek return false; 11188f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek} 11191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1120e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenekvoid EdgeBuilder::addExtendedContext(const Stmt *S) { 1121e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek if (!S) 1122e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek return; 11231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const Stmt *Parent = PDB.getParent(S); 1125e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek while (Parent) { 1126e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek if (isa<CompoundStmt>(Parent)) 1127e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek Parent = PDB.getParent(Parent); 1128e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek else 1129e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek break; 1130e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek } 1131e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek 1132e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek if (Parent) { 1133e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek switch (Parent->getStmtClass()) { 1134e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek case Stmt::DoStmtClass: 1135e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek case Stmt::ObjCAtSynchronizedStmtClass: 1136e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek addContext(Parent); 1137e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek default: 1138e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek break; 1139e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek } 1140e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek } 11411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1142e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek addContext(S); 1143e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek} 11441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 114514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenekvoid EdgeBuilder::addContext(const Stmt *S) { 114614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (!S) 114714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 114814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 114959950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek PathDiagnosticLocation L(S, PDB.getSourceManager(), PDB.LC); 1150183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose addContext(L); 1151183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose} 11521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1153183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rosevoid EdgeBuilder::addContext(const PathDiagnosticLocation &L) { 115414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek while (!CLocs.empty()) { 115514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek const PathDiagnosticLocation &TopContextLoc = CLocs.back(); 115614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 115714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // Is the top location context the same as the one for the new location? 115814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (TopContextLoc == L) 115914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 116014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 116114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (containsLocation(TopContextLoc, L)) { 116214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek CLocs.push_back(L); 11631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return; 116414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 116514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 116614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // Context does not contain the location. Flush it. 116714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek popLocation(); 116814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 116914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 117014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek CLocs.push_back(L); 117114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 117214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 117311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// Cone-of-influence: support the reverse propagation of "interesting" symbols 117411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// and values by tracing interesting calculations backwards through evaluated 117511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// expressions along a path. This is probably overly complicated, but the idea 117611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// is that if an expression computed an "interesting" value, the child 117711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// expressions are are also likely to be "interesting" as well (which then 117811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// propagates to the values they in turn compute). This reverse propagation 117911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// is needed to track interesting correlations across function call boundaries, 118011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// where formal arguments bind to actual arguments, etc. This is also needed 118111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// because the constraint solver sometimes simplifies certain symbolic values 118211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// into constants when appropriate, and this complicates reasoning about 118311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// interesting values. 118411abcecc8c919673237cf37384290a1ef1943976Ted Kremenektypedef llvm::DenseSet<const Expr *> InterestingExprs; 118511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek 118611abcecc8c919673237cf37384290a1ef1943976Ted Kremenekstatic void reversePropagateIntererstingSymbols(BugReport &R, 118711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek InterestingExprs &IE, 118811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const ProgramState *State, 118911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const Expr *Ex, 119011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const LocationContext *LCtx) { 119111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek SVal V = State->getSVal(Ex, LCtx); 119211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (!(R.isInteresting(V) || IE.count(Ex))) 119311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek return; 119411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek 119511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek switch (Ex->getStmtClass()) { 119611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek default: 119711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (!isa<CastExpr>(Ex)) 119811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek break; 119911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek // Fall through. 120011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek case Stmt::BinaryOperatorClass: 120111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek case Stmt::UnaryOperatorClass: { 120211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek for (Stmt::const_child_iterator CI = Ex->child_begin(), 120311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek CE = Ex->child_end(); 120411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek CI != CE; ++CI) { 120511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (const Expr *child = dyn_cast_or_null<Expr>(*CI)) { 120611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek IE.insert(child); 120711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek SVal ChildV = State->getSVal(child, LCtx); 120811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek R.markInteresting(ChildV); 120911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 121011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek break; 121111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 121211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 121311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 121411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek 121511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek R.markInteresting(V); 121611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek} 121711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek 121811abcecc8c919673237cf37384290a1ef1943976Ted Kremenekstatic void reversePropagateInterestingSymbols(BugReport &R, 121911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek InterestingExprs &IE, 122011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const ProgramState *State, 122111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const LocationContext *CalleeCtx, 122211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const LocationContext *CallerCtx) 122311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek{ 1224852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // FIXME: Handle non-CallExpr-based CallEvents. 122511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const StackFrameContext *Callee = CalleeCtx->getCurrentStackFrame(); 122611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const Stmt *CallSite = Callee->getCallSite(); 1227852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (const CallExpr *CE = dyn_cast_or_null<CallExpr>(CallSite)) { 122811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(CalleeCtx->getDecl())) { 122911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek FunctionDecl::param_const_iterator PI = FD->param_begin(), 123011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek PE = FD->param_end(); 123111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek CallExpr::const_arg_iterator AI = CE->arg_begin(), AE = CE->arg_end(); 123211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek for (; AI != AE && PI != PE; ++AI, ++PI) { 123311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (const Expr *ArgE = *AI) { 123411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (const ParmVarDecl *PD = *PI) { 123511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek Loc LV = State->getLValue(PD, CalleeCtx); 123611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (R.isInteresting(LV) || R.isInteresting(State->getRawSVal(LV))) 123711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek IE.insert(ArgE); 123811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 123911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 124011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 124111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 124211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 124311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek} 12448185674528423e2504a1fae35c28c24104846510Ted Kremenek 1245b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek//===----------------------------------------------------------------------===// 1246b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek// Functions for determining if a loop was executed 0 times. 1247b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek//===----------------------------------------------------------------------===// 1248b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 1249b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenekstatic bool isLoop(const Stmt *Term) { 12508185674528423e2504a1fae35c28c24104846510Ted Kremenek switch (Term->getStmtClass()) { 12518185674528423e2504a1fae35c28c24104846510Ted Kremenek case Stmt::ForStmtClass: 12528185674528423e2504a1fae35c28c24104846510Ted Kremenek case Stmt::WhileStmtClass: 1253c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek case Stmt::ObjCForCollectionStmtClass: 1254b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek return true; 12558185674528423e2504a1fae35c28c24104846510Ted Kremenek default: 12568185674528423e2504a1fae35c28c24104846510Ted Kremenek // Note that we intentionally do not include do..while here. 12578185674528423e2504a1fae35c28c24104846510Ted Kremenek return false; 12588185674528423e2504a1fae35c28c24104846510Ted Kremenek } 1259b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek} 12608185674528423e2504a1fae35c28c24104846510Ted Kremenek 1261b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenekstatic bool isJumpToFalseBranch(const BlockEdge *BE) { 12628185674528423e2504a1fae35c28c24104846510Ted Kremenek const CFGBlock *Src = BE->getSrc(); 12638185674528423e2504a1fae35c28c24104846510Ted Kremenek assert(Src->succ_size() == 2); 12648185674528423e2504a1fae35c28c24104846510Ted Kremenek return (*(Src->succ_begin()+1) == BE->getDst()); 12658185674528423e2504a1fae35c28c24104846510Ted Kremenek} 12668185674528423e2504a1fae35c28c24104846510Ted Kremenek 1267b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek/// Return true if the terminator is a loop and the destination is the 1268b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek/// false branch. 1269b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenekstatic bool isLoopJumpPastBody(const Stmt *Term, const BlockEdge *BE) { 1270b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek if (!isLoop(Term)) 1271b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek return false; 1272b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1273b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek // Did we take the false branch? 1274b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek return isJumpToFalseBranch(BE); 1275b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek} 1276b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1277b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenekstatic bool isContainedByStmt(ParentMap &PM, const Stmt *S, const Stmt *SubS) { 1278b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek while (SubS) { 1279b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek if (SubS == S) 1280b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return true; 1281b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek SubS = PM.getParent(SubS); 1282b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek } 1283b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return false; 1284b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek} 1285b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 1286b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenekstatic const Stmt *getStmtBeforeCond(ParentMap &PM, const Stmt *Term, 1287b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek const ExplodedNode *N) { 1288b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek while (N) { 1289b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek Optional<StmtPoint> SP = N->getLocation().getAs<StmtPoint>(); 1290b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek if (SP) { 1291b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek const Stmt *S = SP->getStmt(); 1292b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek if (!isContainedByStmt(PM, Term, S)) 1293b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return S; 1294b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek } 12950f8579274a010f360a371b53101859d9d6052314Anna Zaks N = N->getFirstPred(); 1296b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek } 1297b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return 0; 1298b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek} 1299b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 1300b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenekstatic bool isInLoopBody(ParentMap &PM, const Stmt *S, const Stmt *Term) { 1301b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek const Stmt *LoopBody = 0; 1302b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek switch (Term->getStmtClass()) { 1303b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek case Stmt::ForStmtClass: { 1304b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek const ForStmt *FS = cast<ForStmt>(Term); 1305b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek if (isContainedByStmt(PM, FS->getInc(), S)) 1306b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return true; 1307b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek LoopBody = FS->getBody(); 1308b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek break; 1309b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek } 1310c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek case Stmt::ObjCForCollectionStmtClass: { 1311c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek const ObjCForCollectionStmt *FC = cast<ObjCForCollectionStmt>(Term); 1312c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek LoopBody = FC->getBody(); 1313c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek break; 1314c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek } 1315b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek case Stmt::WhileStmtClass: 1316b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek LoopBody = cast<WhileStmt>(Term)->getBody(); 1317b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek break; 1318b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek default: 1319b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return false; 1320b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek } 1321b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return isContainedByStmt(PM, LoopBody, S); 1322b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek} 1323b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 1324b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek//===----------------------------------------------------------------------===// 1325b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek// Top-level logic for generating extensive path diagnostics. 1326b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek//===----------------------------------------------------------------------===// 1327b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 13288347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rosestatic bool GenerateExtensivePathDiagnostic(PathDiagnostic& PD, 132914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PathDiagnosticBuilder &PDB, 13303bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose const ExplodedNode *N, 1331d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek LocationContextMap &LCM, 13323bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ArrayRef<BugReporterVisitor *> visitors) { 133314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek EdgeBuilder EB(PD, PDB); 13340cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks const SourceManager& SM = PDB.getSourceManager(); 133556a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks StackDiagVector CallStack; 133611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek InterestingExprs IE; 133714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 13389c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *NextNode = N->pred_empty() ? NULL : *(N->pred_begin()); 133914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek while (NextNode) { 134014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek N = NextNode; 13410f8579274a010f360a371b53101859d9d6052314Anna Zaks NextNode = N->getFirstPred(); 134214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek ProgramPoint P = N->getLocation(); 134314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 1344dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek do { 13457a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<PostStmt> PS = P.getAs<PostStmt>()) { 134611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (const Expr *Ex = PS->getStmtAs<Expr>()) 134711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek reversePropagateIntererstingSymbols(*PDB.getBugReport(), IE, 134811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek N->getState().getPtr(), Ex, 134911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek N->getLocationContext()); 135011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 135111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek 13527a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<CallExitEnd> CE = P.getAs<CallExitEnd>()) { 1353183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose const Stmt *S = CE->getCalleeContext()->getCallSite(); 1354183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose if (const Expr *Ex = dyn_cast_or_null<Expr>(S)) { 1355852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose reversePropagateIntererstingSymbols(*PDB.getBugReport(), IE, 1356852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose N->getState().getPtr(), Ex, 1357852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose N->getLocationContext()); 1358852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose } 1359183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose 1360183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose PathDiagnosticCallPiece *C = 1361183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose PathDiagnosticCallPiece::construct(N, *CE, SM); 1362bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 1363183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose 13643ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose EB.addEdge(C->callReturn, /*AlwaysAdd=*/true, /*IsPostJump=*/true); 1365183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose EB.flushLocations(); 1366183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose 1367183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose PD.getActivePath().push_front(C); 1368183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose PD.pushActivePath(&C->path); 1369183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose CallStack.push_back(StackDiagPair(C, N)); 13705de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek break; 13715de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek } 13724ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek 13732042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek // Pop the call hierarchy if we are done walking the contents 13742042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek // of a function call. 13757a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<CallEnter> CE = P.getAs<CallEnter>()) { 1376097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek // Add an edge to the start of the function. 1377097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek const Decl *D = CE->getCalleeContext()->getDecl(); 1378097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek PathDiagnosticLocation pos = 1379097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek PathDiagnosticLocation::createBegin(D, SM); 1380097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek EB.addEdge(pos); 1381097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek 1382097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek // Flush all locations, and pop the active path. 1383183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose bool VisitedEntireCall = PD.isWithinCall(); 13844ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek EB.flushLocations(); 13852042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek PD.popActivePath(); 13864ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek PDB.LC = N->getLocationContext(); 1387097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek 1388183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose // Either we just added a bunch of stuff to the top-level path, or 1389183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose // we have a previous CallExitEnd. If the former, it means that the 13902042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek // path terminated within a function call. We must then take the 13912042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek // current contents of the active path and place it within 13922042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek // a new PathDiagnosticCallPiece. 1393183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose PathDiagnosticCallPiece *C; 1394183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose if (VisitedEntireCall) { 1395183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose C = cast<PathDiagnosticCallPiece>(PD.getActivePath().front()); 1396183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose } else { 1397183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose const Decl *Caller = CE->getLocationContext()->getDecl(); 13989373937945e1e075dfa08169eaccc1ad0b31f699Anna Zaks C = PathDiagnosticCallPiece::construct(PD.getActivePath(), Caller); 1399bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 14009373937945e1e075dfa08169eaccc1ad0b31f699Anna Zaks } 1401852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose 1402183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose C->setCallee(*CE, SM); 1403183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose EB.addContext(C->getLocation()); 1404368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks 1405368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks if (!CallStack.empty()) { 140656a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks assert(CallStack.back().first == C); 1407368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks CallStack.pop_back(); 1408368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks } 14092042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek break; 14102042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek } 14114ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek 14124ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek // Note that is important that we update the LocationContext 14134ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek // after looking at CallExits. CallExit basically adds an 14144ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek // edge in the *caller*, so we don't want to update the LocationContext 14154ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek // too soon. 14164ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek PDB.LC = N->getLocationContext(); 14175de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek 1418dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek // Block edges. 14197a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<BlockEdge> BE = P.getAs<BlockEdge>()) { 142011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek // Does this represent entering a call? If so, look at propagating 142111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek // interesting symbols across call boundaries. 142211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (NextNode) { 142311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const LocationContext *CallerCtx = NextNode->getLocationContext(); 142411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const LocationContext *CalleeCtx = PDB.LC; 142511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (CallerCtx != CalleeCtx) { 142611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek reversePropagateInterestingSymbols(*PDB.getBugReport(), IE, 142711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek N->getState().getPtr(), 142811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek CalleeCtx, CallerCtx); 142911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 143011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 143111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek 1432dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek // Are we jumping to the head of a loop? Add a special diagnostic. 1433f57a2aa02c0578c5bd834fec0d44c16ad9908620Ted Kremenek if (const Stmt *Loop = BE->getSrc()->getLoopTarget()) { 143459950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek PathDiagnosticLocation L(Loop, SM, PDB.LC); 1435ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek const CompoundStmt *CS = NULL; 14361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1437f57a2aa02c0578c5bd834fec0d44c16ad9908620Ted Kremenek if (const ForStmt *FS = dyn_cast<ForStmt>(Loop)) 1438f57a2aa02c0578c5bd834fec0d44c16ad9908620Ted Kremenek CS = dyn_cast<CompoundStmt>(FS->getBody()); 1439f57a2aa02c0578c5bd834fec0d44c16ad9908620Ted Kremenek else if (const WhileStmt *WS = dyn_cast<WhileStmt>(Loop)) 1440f57a2aa02c0578c5bd834fec0d44c16ad9908620Ted Kremenek CS = dyn_cast<CompoundStmt>(WS->getBody()); 14411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1442dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek PathDiagnosticEventPiece *p = 1443dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek new PathDiagnosticEventPiece(L, 144407c015cbcee31f72e2d320ba2c713c046bed42faTed Kremenek "Looping back to the head of the loop"); 14452dd17abf11ae64339fa6bfaa57d76e13a5fbe5b8Ted Kremenek p->setPrunable(true); 14461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1447dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek EB.addEdge(p->getLocation(), true); 14482042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek PD.getActivePath().push_front(p); 14491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1450ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek if (CS) { 14510cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PathDiagnosticLocation BL = 14520cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PathDiagnosticLocation::createEndBrace(CS, SM); 145307c015cbcee31f72e2d320ba2c713c046bed42faTed Kremenek EB.addEdge(BL); 1454dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 14558bd4d037d837e7922c3661d6158229da58a03887Ted Kremenek } 14568185674528423e2504a1fae35c28c24104846510Ted Kremenek 1457b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek const CFGBlock *BSrc = BE->getSrc(); 1458b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek ParentMap &PM = PDB.getParentMap(); 1459b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 1460b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek if (const Stmt *Term = BSrc->getTerminator()) { 14618185674528423e2504a1fae35c28c24104846510Ted Kremenek // Are we jumping past the loop body without ever executing the 14628185674528423e2504a1fae35c28c24104846510Ted Kremenek // loop (because the condition was false)? 14637a95de68c093991047ed8d339479ccad51b88663David Blaikie if (isLoopJumpPastBody(Term, &*BE) && 1464b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek !isInLoopBody(PM, 1465b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek getStmtBeforeCond(PM, 1466b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek BSrc->getTerminatorCondition(), 1467b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek N), 1468b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek Term)) { 14698185674528423e2504a1fae35c28c24104846510Ted Kremenek PathDiagnosticLocation L(Term, SM, PDB.LC); 14708185674528423e2504a1fae35c28c24104846510Ted Kremenek PathDiagnosticEventPiece *PE = 1471b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek new PathDiagnosticEventPiece(L, "Loop body executed 0 times"); 14728185674528423e2504a1fae35c28c24104846510Ted Kremenek PE->setPrunable(true); 14738185674528423e2504a1fae35c28c24104846510Ted Kremenek 14748185674528423e2504a1fae35c28c24104846510Ted Kremenek EB.addEdge(PE->getLocation(), true); 14758185674528423e2504a1fae35c28c24104846510Ted Kremenek PD.getActivePath().push_front(PE); 14768185674528423e2504a1fae35c28c24104846510Ted Kremenek } 14778185674528423e2504a1fae35c28c24104846510Ted Kremenek 1478b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek // In any case, add the terminator as the current statement 1479b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek // context for control edges. 1480ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek EB.addContext(Term); 14818185674528423e2504a1fae35c28c24104846510Ted Kremenek } 14821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1483dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek break; 14848bd4d037d837e7922c3661d6158229da58a03887Ted Kremenek } 148514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 14867a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<BlockEntrance> BE = P.getAs<BlockEntrance>()) { 1487b07805485c603be3d8011f72611465324c9e664bDavid Blaikie Optional<CFGElement> First = BE->getFirstElement(); 1488b07805485c603be3d8011f72611465324c9e664bDavid Blaikie if (Optional<CFGStmt> S = First ? First->getAs<CFGStmt>() : None) { 1489b07805485c603be3d8011f72611465324c9e664bDavid Blaikie const Stmt *stmt = S->getStmt(); 14903c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek if (IsControlFlowExpr(stmt)) { 1491b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu // Add the proper context for '&&', '||', and '?'. 14923c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek EB.addContext(stmt); 1493b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu } 1494b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu else 14953c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek EB.addExtendedContext(PDB.getEnclosingStmtLocation(stmt).asStmt()); 1496dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 1497b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu 1498dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek break; 1499dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 15005de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek 15015de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek 1502dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } while (0); 15031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1504dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek if (!NextNode) 150514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek continue; 15061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15078e6431adab313e283a992698f6fc7afe62420999Anna Zaks // Add pieces from custom visitors. 15088e6431adab313e283a992698f6fc7afe62420999Anna Zaks BugReport *R = PDB.getBugReport(); 15093bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose for (ArrayRef<BugReporterVisitor *>::iterator I = visitors.begin(), 15103bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose E = visitors.end(); 15113bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose I != E; ++I) { 15128e6431adab313e283a992698f6fc7afe62420999Anna Zaks if (PathDiagnosticPiece *p = (*I)->VisitNode(N, NextNode, PDB, *R)) { 15138966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek const PathDiagnosticLocation &Loc = p->getLocation(); 15148966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek EB.addEdge(Loc, true); 15152042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek PD.getActivePath().push_front(p); 1516368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks updateStackPiecesWithMessage(p, CallStack); 1517368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks 15188966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek if (const Stmt *S = Loc.asStmt()) 15191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump EB.addExtendedContext(PDB.getEnclosingStmtLocation(S).asStmt()); 15208966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 15211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 152214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 15238347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 15248347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose return PDB.getBugReport()->isValid(); 152514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 152614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 1527af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek/// \brief Adds a sanitized control-flow diagnostic edge to a path. 1528af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenekstatic void addEdgeToPath(PathPieces &path, 1529af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticLocation &PrevLoc, 1530af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticLocation NewLoc, 1531af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const LocationContext *LC) { 1532bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (!NewLoc.isValid()) 1533af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek return; 1534af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1535bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek SourceLocation NewLocL = NewLoc.asLocation(); 1536bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (NewLocL.isInvalid() || NewLocL.isMacroID()) 1537af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek return; 1538af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1539904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose if (!PrevLoc.isValid() || !PrevLoc.asLocation().isValid()) { 1540af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PrevLoc = NewLoc; 1541af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek return; 1542af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1543af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1544af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // FIXME: ignore intra-macro edges for now. 1545bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (NewLoc.asLocation().getExpansionLoc() == 1546bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek PrevLoc.asLocation().getExpansionLoc()) 1547af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek return; 1548af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1549bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek path.push_front(new PathDiagnosticControlFlowPiece(NewLoc, 1550bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek PrevLoc)); 1551af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PrevLoc = NewLoc; 1552af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek} 1553af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1554e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek/// A customized wrapper for CFGBlock::getTerminatorCondition() 1555e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek/// which returns the element for ObjCForCollectionStmts. 1556e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenekstatic const Stmt *getTerminatorCondition(const CFGBlock *B) { 1557e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek const Stmt *S = B->getTerminatorCondition(); 1558e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek if (const ObjCForCollectionStmt *FS = 1559e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek dyn_cast_or_null<ObjCForCollectionStmt>(S)) 1560e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek return FS->getElement(); 1561e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek return S; 1562e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek} 1563e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek 1564f94cb007d03031bcf3d1b02f6a683a189e934953Ted Kremenekstatic const char *StrEnteringLoop = "Entering loop body"; 1565f94cb007d03031bcf3d1b02f6a683a189e934953Ted Kremenekstatic const char *StrLoopBodyZero = "Loop body executed 0 times"; 1566f94cb007d03031bcf3d1b02f6a683a189e934953Ted Kremenek 1567af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenekstatic bool 1568af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted KremenekGenerateAlternateExtensivePathDiagnostic(PathDiagnostic& PD, 1569af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticBuilder &PDB, 1570af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const ExplodedNode *N, 1571af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek LocationContextMap &LCM, 1572af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek ArrayRef<BugReporterVisitor *> visitors) { 1573af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1574af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek BugReport *report = PDB.getBugReport(); 1575af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const SourceManager& SM = PDB.getSourceManager(); 1576af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek StackDiagVector CallStack; 1577af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek InterestingExprs IE; 1578af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 15795a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose PathDiagnosticLocation PrevLoc = PD.getLocation(); 1580af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1581af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const ExplodedNode *NextNode = N->getFirstPred(); 1582af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek while (NextNode) { 1583af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek N = NextNode; 1584af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek NextNode = N->getFirstPred(); 1585af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek ProgramPoint P = N->getLocation(); 1586af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1587af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek do { 1588be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Have we encountered an entrance to a call? It may be 1589be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // the case that we have not encountered a matching 1590be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // call exit before this point. This means that the path 1591be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // terminated within the call itself. 1592be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek if (Optional<CallEnter> CE = P.getAs<CallEnter>()) { 1593904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose // Add an edge to the start of the function. 1594904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose const StackFrameContext *CalleeLC = CE->getCalleeContext(); 1595904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose const Decl *D = CalleeLC->getDecl(); 1596904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose addEdgeToPath(PD.getActivePath(), PrevLoc, 1597904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose PathDiagnosticLocation::createBegin(D, SM), 1598904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose CalleeLC); 1599904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose 1600be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Did we visit an entire call? 1601be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek bool VisitedEntireCall = PD.isWithinCall(); 1602be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PD.popActivePath(); 1603be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1604be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PathDiagnosticCallPiece *C; 1605be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek if (VisitedEntireCall) { 1606be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PathDiagnosticPiece *P = PD.getActivePath().front().getPtr(); 1607be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek C = cast<PathDiagnosticCallPiece>(P); 1608be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek } else { 1609be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek const Decl *Caller = CE->getLocationContext()->getDecl(); 1610be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek C = PathDiagnosticCallPiece::construct(PD.getActivePath(), Caller); 1611be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1612be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Since we just transferred the path over to the call piece, 1613be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // reset the mapping from active to location context. 1614be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek assert(PD.getActivePath().size() == 1 && 1615be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PD.getActivePath().front() == C); 1616be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek LCM[&PD.getActivePath()] = 0; 1617be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1618be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Record the location context mapping for the path within 1619be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // the call. 1620be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek assert(LCM[&C->path] == 0 || 1621be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek LCM[&C->path] == CE->getCalleeContext()); 1622be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 1623be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1624be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // If this is the first item in the active path, record 1625be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // the new mapping from active path to location context. 1626be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek const LocationContext *&NewLC = LCM[&PD.getActivePath()]; 16275a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose if (!NewLC) 1628be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek NewLC = N->getLocationContext(); 1629be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 16305a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose PDB.LC = NewLC; 1631be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek } 1632be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek C->setCallee(*CE, SM); 1633be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 16345a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose // Update the previous location in the active path. 16355a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose PrevLoc = C->getLocation(); 16365a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose 1637be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek if (!CallStack.empty()) { 1638be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek assert(CallStack.back().first == C); 1639be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek CallStack.pop_back(); 1640be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek } 1641af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek break; 1642af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1643af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1644be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Query the location context here and the previous location 1645be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // as processing CallEnter may change the active path. 1646be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PDB.LC = N->getLocationContext(); 1647be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1648be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Record the mapping from the active path to the location 1649be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // context. 1650be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek assert(!LCM[&PD.getActivePath()] || 1651be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek LCM[&PD.getActivePath()] == PDB.LC); 1652be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek LCM[&PD.getActivePath()] = PDB.LC; 1653be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1654af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Have we encountered an exit from a function call? 1655af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (Optional<CallExitEnd> CE = P.getAs<CallExitEnd>()) { 1656af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const Stmt *S = CE->getCalleeContext()->getCallSite(); 1657af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Propagate the interesting symbols accordingly. 1658af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (const Expr *Ex = dyn_cast_or_null<Expr>(S)) { 1659af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek reversePropagateIntererstingSymbols(*PDB.getBugReport(), IE, 1660af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek N->getState().getPtr(), Ex, 1661af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek N->getLocationContext()); 1662af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1663af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1664af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // We are descending into a call (backwards). Construct 1665af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // a new call piece to contain the path pieces for that call. 1666af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticCallPiece *C = 1667af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticCallPiece::construct(N, *CE, SM); 1668af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1669af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Record the location context for this call piece. 1670bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 1671af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1672af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Add the edge to the return site. 1673be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, C->callReturn, PDB.LC); 1674be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PD.getActivePath().push_front(C); 16755a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose PrevLoc.invalidate(); 1676af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1677af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Make the contents of the call the active path for now. 1678af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PD.pushActivePath(&C->path); 1679af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek CallStack.push_back(StackDiagPair(C, N)); 1680af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek break; 1681af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1682af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1683be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek if (Optional<PostStmt> PS = P.getAs<PostStmt>()) { 1684be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // For expressions, make sure we propagate the 1685be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // interesting symbols correctly. 1686be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek if (const Expr *Ex = PS->getStmtAs<Expr>()) 1687be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek reversePropagateIntererstingSymbols(*PDB.getBugReport(), IE, 1688be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek N->getState().getPtr(), Ex, 1689be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek N->getLocationContext()); 1690af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1691e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // Add an edge. If this is an ObjCForCollectionStmt do 1692e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // not add an edge here as it appears in the CFG both 1693e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // as a terminator and as a terminator condition. 1694e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek if (!isa<ObjCForCollectionStmt>(PS->getStmt())) { 1695e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek PathDiagnosticLocation L = 1696e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek PathDiagnosticLocation(PS->getStmt(), SM, PDB.LC); 1697e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, L, PDB.LC); 1698e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek } 1699af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek break; 1700af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1701af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1702af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Block edges. 1703af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (Optional<BlockEdge> BE = P.getAs<BlockEdge>()) { 1704af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Does this represent entering a call? If so, look at propagating 1705af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // interesting symbols across call boundaries. 1706af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (NextNode) { 1707af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const LocationContext *CallerCtx = NextNode->getLocationContext(); 1708af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const LocationContext *CalleeCtx = PDB.LC; 1709af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (CallerCtx != CalleeCtx) { 1710af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek reversePropagateInterestingSymbols(*PDB.getBugReport(), IE, 1711af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek N->getState().getPtr(), 1712af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek CalleeCtx, CallerCtx); 1713af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1714af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1715af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1716af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Are we jumping to the head of a loop? Add a special diagnostic. 1717af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (const Stmt *Loop = BE->getSrc()->getLoopTarget()) { 1718af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticLocation L(Loop, SM, PDB.LC); 1719afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek const CompoundStmt *CS = NULL; 1720afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek 1721afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek if (const ForStmt *FS = dyn_cast<ForStmt>(Loop)) 1722afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek CS = dyn_cast<CompoundStmt>(FS->getBody()); 1723afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek else if (const WhileStmt *WS = dyn_cast<WhileStmt>(Loop)) 1724afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek CS = dyn_cast<CompoundStmt>(WS->getBody()); 1725e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek else if (const ObjCForCollectionStmt *OFS = 1726e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek dyn_cast<ObjCForCollectionStmt>(Loop)) { 1727e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek CS = dyn_cast<CompoundStmt>(OFS->getBody()); 1728e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek } 1729af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1730af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticEventPiece *p = 1731af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek new PathDiagnosticEventPiece(L, "Looping back to the head " 1732af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek "of the loop"); 1733af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek p->setPrunable(true); 1734af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1735be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, p->getLocation(), PDB.LC); 1736cd389d8cc9abeffb1416b70dd58148e66e5d822bTed Kremenek PD.getActivePath().push_front(p); 1737afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek 1738afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek if (CS) { 1739afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, 1740afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek PathDiagnosticLocation::createEndBrace(CS, SM), 1741afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek PDB.LC); 1742afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek } 1743af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1744b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1745af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const CFGBlock *BSrc = BE->getSrc(); 1746af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek ParentMap &PM = PDB.getParentMap(); 1747af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1748af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (const Stmt *Term = BSrc->getTerminator()) { 1749af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Are we jumping past the loop body without ever executing the 1750af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // loop (because the condition was false)? 1751b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek if (isLoop(Term)) { 1752e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek const Stmt *TermCond = getTerminatorCondition(BSrc); 1753b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek bool IsInLoopBody = 1754b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek isInLoopBody(PM, getStmtBeforeCond(PM, TermCond, N), Term); 1755b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1756b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek const char *str = 0; 1757b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1758b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek if (isJumpToFalseBranch(&*BE)) { 1759b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek if (!IsInLoopBody) { 1760f94cb007d03031bcf3d1b02f6a683a189e934953Ted Kremenek str = StrLoopBodyZero; 1761b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek } 1762b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek } 1763b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek else { 1764f94cb007d03031bcf3d1b02f6a683a189e934953Ted Kremenek str = StrEnteringLoop; 1765b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek } 1766b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1767b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek if (str) { 17683e8a85fcfc3d264e4c5b21fbdd741bbc0c24a266Jordan Rose PathDiagnosticLocation L(TermCond ? TermCond : Term, SM, PDB.LC); 1769b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek PathDiagnosticEventPiece *PE = 1770b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek new PathDiagnosticEventPiece(L, str); 1771b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek PE->setPrunable(true); 1772b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, 1773be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PE->getLocation(), PDB.LC); 1774b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek PD.getActivePath().push_front(PE); 1775b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek } 1776af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1777bc0fd8129626ff4e485388311b081e76d0f96795Ted Kremenek else if (isa<BreakStmt>(Term) || isa<ContinueStmt>(Term) || 1778bc0fd8129626ff4e485388311b081e76d0f96795Ted Kremenek isa<GotoStmt>(Term)) { 1779bc0fd8129626ff4e485388311b081e76d0f96795Ted Kremenek PathDiagnosticLocation L(Term, SM, PDB.LC); 1780be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, L, PDB.LC); 1781bc0fd8129626ff4e485388311b081e76d0f96795Ted Kremenek } 1782af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1783af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek break; 1784af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1785af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } while (0); 1786af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1787af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (!NextNode) 1788af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek continue; 1789af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1790af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Add pieces from custom visitors. 1791af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek for (ArrayRef<BugReporterVisitor *>::iterator I = visitors.begin(), 1792af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek E = visitors.end(); 1793af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek I != E; ++I) { 1794cd389d8cc9abeffb1416b70dd58148e66e5d822bTed Kremenek if (PathDiagnosticPiece *p = (*I)->VisitNode(N, NextNode, PDB, *report)) { 1795be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, p->getLocation(), PDB.LC); 1796cd389d8cc9abeffb1416b70dd58148e66e5d822bTed Kremenek PD.getActivePath().push_front(p); 1797af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek updateStackPiecesWithMessage(p, CallStack); 1798af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1799af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1800af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1801af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 180201f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose // Add an edge to the start of the function. 180301f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose // We'll prune it out later, but it helps make diagnostics more uniform. 180401f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose const StackFrameContext *CalleeLC = PDB.LC->getCurrentStackFrame(); 180501f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose const Decl *D = CalleeLC->getDecl(); 180601f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose addEdgeToPath(PD.getActivePath(), PrevLoc, 180701f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose PathDiagnosticLocation::createBegin(D, SM), 180801f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose CalleeLC); 180901f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose 1810af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek return report->isValid(); 1811af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek} 1812af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1813b1a4d37c0549501fe12907bc6ffa81bc5d04b98aBenjamin Kramerstatic const Stmt *getLocStmt(PathDiagnosticLocation L) { 1814bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (!L.isValid()) 1815bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek return 0; 1816f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek return L.asStmt(); 1817f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek} 1818f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek 181996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rosestatic const Stmt *getStmtParent(const Stmt *S, const ParentMap &PM) { 1820bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (!S) 1821bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek return 0; 1822a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek 1823a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek while (true) { 1824a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek S = PM.getParentIgnoreParens(S); 1825a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek 1826a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek if (!S) 1827a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek break; 1828a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek 1829a327bb12b1cd0c142eb06e30b4f6018b96d5babfTed Kremenek if (isa<ExprWithCleanups>(S) || 1830a327bb12b1cd0c142eb06e30b4f6018b96d5babfTed Kremenek isa<CXXBindTemporaryExpr>(S) || 1831a327bb12b1cd0c142eb06e30b4f6018b96d5babfTed Kremenek isa<SubstNonTypeTemplateParmExpr>(S)) 1832a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek continue; 1833a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek 1834a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek break; 1835a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek } 1836a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek 1837a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek return S; 1838bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek} 1839bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 184015676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenekstatic bool isConditionForTerminator(const Stmt *S, const Stmt *Cond) { 184115676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek switch (S->getStmtClass()) { 184203194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek case Stmt::BinaryOperatorClass: { 184303194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek const BinaryOperator *BO = cast<BinaryOperator>(S); 184403194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek if (!BO->isLogicalOp()) 184503194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek return false; 184603194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek return BO->getLHS() == Cond || BO->getRHS() == Cond; 184703194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek } 1848a399f776ee29e099da33eaf7f9d585b4edc4b61dTed Kremenek case Stmt::IfStmtClass: 1849a399f776ee29e099da33eaf7f9d585b4edc4b61dTed Kremenek return cast<IfStmt>(S)->getCond() == Cond; 185015676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::ForStmtClass: 185115676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<ForStmt>(S)->getCond() == Cond; 185215676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::WhileStmtClass: 185315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<WhileStmt>(S)->getCond() == Cond; 185415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::DoStmtClass: 185515676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<DoStmt>(S)->getCond() == Cond; 185615676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::ChooseExprClass: 185715676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<ChooseExpr>(S)->getCond() == Cond; 185815676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::IndirectGotoStmtClass: 185915676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<IndirectGotoStmt>(S)->getTarget() == Cond; 186015676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::SwitchStmtClass: 186115676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<SwitchStmt>(S)->getCond() == Cond; 186215676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::BinaryConditionalOperatorClass: 186315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<BinaryConditionalOperator>(S)->getCond() == Cond; 18648484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek case Stmt::ConditionalOperatorClass: { 18658484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek const ConditionalOperator *CO = cast<ConditionalOperator>(S); 18668484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek return CO->getCond() == Cond || 18678484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek CO->getLHS() == Cond || 18688484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek CO->getRHS() == Cond; 18698484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek } 187015676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::ObjCForCollectionStmtClass: 187115676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<ObjCForCollectionStmt>(S)->getElement() == Cond; 187215676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek default: 187315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return false; 187415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek } 187515676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek} 187615676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek 187796b8134337883908fcc45484486fe200d6b3e32fTed Kremenekstatic bool isIncrementOrInitInForLoop(const Stmt *S, const Stmt *FL) { 1878e2f7337958f21802e98777f441fe20ef7ba2adffTed Kremenek const ForStmt *FS = dyn_cast<ForStmt>(FL); 187996b8134337883908fcc45484486fe200d6b3e32fTed Kremenek if (!FS) 1880e2f7337958f21802e98777f441fe20ef7ba2adffTed Kremenek return false; 188196b8134337883908fcc45484486fe200d6b3e32fTed Kremenek return FS->getInc() == S || FS->getInit() == S; 1882e2f7337958f21802e98777f441fe20ef7ba2adffTed Kremenek} 1883e2f7337958f21802e98777f441fe20ef7ba2adffTed Kremenek 188415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenektypedef llvm::DenseSet<const PathDiagnosticCallPiece *> 188515676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek OptimizedCallsSet; 188615676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek 1887d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rosevoid PathPieces::dump() const { 1888d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose unsigned index = 0; 1889d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose for (PathPieces::const_iterator I = begin(), E = end(); I != E; ++I ) { 1890d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << "[" << index++ << "]"; 1891d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose 1892d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose switch ((*I)->getKind()) { 1893d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose case PathDiagnosticPiece::Call: 1894d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << " CALL\n--------------\n"; 1895d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose 1896d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose if (const Stmt *SLoc = getLocStmt((*I)->getLocation())) { 1897d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose SLoc->dump(); 1898d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose } else { 1899d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose const PathDiagnosticCallPiece *Call = cast<PathDiagnosticCallPiece>(*I); 1900d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose if (const NamedDecl *ND = dyn_cast<NamedDecl>(Call->getCallee())) 1901d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << *ND << "\n"; 1902d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose } 1903d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose break; 1904d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose case PathDiagnosticPiece::Event: 1905d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << " EVENT\n--------------\n"; 1906d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << (*I)->getString() << "\n"; 1907d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose if (const Stmt *SLoc = getLocStmt((*I)->getLocation())) { 1908d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << " ---- at ----\n"; 1909d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose SLoc->dump(); 1910d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose } 1911d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose break; 1912d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose case PathDiagnosticPiece::Macro: 1913d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << " MACRO\n--------------\n"; 1914d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose // FIXME: print which macro is being invoked. 1915d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose break; 1916d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose case PathDiagnosticPiece::ControlFlow: { 1917d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose const PathDiagnosticControlFlowPiece *CP = 1918d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose cast<PathDiagnosticControlFlowPiece>(*I); 1919d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << " CONTROL\n--------------\n"; 1920d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose 1921d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose if (const Stmt *s1Start = getLocStmt(CP->getStartLocation())) 1922d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose s1Start->dump(); 1923d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose else 1924d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << "NULL\n"; 1925d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose 1926d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << " ---- to ----\n"; 1927d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose 1928d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose if (const Stmt *s1End = getLocStmt(CP->getEndLocation())) 1929d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose s1End->dump(); 1930d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose else 1931d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << "NULL\n"; 1932d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose 1933d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose break; 1934d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose } 1935d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose } 1936d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose 1937d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << "\n"; 1938d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose } 1939d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose} 1940d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose 194196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// Adds synthetic edges from top-level statements to their subexpressions. 194296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// 194396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// This avoids a "swoosh" effect, where an edge from a top-level statement A 194496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// points to a sub-expression B.1 that's not at the start of B. In these cases, 194596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// we'd like to see an edge from A to B, then another one from B to B.1. 194696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rosestatic void addContextEdges(PathPieces &pieces, SourceManager &SM, 194796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const ParentMap &PM, const LocationContext *LCtx) { 194896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathPieces::iterator Prev = pieces.end(); 194996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose for (PathPieces::iterator I = pieces.begin(), E = Prev; I != E; 195096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose Prev = I, ++I) { 195196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathDiagnosticControlFlowPiece *Piece = 195296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose dyn_cast<PathDiagnosticControlFlowPiece>(*I); 195396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 195496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!Piece) 195596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 195696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 195796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathDiagnosticLocation SrcLoc = Piece->getStartLocation(); 195896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const Stmt *Src = getLocStmt(SrcLoc); 195996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathDiagnosticLocation SrcContext = 196096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose getEnclosingStmtLocation(Src, SM, PM, LCtx); 196196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 196296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Repeatedly split the edge as necessary. 196396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // This is important for nested logical expressions (||, &&, ?:) where we 196496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // want to show all the levels of context. 196596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose while (true) { 196696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const Stmt *Dst = getLocStmt(Piece->getEndLocation()); 196796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 196896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // We are looking at an edge. Is the destination within a larger 196996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // expression? 197096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathDiagnosticLocation DstContext = 197196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose getEnclosingStmtLocation(Dst, SM, PM, LCtx); 197296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!DstContext.isValid() || DstContext.asStmt() == Dst) 197396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 197496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 197596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // If the source is in the same context, we're already good. 197696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (SrcContext == DstContext) 197796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 197896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 197996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Update the subexpression node to point to the context edge. 198096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose Piece->setStartLocation(DstContext); 198196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 198296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Try to extend the previous edge if it's at the same level as the source 198396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // context. 198496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (Prev != E) { 198596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathDiagnosticControlFlowPiece *PrevPiece = 198696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose dyn_cast<PathDiagnosticControlFlowPiece>(*Prev); 198796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 198896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (PrevPiece) { 198996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (const Stmt *PrevSrc = getLocStmt(PrevPiece->getStartLocation())) { 199096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const Stmt *PrevSrcParent = getStmtParent(PrevSrc, PM); 199196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (PrevSrcParent == getStmtParent(getLocStmt(DstContext), PM)) { 199296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PrevPiece->setEndLocation(DstContext); 199396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 199496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 199596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 199696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 199796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 199896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 199996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Otherwise, split the current edge into a context edge and a 200096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // subexpression edge. Note that the context statement may itself have 200196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // context. 200296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose Piece = new PathDiagnosticControlFlowPiece(SrcLoc, DstContext); 200396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose I = pieces.insert(I, Piece); 200496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 200596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 200696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose} 200796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 200896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// \brief Move edges from a branch condition to a branch target 200996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// when the condition is simple. 201096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// 201196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// This restructures some of the work of addContextEdges. That function 201296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// creates edges this may destroy, but they work together to create a more 201396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// aesthetically set of edges around branches. After the call to 201496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// addContextEdges, we may have (1) an edge to the branch, (2) an edge from 201596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// the branch to the branch condition, and (3) an edge from the branch 201696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// condition to the branch target. We keep (1), but may wish to remove (2) 201796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// and move the source of (3) to the branch if the branch condition is simple. 201896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// 201996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rosestatic void simplifySimpleBranches(PathPieces &pieces) { 202096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose for (PathPieces::iterator I = pieces.begin(), E = pieces.end(); I != E; ++I) { 202196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 202296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathDiagnosticControlFlowPiece *PieceI = 202396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose dyn_cast<PathDiagnosticControlFlowPiece>(*I); 202496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 202596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!PieceI) 202696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 202796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 202896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const Stmt *s1Start = getLocStmt(PieceI->getStartLocation()); 202996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const Stmt *s1End = getLocStmt(PieceI->getEndLocation()); 203096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 203196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!s1Start || !s1End) 203296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 203396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 203496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathPieces::iterator NextI = I; ++NextI; 203596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (NextI == E) 203696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 203796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 203896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathDiagnosticControlFlowPiece *PieceNextI = 0; 203996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 204096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose while (true) { 204196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (NextI == E) 204296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 204396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 204496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathDiagnosticEventPiece *EV = dyn_cast<PathDiagnosticEventPiece>(*NextI); 204596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (EV) { 204696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose StringRef S = EV->getString(); 204796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (S == StrEnteringLoop || S == StrLoopBodyZero) { 204896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose ++NextI; 204996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 205096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 205196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 205296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 205396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 205496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PieceNextI = dyn_cast<PathDiagnosticControlFlowPiece>(*NextI); 205596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 205696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 205796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 205896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!PieceNextI) 205996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 206096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 206196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const Stmt *s2Start = getLocStmt(PieceNextI->getStartLocation()); 206296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const Stmt *s2End = getLocStmt(PieceNextI->getEndLocation()); 206396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 206496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!s2Start || !s2End || s1End != s2Start) 206596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 206696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 206796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // We only perform this transformation for specific branch kinds. 206896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // We don't want to do this for do..while, for example. 206996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!(isa<ForStmt>(s1Start) || isa<WhileStmt>(s1Start) || 207096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose isa<IfStmt>(s1Start) || isa<ObjCForCollectionStmt>(s1Start))) 207196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 207296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 207396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Is s1End the branch condition? 207496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!isConditionForTerminator(s1Start, s1End)) 207596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 207696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 207796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Perform the hoisting by eliminating (2) and changing the start 207896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // location of (3). 207996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PieceNextI->setStartLocation(PieceI->getStartLocation()); 208096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose I = pieces.erase(I); 208196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 208296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose} 208396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 208452f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek/// \brief Return true if X is contained by Y. 208552f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenekstatic bool lexicalContains(ParentMap &PM, 208652f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek const Stmt *X, 208752f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek const Stmt *Y) { 208852f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek while (X) { 208952f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek if (X == Y) 209052f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek return true; 209152f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek X = PM.getParent(X); 209252f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek } 209352f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek return false; 209452f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek} 209552f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek 2096de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek// Remove short edges on the same line less than 3 columns in difference. 2097de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenekstatic void removePunyEdges(PathPieces &path, 2098de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek SourceManager &SM, 2099de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek ParentMap &PM) { 2100de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2101de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek bool erased = false; 2102de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2103de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek for (PathPieces::iterator I = path.begin(), E = path.end(); I != E; 2104de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek erased ? I : ++I) { 2105de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2106de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek erased = false; 2107de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2108de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek PathDiagnosticControlFlowPiece *PieceI = 2109de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek dyn_cast<PathDiagnosticControlFlowPiece>(*I); 2110de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2111de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (!PieceI) 2112de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2113de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2114de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek const Stmt *start = getLocStmt(PieceI->getStartLocation()); 2115de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek const Stmt *end = getLocStmt(PieceI->getEndLocation()); 2116de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2117de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (!start || !end) 2118de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2119de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2120de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek const Stmt *endParent = PM.getParent(end); 2121de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (!endParent) 2122de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2123de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2124de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (isConditionForTerminator(end, endParent)) 2125de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2126de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2127de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek bool Invalid = false; 2128de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek FullSourceLoc StartL(start->getLocStart(), SM); 2129de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek FullSourceLoc EndL(end->getLocStart(), SM); 2130de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2131de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek unsigned startLine = StartL.getSpellingLineNumber(&Invalid); 2132de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (Invalid) 2133de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2134de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2135de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek unsigned endLine = EndL.getSpellingLineNumber(&Invalid); 2136de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (Invalid) 2137de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2138de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2139de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (startLine != endLine) 2140de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2141de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2142de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek unsigned startCol = StartL.getSpellingColumnNumber(&Invalid); 2143de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (Invalid) 2144de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2145de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2146de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek unsigned endCol = EndL.getSpellingColumnNumber(&Invalid); 2147de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (Invalid) 2148de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2149de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 215034bd3331b5ed34cc9027ee00e1aaabfecff8f742Pete Cooper if (abs((int)startCol - (int)endCol) <= 2) { 2151a705980a7c3315b7c72d99ce675342ad91b50642Ted Kremenek I = path.erase(I); 2152de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek erased = true; 2153de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2154de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek } 2155de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek } 2156de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek} 2157de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 21581d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenekstatic void removeIdenticalEvents(PathPieces &path) { 21591d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek for (PathPieces::iterator I = path.begin(), E = path.end(); I != E; ++I) { 21601d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek PathDiagnosticEventPiece *PieceI = 21611d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek dyn_cast<PathDiagnosticEventPiece>(*I); 21621d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 21631d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek if (!PieceI) 21641d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek continue; 21651d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 21661d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek PathPieces::iterator NextI = I; ++NextI; 21671d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek if (NextI == E) 21681d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek return; 21691d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 21701d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek PathDiagnosticEventPiece *PieceNextI = 21710fa3504acfc7c20a87973c58ad3474adc94dd97dTed Kremenek dyn_cast<PathDiagnosticEventPiece>(*NextI); 21721d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 21731d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek if (!PieceNextI) 21741d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek continue; 21751d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 21761d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek // Erase the second piece if it has the same exact message text. 21771d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek if (PieceI->getString() == PieceNextI->getString()) { 21781d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek path.erase(NextI); 21791d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek } 21801d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek } 21811d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek} 21821d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 218315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenekstatic bool optimizeEdges(PathPieces &path, SourceManager &SM, 218415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek OptimizedCallsSet &OCS, 2185bb518991ce4298d8662235fc8cb13813f011c18dJordan Rose LocationContextMap &LCM) { 2186bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek bool hasChanges = false; 2187bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek const LocationContext *LC = LCM[&path]; 2188bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek assert(LC); 2189de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek ParentMap &PM = LC->getParentMap(); 2190bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2191481da5554d03271b0d87b695449963f7728c5895Ted Kremenek for (PathPieces::iterator I = path.begin(), E = path.end(); I != E; ) { 2192bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // Optimize subpaths. 2193bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (PathDiagnosticCallPiece *CallI = dyn_cast<PathDiagnosticCallPiece>(*I)){ 2194481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // Record the fact that a call has been optimized so we only do the 2195481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // effort once. 219615676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek if (!OCS.count(CallI)) { 2197bb518991ce4298d8662235fc8cb13813f011c18dJordan Rose while (optimizeEdges(CallI->path, SM, OCS, LCM)) {} 219815676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek OCS.insert(CallI); 219915676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek } 2200481da5554d03271b0d87b695449963f7728c5895Ted Kremenek ++I; 2201bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek continue; 2202bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek } 2203bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2204bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // Pattern match the current piece and its successor. 2205bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek PathDiagnosticControlFlowPiece *PieceI = 2206bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek dyn_cast<PathDiagnosticControlFlowPiece>(*I); 2207bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2208481da5554d03271b0d87b695449963f7728c5895Ted Kremenek if (!PieceI) { 2209481da5554d03271b0d87b695449963f7728c5895Ted Kremenek ++I; 2210bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek continue; 2211481da5554d03271b0d87b695449963f7728c5895Ted Kremenek } 2212bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2213f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *s1Start = getLocStmt(PieceI->getStartLocation()); 2214f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *s1End = getLocStmt(PieceI->getEndLocation()); 2215f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *level1 = getStmtParent(s1Start, PM); 2216f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *level2 = getStmtParent(s1End, PM); 2217f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek 221815676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek PathPieces::iterator NextI = I; ++NextI; 221915676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek if (NextI == E) 222015676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek break; 222115676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek 2222bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek PathDiagnosticControlFlowPiece *PieceNextI = 2223bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek dyn_cast<PathDiagnosticControlFlowPiece>(*NextI); 2224bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2225481da5554d03271b0d87b695449963f7728c5895Ted Kremenek if (!PieceNextI) { 2226481da5554d03271b0d87b695449963f7728c5895Ted Kremenek ++I; 2227bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek continue; 2228481da5554d03271b0d87b695449963f7728c5895Ted Kremenek } 2229bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2230f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *s2Start = getLocStmt(PieceNextI->getStartLocation()); 2231f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *s2End = getLocStmt(PieceNextI->getEndLocation()); 2232f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *level3 = getStmtParent(s2Start, PM); 2233f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *level4 = getStmtParent(s2End, PM); 2234bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2235bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // Rule I. 2236bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // 2237bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // If we have two consecutive control edges whose end/begin locations 2238481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // are at the same level (e.g. statements or top-level expressions within 2239481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // a compound statement, or siblings share a single ancestor expression), 2240481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // then merge them if they have no interesting intermediate event. 2241bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // 2242bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // For example: 2243bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // 2244bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // (1.1 -> 1.2) -> (1.2 -> 1.3) becomes (1.1 -> 1.3) because the common 2245481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // parent is '1'. Here 'x.y.z' represents the hierarchy of statements. 2246bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // 2247bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // NOTE: this will be limited later in cases where we add barriers 2248bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // to prevent this optimization. 2249f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // 2250481da5554d03271b0d87b695449963f7728c5895Ted Kremenek if (level1 && level1 == level2 && level1 == level3 && level1 == level4) { 2251bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek PieceI->setEndLocation(PieceNextI->getEndLocation()); 2252bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek path.erase(NextI); 2253bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek hasChanges = true; 2254bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek continue; 2255bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek } 2256b9e13d555fc9f3e5515e2b1fa6f720e6f10bb076Ted Kremenek 2257b9e13d555fc9f3e5515e2b1fa6f720e6f10bb076Ted Kremenek // Rule II. 2258b9e13d555fc9f3e5515e2b1fa6f720e6f10bb076Ted Kremenek // 2259a399f776ee29e099da33eaf7f9d585b4edc4b61dTed Kremenek // Eliminate edges between subexpressions and parent expressions 2260a399f776ee29e099da33eaf7f9d585b4edc4b61dTed Kremenek // when the subexpression is consumed. 2261f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // 2262f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // NOTE: this will be limited later in cases where we add barriers 2263f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // to prevent this optimization. 2264f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // 226596b8134337883908fcc45484486fe200d6b3e32fTed Kremenek if (s1End && s1End == s2Start && level2) { 226652f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek bool removeEdge = false; 226752f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // Remove edges into the increment or initialization of a 226852f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // loop that have no interleaving event. This means that 226952f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // they aren't interesting. 227052f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek if (isIncrementOrInitInForLoop(s1End, level2)) 227152f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek removeEdge = true; 227252f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // Next only consider edges that are not anchored on 227352f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // the condition of a terminator. This are intermediate edges 227452f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // that we might want to trim. 227552f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek else if (!isConditionForTerminator(level2, s1End)) { 227652f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // Trim edges on expressions that are consumed by 227752f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // the parent expression. 227852f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek if (isa<Expr>(s1End) && PM.isConsumedExpr(cast<Expr>(s1End))) { 227952f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek removeEdge = true; 228052f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek } 228152f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // Trim edges where a lexical containment doesn't exist. 228252f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // For example: 228352f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // 228452f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // X -> Y -> Z 228552f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // 228652f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // If 'Z' lexically contains Y (it is an ancestor) and 228752f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // 'X' does not lexically contain Y (it is a descendant OR 228852f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // it has no lexical relationship at all) then trim. 228952f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // 229052f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // This can eliminate edges where we dive into a subexpression 229152f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // and then pop back out, etc. 229252f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek else if (s1Start && s2End && 229352f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek lexicalContains(PM, s2Start, s2End) && 229452f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek !lexicalContains(PM, s1End, s1Start)) { 229552f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek removeEdge = true; 229652f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek } 229752f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek } 229852f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek 229952f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek if (removeEdge) { 230096b8134337883908fcc45484486fe200d6b3e32fTed Kremenek PieceI->setEndLocation(PieceNextI->getEndLocation()); 230196b8134337883908fcc45484486fe200d6b3e32fTed Kremenek path.erase(NextI); 230296b8134337883908fcc45484486fe200d6b3e32fTed Kremenek hasChanges = true; 230396b8134337883908fcc45484486fe200d6b3e32fTed Kremenek continue; 230496b8134337883908fcc45484486fe200d6b3e32fTed Kremenek } 2305f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek } 2306481da5554d03271b0d87b695449963f7728c5895Ted Kremenek 2307e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // Optimize edges for ObjC fast-enumeration loops. 2308e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // 2309e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // (X -> collection) -> (collection -> element) 2310e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // 2311e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // becomes: 2312e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // 2313e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // (X -> element) 2314e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek if (s1End == s2Start) { 2315e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek const ObjCForCollectionStmt *FS = 2316e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek dyn_cast_or_null<ObjCForCollectionStmt>(level3); 2317e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek if (FS && FS->getCollection()->IgnoreParens() == s2Start && 2318e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek s2End == FS->getElement()) { 2319e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek PieceI->setEndLocation(PieceNextI->getEndLocation()); 2320e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek path.erase(NextI); 2321e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek hasChanges = true; 2322e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek continue; 2323e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek } 2324e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek } 2325e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek 2326481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // No changes at this index? Move to the next one. 2327481da5554d03271b0d87b695449963f7728c5895Ted Kremenek ++I; 2328bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek } 2329bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2330de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (!hasChanges) { 233196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Adjust edges into subexpressions to make them more uniform 233296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // and aesthetically pleasing. 233396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose addContextEdges(path, SM, PM, LC); 233496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Hoist edges originating from branch conditions to branches 233596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // for simple branches. 233696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose simplifySimpleBranches(path); 2337de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek // Remove any puny edges left over after primary optimization pass. 2338de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek removePunyEdges(path, SM, PM); 23391d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek // Remove identical events. 23401d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek removeIdenticalEvents(path); 2341de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek } 2342de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2343bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek return hasChanges; 2344bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek} 2345bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 234601f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose/// Drop the very first edge in a path, which should be a function entry edge. 234701f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rosestatic void dropFunctionEntryEdge(PathPieces &Path, 234801f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose LocationContextMap &LCM, 234901f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose SourceManager &SM) { 235001f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose#ifndef NDEBUG 235101f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose const Decl *D = LCM[&Path]->getDecl(); 235201f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose PathDiagnosticLocation EntryLoc = 235301f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose PathDiagnosticLocation::createBegin(D, SM); 235401f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose const PathDiagnosticControlFlowPiece *FirstEdge = 235501f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose cast<PathDiagnosticControlFlowPiece>(Path.front()); 235601f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose assert(FirstEdge->getStartLocation() == EntryLoc && "not an entry edge"); 235701f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose#endif 235801f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose 235901f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose Path.pop_front(); 236001f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose} 236101f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose 236201f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose 23635fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek//===----------------------------------------------------------------------===// 23643106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// Methods for BugType and subclasses. 23653106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 2366404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios KyrtzidisBugType::~BugType() { } 2367404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 23683106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenekvoid BugType::FlushReports(BugReporter &BR) {} 23693106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 237099ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikievoid BuiltinBug::anchor() {} 237199ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie 23723106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 23733106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// Methods for BugReport and subclasses. 23743106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 2375e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 237699ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikievoid BugReport::NodeResolver::anchor() {} 237799ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie 23788e6431adab313e283a992698f6fc7afe62420999Anna Zaksvoid BugReport::addVisitor(BugReporterVisitor* visitor) { 23798e6431adab313e283a992698f6fc7afe62420999Anna Zaks if (!visitor) 23808e6431adab313e283a992698f6fc7afe62420999Anna Zaks return; 23818e6431adab313e283a992698f6fc7afe62420999Anna Zaks 23828e6431adab313e283a992698f6fc7afe62420999Anna Zaks llvm::FoldingSetNodeID ID; 23838e6431adab313e283a992698f6fc7afe62420999Anna Zaks visitor->Profile(ID); 23848e6431adab313e283a992698f6fc7afe62420999Anna Zaks void *InsertPos; 23858e6431adab313e283a992698f6fc7afe62420999Anna Zaks 23868e6431adab313e283a992698f6fc7afe62420999Anna Zaks if (CallbacksSet.FindNodeOrInsertPos(ID, InsertPos)) { 23878e6431adab313e283a992698f6fc7afe62420999Anna Zaks delete visitor; 23888e6431adab313e283a992698f6fc7afe62420999Anna Zaks return; 23898e6431adab313e283a992698f6fc7afe62420999Anna Zaks } 23908e6431adab313e283a992698f6fc7afe62420999Anna Zaks 23918e6431adab313e283a992698f6fc7afe62420999Anna Zaks CallbacksSet.InsertNode(visitor, InsertPos); 23923bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose Callbacks.push_back(visitor); 23933bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ++ConfigurationChangeToken; 23948e6431adab313e283a992698f6fc7afe62420999Anna Zaks} 23958e6431adab313e283a992698f6fc7afe62420999Anna Zaks 23968e6431adab313e283a992698f6fc7afe62420999Anna ZaksBugReport::~BugReport() { 23978e6431adab313e283a992698f6fc7afe62420999Anna Zaks for (visitor_iterator I = visitor_begin(), E = visitor_end(); I != E; ++I) { 2398dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks delete *I; 23998e6431adab313e283a992698f6fc7afe62420999Anna Zaks } 2400c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek while (!interestingSymbols.empty()) { 2401c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek popInterestingSymbolsAndRegions(); 2402c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek } 24038e6431adab313e283a992698f6fc7afe62420999Anna Zaks} 2404e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 240507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenekconst Decl *BugReport::getDeclWithIssue() const { 240607189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek if (DeclWithIssue) 240707189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek return DeclWithIssue; 240807189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek 240907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek const ExplodedNode *N = getErrorNode(); 241007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek if (!N) 241107189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek return 0; 241207189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek 241307189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek const LocationContext *LC = N->getLocationContext(); 241407189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek return LC->getCurrentStackFrame()->getDecl(); 241507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek} 241607189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek 2417e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaksvoid BugReport::Profile(llvm::FoldingSetNodeID& hash) const { 2418e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks hash.AddPointer(&BT); 2419e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks hash.AddString(Description); 242097bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks PathDiagnosticLocation UL = getUniqueingLocation(); 242197bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks if (UL.isValid()) { 242297bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks UL.Profile(hash); 2423ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks } else if (Location.isValid()) { 2424590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks Location.Profile(hash); 2425590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks } else { 2426590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks assert(ErrorNode); 2427590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks hash.AddPointer(GetCurrentOrPreviousStmt(ErrorNode)); 2428590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks } 2429e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 2430e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks for (SmallVectorImpl<SourceRange>::const_iterator I = 2431e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks Ranges.begin(), E = Ranges.end(); I != E; ++I) { 2432e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks const SourceRange range = *I; 2433e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks if (!range.isValid()) 2434e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks continue; 2435e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks hash.AddInteger(range.getBegin().getRawEncoding()); 2436e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks hash.AddInteger(range.getEnd().getRawEncoding()); 2437e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks } 2438e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks} 24393106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 244076aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenekvoid BugReport::markInteresting(SymbolRef sym) { 244176aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (!sym) 244276aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return; 24433bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 24443bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose // If the symbol wasn't already in our set, note a configuration change. 2445c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek if (getInterestingSymbols().insert(sym).second) 24463bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ++ConfigurationChangeToken; 24478ec588e2ac57311604cf80608c7d4b3fb3b022f7Jordy Rose 24488ec588e2ac57311604cf80608c7d4b3fb3b022f7Jordy Rose if (const SymbolMetadata *meta = dyn_cast<SymbolMetadata>(sym)) 2449c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek getInterestingRegions().insert(meta->getRegion()); 245076aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 245176aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 245276aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenekvoid BugReport::markInteresting(const MemRegion *R) { 245376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (!R) 245476aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return; 24553bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 24563bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose // If the base region wasn't already in our set, note a configuration change. 245776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek R = R->getBaseRegion(); 2458c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek if (getInterestingRegions().insert(R).second) 24593bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ++ConfigurationChangeToken; 24608ec588e2ac57311604cf80608c7d4b3fb3b022f7Jordy Rose 246176aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(R)) 2462c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek getInterestingSymbols().insert(SR->getSymbol()); 246376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 246476aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 246576aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenekvoid BugReport::markInteresting(SVal V) { 246676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek markInteresting(V.getAsRegion()); 246776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek markInteresting(V.getAsSymbol()); 246876aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 246976aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 247080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaksvoid BugReport::markInteresting(const LocationContext *LC) { 247180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (!LC) 247280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks return; 247380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks InterestingLocationContexts.insert(LC); 247480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks} 247580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 2476c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekbool BugReport::isInteresting(SVal V) { 247776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return isInteresting(V.getAsRegion()) || isInteresting(V.getAsSymbol()); 247876aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 247976aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 2480c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekbool BugReport::isInteresting(SymbolRef sym) { 248176aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (!sym) 248276aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return false; 24838ec588e2ac57311604cf80608c7d4b3fb3b022f7Jordy Rose // We don't currently consider metadata symbols to be interesting 24848ec588e2ac57311604cf80608c7d4b3fb3b022f7Jordy Rose // even if we know their region is interesting. Is that correct behavior? 2485c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek return getInterestingSymbols().count(sym); 248676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 248776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 2488c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekbool BugReport::isInteresting(const MemRegion *R) { 248976aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (!R) 249076aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return false; 249176aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek R = R->getBaseRegion(); 2492c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek bool b = getInterestingRegions().count(R); 249376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (b) 249476aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return true; 249576aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(R)) 2496c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek return getInterestingSymbols().count(SR->getSymbol()); 249776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return false; 249876aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 2499c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 250080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaksbool BugReport::isInteresting(const LocationContext *LC) { 250180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (!LC) 250280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks return false; 250380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks return InterestingLocationContexts.count(LC); 250480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks} 250580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 2506c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekvoid BugReport::lazyInitializeInterestingSets() { 2507c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek if (interestingSymbols.empty()) { 2508c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingSymbols.push_back(new Symbols()); 2509c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingRegions.push_back(new Regions()); 2510c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek } 2511c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 2512c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 2513c4bac8e376b98d633bb00ee5f510d5e58449753cTed KremenekBugReport::Symbols &BugReport::getInterestingSymbols() { 2514c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek lazyInitializeInterestingSets(); 2515c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek return *interestingSymbols.back(); 2516c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 2517c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 2518c4bac8e376b98d633bb00ee5f510d5e58449753cTed KremenekBugReport::Regions &BugReport::getInterestingRegions() { 2519c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek lazyInitializeInterestingSets(); 2520c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek return *interestingRegions.back(); 2521c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 2522c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 2523c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekvoid BugReport::pushInterestingSymbolsAndRegions() { 2524c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingSymbols.push_back(new Symbols(getInterestingSymbols())); 2525c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingRegions.push_back(new Regions(getInterestingRegions())); 2526c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 2527c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 2528c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekvoid BugReport::popInterestingSymbolsAndRegions() { 2529c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek delete interestingSymbols.back(); 2530c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingSymbols.pop_back(); 2531c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek delete interestingRegions.back(); 2532c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingRegions.pop_back(); 2533c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 253476aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 25359c378f705405d37f49795d5e915989de774fe11fTed Kremenekconst Stmt *BugReport::getStmt() const { 2536e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks if (!ErrorNode) 2537e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks return 0; 2538e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 2539212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care ProgramPoint ProgP = ErrorNode->getLocation(); 25405f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek const Stmt *S = NULL; 25411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 25427a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<BlockEntrance> BE = ProgP.getAs<BlockEntrance>()) { 2543fafd3834754d2093e0ad7a1c005860fd527ecb7fZhongxing Xu CFGBlock &Exit = ProgP.getLocationContext()->getCFG()->getExit(); 254450d5bc4e3b53eb8bb4ebf198f1213348a3fa0f38Zhongxing Xu if (BE->getBlock() == &Exit) 2545212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care S = GetPreviousStmt(ErrorNode); 25463106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 25475f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek if (!S) 25480f8579274a010f360a371b53101859d9d6052314Anna Zaks S = PathDiagnosticLocation::getStmt(ErrorNode); 25491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 25501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return S; 25513106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 25523106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 2553640ccf071076e684713cc3c3276bb51982bff607Argyrios Kyrtzidisstd::pair<BugReport::ranges_iterator, BugReport::ranges_iterator> 2554e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna ZaksBugReport::getRanges() { 2555e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks // If no custom ranges, add the range of the statement corresponding to 2556e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks // the error node. 2557e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks if (Ranges.empty()) { 2558e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks if (const Expr *E = dyn_cast_or_null<Expr>(getStmt())) 2559e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks addRange(E->getSourceRange()); 2560e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks else 2561e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks return std::make_pair(ranges_iterator(), ranges_iterator()); 2562e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks } 2563e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 256414924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks // User-specified absence of range info. 256514924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks if (Ranges.size() == 1 && !Ranges.begin()->isValid()) 256614924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks return std::make_pair(ranges_iterator(), ranges_iterator()); 256714924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks 2568e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks return std::make_pair(Ranges.begin(), Ranges.end()); 25693106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 25703106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 2571590dd8e0959d8df5621827768987c4792b74fc06Anna ZaksPathDiagnosticLocation BugReport::getLocation(const SourceManager &SM) const { 2572b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks if (ErrorNode) { 2573590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks assert(!Location.isValid() && 2574b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks "Either Location or ErrorNode should be specified but not both."); 25750f8579274a010f360a371b53101859d9d6052314Anna Zaks return PathDiagnosticLocation::createEndOfPath(ErrorNode, SM); 2576b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks } else { 2577b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks assert(Location.isValid()); 2578b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks return Location; 2579b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks } 2580b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks 2581590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks return PathDiagnosticLocation(); 25823106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 25833106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 25843106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 25853106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// Methods for BugReporter and subclasses. 25863106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 25873106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 25884a5f724538cbc275370c9504e8169ce92503256cBenjamin KramerBugReportEquivClass::~BugReportEquivClass() { } 2589a2f4ec0df645fc249d2945beef9653f03b175417Zhongxing XuGRBugReporter::~GRBugReporter() { } 25903106198188ac6eb2753f1764d5c28376b0b76351Ted KremenekBugReporterData::~BugReporterData() {} 25913106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 259238b02b912e1a55c912f603c4369431264d36a381Zhongxing XuExplodedGraph &GRBugReporter::getGraph() { return Eng.getGraph(); } 25933106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 259418c66fdc3c4008d335885695fe36fb5353c5f672Ted KremenekProgramStateManager& 25953106198188ac6eb2753f1764d5c28376b0b76351Ted KremenekGRBugReporter::getStateManager() { return Eng.getStateManager(); } 25963106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 25973b030a28cda2b953758507769c1d436bec5ec45eAnna ZaksBugReporter::~BugReporter() { 25983b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks FlushReports(); 25993b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks 26003b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks // Free the bug reports we are tracking. 26013b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks typedef std::vector<BugReportEquivClass *> ContTy; 26023b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks for (ContTy::iterator I = EQClassesVector.begin(), E = EQClassesVector.end(); 26033b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks I != E; ++I) { 26043b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks delete *I; 26053b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks } 26063b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks} 26073106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 26083106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenekvoid BugReporter::FlushReports() { 26093106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (BugTypes.isEmpty()) 26103106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek return; 26113106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 26123106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // First flush the warnings for each BugType. This may end up creating new 2613404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // warnings and new BugTypes. 2614404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // FIXME: Only NSErrorChecker needs BugType's FlushReports. 2615404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // Turn NSErrorChecker into a proper checker and remove this. 26165f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<const BugType*, 16> bugTypes; 26173106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek for (BugTypesTy::iterator I=BugTypes.begin(), E=BugTypes.end(); I!=E; ++I) 2618404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis bugTypes.push_back(*I); 26195f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner for (SmallVector<const BugType*, 16>::iterator 2620404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis I = bugTypes.begin(), E = bugTypes.end(); I != E; ++I) 26213106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek const_cast<BugType*>(*I)->FlushReports(*this); 26223106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 2623d015f4febe85d3e3340172d70042840c51bbd836Anna Zaks // We need to flush reports in deterministic order to ensure the order 2624d015f4febe85d3e3340172d70042840c51bbd836Anna Zaks // of the reports is consistent between runs. 26250eb6c37dd4e4ad8fa2363003dea270f9fd6c2969Anna Zaks typedef std::vector<BugReportEquivClass *> ContVecTy; 26260eb6c37dd4e4ad8fa2363003dea270f9fd6c2969Anna Zaks for (ContVecTy::iterator EI=EQClassesVector.begin(), EE=EQClassesVector.end(); 26270eb6c37dd4e4ad8fa2363003dea270f9fd6c2969Anna Zaks EI != EE; ++EI){ 26280eb6c37dd4e4ad8fa2363003dea270f9fd6c2969Anna Zaks BugReportEquivClass& EQ = **EI; 2629404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis FlushReport(EQ); 26303106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 26313106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 2632404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // BugReporter owns and deletes only BugTypes created implicitly through 2633404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // EmitBasicReport. 2634404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // FIXME: There are leaks from checkers that assume that the BugTypes they 2635404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // create will be destroyed by the BugReporter. 2636404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis for (llvm::StringMap<BugType*>::iterator 2637404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis I = StrBugTypes.begin(), E = StrBugTypes.end(); I != E; ++I) 2638404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis delete I->second; 2639404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 26403106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Remove all references to the BugType objects. 26413baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugTypes = F.getEmptySet(); 26423106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 26433106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 26443106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 26453106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// PathDiagnostics generation. 26463106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 26473106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 26481efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rosenamespace { 26491efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose/// A wrapper around a report graph, which contains only a single path, and its 26501efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose/// node maps. 26511efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Roseclass ReportGraph { 26521efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rosepublic: 26531efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose InterExplodedGraphMap BackMap; 2654228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose OwningPtr<ExplodedGraph> Graph; 2655228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose const ExplodedNode *ErrorNode; 26561efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose size_t Index; 26571efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose}; 26581efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose 26591efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose/// A wrapper around a trimmed graph and its node maps. 26601efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Roseclass TrimmedGraph { 26611efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose InterExplodedGraphMap InverseMap; 26622110350909701fcd6b55c636e24a675f0a905feaJordan Rose 26632110350909701fcd6b55c636e24a675f0a905feaJordan Rose typedef llvm::DenseMap<const ExplodedNode *, unsigned> PriorityMapTy; 26642110350909701fcd6b55c636e24a675f0a905feaJordan Rose PriorityMapTy PriorityMap; 26652110350909701fcd6b55c636e24a675f0a905feaJordan Rose 2666228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose typedef std::pair<const ExplodedNode *, size_t> NodeIndexPair; 2667228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose SmallVector<NodeIndexPair, 32> ReportNodes; 2668228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 26691efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose OwningPtr<ExplodedGraph> G; 2670228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2671228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose /// A helper class for sorting ExplodedNodes by priority. 2672228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose template <bool Descending> 2673228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose class PriorityCompare { 2674228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose const PriorityMapTy &PriorityMap; 2675228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2676228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose public: 2677228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityCompare(const PriorityMapTy &M) : PriorityMap(M) {} 2678228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2679228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose bool operator()(const ExplodedNode *LHS, const ExplodedNode *RHS) const { 2680228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityMapTy::const_iterator LI = PriorityMap.find(LHS); 2681228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityMapTy::const_iterator RI = PriorityMap.find(RHS); 2682228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityMapTy::const_iterator E = PriorityMap.end(); 2683228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2684228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (LI == E) 2685228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return Descending; 2686228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (RI == E) 2687228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return !Descending; 2688228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2689228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return Descending ? LI->second > RI->second 2690228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose : LI->second < RI->second; 2691228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose } 2692228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2693228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose bool operator()(const NodeIndexPair &LHS, const NodeIndexPair &RHS) const { 2694228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return (*this)(LHS.first, RHS.first); 2695228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose } 2696228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose }; 2697228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 26981efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rosepublic: 26991efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose TrimmedGraph(const ExplodedGraph *OriginalGraph, 27002110350909701fcd6b55c636e24a675f0a905feaJordan Rose ArrayRef<const ExplodedNode *> Nodes); 27011efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose 2702228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose bool popNextReportGraph(ReportGraph &GraphWrapper); 27031efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose}; 27041efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose} 27051efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose 27062110350909701fcd6b55c636e24a675f0a905feaJordan RoseTrimmedGraph::TrimmedGraph(const ExplodedGraph *OriginalGraph, 27072110350909701fcd6b55c636e24a675f0a905feaJordan Rose ArrayRef<const ExplodedNode *> Nodes) { 27082110350909701fcd6b55c636e24a675f0a905feaJordan Rose // The trimmed graph is created in the body of the constructor to ensure 27092110350909701fcd6b55c636e24a675f0a905feaJordan Rose // that the DenseMaps have been initialized already. 2710228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose InterExplodedGraphMap ForwardMap; 27110f3a34fb7fea37ebfbcba8b400ccb697b9559b49Jordan Rose G.reset(OriginalGraph->trim(Nodes, &ForwardMap, &InverseMap)); 27121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 27133106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Find the (first) error node in the trimmed graph. We just need to consult 27141efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose // the node map which maps from nodes in the original graph to nodes 27153106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // in the new graph. 2716228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose llvm::SmallPtrSet<const ExplodedNode *, 32> RemainingNodes; 27173106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 27181efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose for (unsigned i = 0, count = Nodes.size(); i < count; ++i) { 2719228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (const ExplodedNode *NewNode = ForwardMap.lookup(Nodes[i])) { 2720228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose ReportNodes.push_back(std::make_pair(NewNode, i)); 2721228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose RemainingNodes.insert(NewNode); 27223106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 272340406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek } 27241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2725228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose assert(!RemainingNodes.empty() && "No error node found in the trimmed graph"); 2726228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2727228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // Perform a forward BFS to find all the shortest paths. 2728228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose std::queue<const ExplodedNode *> WS; 2729228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2730228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose assert(G->num_roots() == 1); 2731228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose WS.push(*G->roots_begin()); 2732228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose unsigned Priority = 0; 27333106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 27343106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek while (!WS.empty()) { 2735228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose const ExplodedNode *Node = WS.front(); 27363106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek WS.pop(); 27371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 27382110350909701fcd6b55c636e24a675f0a905feaJordan Rose PriorityMapTy::iterator PriorityEntry; 27392110350909701fcd6b55c636e24a675f0a905feaJordan Rose bool IsNew; 27402110350909701fcd6b55c636e24a675f0a905feaJordan Rose llvm::tie(PriorityEntry, IsNew) = 27412110350909701fcd6b55c636e24a675f0a905feaJordan Rose PriorityMap.insert(std::make_pair(Node, Priority)); 2742228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose ++Priority; 27431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 27442110350909701fcd6b55c636e24a675f0a905feaJordan Rose if (!IsNew) { 27452110350909701fcd6b55c636e24a675f0a905feaJordan Rose assert(PriorityEntry->second <= Priority); 27462110350909701fcd6b55c636e24a675f0a905feaJordan Rose continue; 27472110350909701fcd6b55c636e24a675f0a905feaJordan Rose } 27481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2749228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (RemainingNodes.erase(Node)) 2750228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (RemainingNodes.empty()) 2751228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose break; 2752a5f80b2ea6d30c5055c067530d63bb0dcaf937d0Jordan Rose 2753228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose for (ExplodedNode::const_pred_iterator I = Node->succ_begin(), 2754228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose E = Node->succ_end(); 27552110350909701fcd6b55c636e24a675f0a905feaJordan Rose I != E; ++I) 2756228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose WS.push(*I); 2757239b6e47d282bd66c8b559ac47b8b42b34da619eJordan Rose } 27582110350909701fcd6b55c636e24a675f0a905feaJordan Rose 2759228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // Sort the error paths from longest to shortest. 2760228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose std::sort(ReportNodes.begin(), ReportNodes.end(), 2761228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityCompare<true>(PriorityMap)); 2762228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose} 27632110350909701fcd6b55c636e24a675f0a905feaJordan Rose 2764228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rosebool TrimmedGraph::popNextReportGraph(ReportGraph &GraphWrapper) { 2765228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (ReportNodes.empty()) 2766228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return false; 27672110350909701fcd6b55c636e24a675f0a905feaJordan Rose 2768228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose const ExplodedNode *OrigN; 2769228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose llvm::tie(OrigN, GraphWrapper.Index) = ReportNodes.pop_back_val(); 2770228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose assert(PriorityMap.find(OrigN) != PriorityMap.end() && 2771228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose "error node not accessible from root"); 27722110350909701fcd6b55c636e24a675f0a905feaJordan Rose 27732110350909701fcd6b55c636e24a675f0a905feaJordan Rose // Create a new graph with a single path. This is the graph 27742110350909701fcd6b55c636e24a675f0a905feaJordan Rose // that will be returned to the caller. 27752110350909701fcd6b55c636e24a675f0a905feaJordan Rose ExplodedGraph *GNew = new ExplodedGraph(); 27762110350909701fcd6b55c636e24a675f0a905feaJordan Rose GraphWrapper.Graph.reset(GNew); 2777228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose GraphWrapper.BackMap.clear(); 27781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2779228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // Now walk from the error node up the BFS path, always taking the 2780228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // predeccessor with the lowest number. 2781228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose ExplodedNode *Succ = 0; 2782228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose while (true) { 27833106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Create the equivalent node in the new graph with the same state 27843106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // and location. 27853e5ebf1a05603e08f2d0b2b2a5fa9406fe4cfb22Jordan Rose ExplodedNode *NewN = GNew->getNode(OrigN->getLocation(), OrigN->getState(), 27863e5ebf1a05603e08f2d0b2b2a5fa9406fe4cfb22Jordan Rose OrigN->isSink()); 27871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 27883106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Store the mapping to the original node. 2789228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose InterExplodedGraphMap::const_iterator IMitr = InverseMap.find(OrigN); 27903106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek assert(IMitr != InverseMap.end() && "No mapping to original node."); 27911efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose GraphWrapper.BackMap[NewN] = IMitr->second; 27921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 27933106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Link up the new node with the previous node. 2794228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (Succ) 2795228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose Succ->addPredecessor(NewN, *GNew); 2796228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose else 2797228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose GraphWrapper.ErrorNode = NewN; 27981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2799228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose Succ = NewN; 28001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28013106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Are we at the final node? 2802228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (OrigN->pred_empty()) { 2803228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose GNew->addRoot(NewN); 28043106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 28053106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 28061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2807228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // Find the next predeccessor node. We choose the node that is marked 28082110350909701fcd6b55c636e24a675f0a905feaJordan Rose // with the lowest BFS number. 2809228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose OrigN = *std::min_element(OrigN->pred_begin(), OrigN->pred_end(), 2810228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityCompare<false>(PriorityMap)); 28112110350909701fcd6b55c636e24a675f0a905feaJordan Rose } 28122110350909701fcd6b55c636e24a675f0a905feaJordan Rose 2813228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return true; 28142110350909701fcd6b55c636e24a675f0a905feaJordan Rose} 28152110350909701fcd6b55c636e24a675f0a905feaJordan Rose 28162110350909701fcd6b55c636e24a675f0a905feaJordan Rose 28173106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek/// CompactPathDiagnostic - This function postprocesses a PathDiagnostic object 28183106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek/// and collapses PathDiagosticPieces that are expanded by macros. 281977d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenekstatic void CompactPathDiagnostic(PathPieces &path, const SourceManager& SM) { 28202042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek typedef std::vector<std::pair<IntrusiveRefCntPtr<PathDiagnosticMacroPiece>, 28212042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek SourceLocation> > MacroStackTy; 28221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2823c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith typedef std::vector<IntrusiveRefCntPtr<PathDiagnosticPiece> > 28243106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PiecesTy; 28251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28263106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroStackTy MacroStack; 28273106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PiecesTy Pieces; 28281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2829ed866e73bab7733f5226f84c52edefe23d694b2fTed Kremenek for (PathPieces::const_iterator I = path.begin(), E = path.end(); 28302042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek I!=E; ++I) { 283177d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek 2832ed866e73bab7733f5226f84c52edefe23d694b2fTed Kremenek PathDiagnosticPiece *piece = I->getPtr(); 283377d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek 283477d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek // Recursively compact calls. 283577d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek if (PathDiagnosticCallPiece *call=dyn_cast<PathDiagnosticCallPiece>(piece)){ 283677d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek CompactPathDiagnostic(call->path, SM); 283777d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek } 283877d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek 28393106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Get the location of the PathDiagnosticPiece. 284077d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek const FullSourceLoc Loc = piece->getLocation().asLocation(); 28411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28423106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Determine the instantiation location, which is the location we group 28433106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // related PathDiagnosticPieces. 28441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump SourceLocation InstantiationLoc = Loc.isMacroID() ? 2845402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SM.getExpansionLoc(Loc) : 28463106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek SourceLocation(); 28471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28483106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (Loc.isFileID()) { 28493106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroStack.clear(); 285077d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek Pieces.push_back(piece); 28513106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek continue; 28523106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 2853706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek 28543106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek assert(Loc.isMacroID()); 28551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28563106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Is the PathDiagnosticPiece within the same macro group? 28573106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (!MacroStack.empty() && InstantiationLoc == MacroStack.back().second) { 285877d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek MacroStack.back().first->subPieces.push_back(piece); 28593106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek continue; 28603106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 2861d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek 28623106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // We aren't in the same group. Are we descending into a new macro 28633106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // or are part of an old one? 2864c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<PathDiagnosticMacroPiece> MacroGroup; 2865d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek 28663106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek SourceLocation ParentInstantiationLoc = InstantiationLoc.isMacroID() ? 2867402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SM.getExpansionLoc(Loc) : 28683106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek SourceLocation(); 28691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28703106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Walk the entire macro stack. 28713106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek while (!MacroStack.empty()) { 28723106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (InstantiationLoc == MacroStack.back().second) { 28733106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroGroup = MacroStack.back().first; 28743106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 28753106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 28761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28773106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (ParentInstantiationLoc == MacroStack.back().second) { 28783106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroGroup = MacroStack.back().first; 28793106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 288061f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek } 28811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28823106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroStack.pop_back(); 28836837faa083bebad39aa342f84c2b450fb6410eafTed Kremenek } 28841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28853106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (!MacroGroup || ParentInstantiationLoc == MacroStack.back().second) { 28863106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Create a new macro group and add it to the stack. 2887590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticMacroPiece *NewGroup = 2888590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks new PathDiagnosticMacroPiece( 288977d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek PathDiagnosticLocation::createSingleLocation(piece->getLocation())); 28905a429954aedd8a830a70fcea2cb51561673e4fc3Ted Kremenek 28913106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (MacroGroup) 2892802e02463b880f53a6e645bde78cc412481ce9e0Ted Kremenek MacroGroup->subPieces.push_back(NewGroup); 28933106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek else { 28943106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek assert(InstantiationLoc.isFileID()); 28953106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek Pieces.push_back(NewGroup); 28963106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 28971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28983106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroGroup = NewGroup; 28993106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroStack.push_back(std::make_pair(MacroGroup, InstantiationLoc)); 29007dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek } 29013106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 29023106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Finally, add the PathDiagnosticPiece to the group. 290377d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek MacroGroup->subPieces.push_back(piece); 29043106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 29051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29063106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Now take the pieces and construct a new PathDiagnostic. 290777d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek path.clear(); 29081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 290977d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek for (PiecesTy::iterator I=Pieces.begin(), E=Pieces.end(); I!=E; ++I) 291077d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek path.push_back(*I); 291161f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek} 291261f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 29138347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rosebool GRBugReporter::generatePathDiagnostic(PathDiagnostic& PD, 2914c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticConsumer &PC, 2915c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<BugReport *> &bugReports) { 291640406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek assert(!bugReports.empty()); 29178347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 29189a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose bool HasValid = false; 2919228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose bool HasInvalid = false; 29202f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose SmallVector<const ExplodedNode *, 32> errorNodes; 2921c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek for (ArrayRef<BugReport*>::iterator I = bugReports.begin(), 29229a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose E = bugReports.end(); I != E; ++I) { 29239a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose if ((*I)->isValid()) { 29249a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose HasValid = true; 29259a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose errorNodes.push_back((*I)->getErrorNode()); 29269a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose } else { 2927228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // Keep the errorNodes list in sync with the bugReports list. 2928228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose HasInvalid = true; 29299a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose errorNodes.push_back(0); 29309a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose } 293140406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek } 29321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29339a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose // If all the reports have been marked invalid by a previous path generation, 29349a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose // we're done. 29359a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose if (!HasValid) 29369a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose return false; 29379a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose 29382f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose typedef PathDiagnosticConsumer::PathGenerationScheme PathGenerationScheme; 29392f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose PathGenerationScheme ActiveScheme = PC.getGenerationScheme(); 29402f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 2941af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (ActiveScheme == PathDiagnosticConsumer::Extensive) { 2942d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks AnalyzerOptions &options = getAnalyzerOptions(); 294315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek if (options.getBooleanOption("path-diagnostics-alternate", false)) { 2944af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek ActiveScheme = PathDiagnosticConsumer::AlternateExtensive; 2945af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 2946af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 2947af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 29481efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose TrimmedGraph TrimG(&getGraph(), errorNodes); 2949228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose ReportGraph ErrorGraph; 29501efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose 2951228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose while (TrimG.popNextReportGraph(ErrorGraph)) { 29522f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Find the BugReport with the original location. 29531efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose assert(ErrorGraph.Index < bugReports.size()); 29541efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose BugReport *R = bugReports[ErrorGraph.Index]; 29552f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose assert(R && "No original report found for sliced graph."); 29562f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose assert(R->isValid() && "Report selected by trimmed graph marked invalid."); 29572f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 29582f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Start building the path diagnostic... 29591efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose PathDiagnosticBuilder PDB(*this, R, ErrorGraph.BackMap, &PC); 29601efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose const ExplodedNode *N = ErrorGraph.ErrorNode; 29612f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 29622f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Register additional node visitors. 29632f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose R->addVisitor(new NilReceiverBRVisitor()); 29642f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose R->addVisitor(new ConditionBRVisitor()); 29652f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose R->addVisitor(new LikelyFalsePositiveSuppressionBRVisitor()); 29662f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 29672f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose BugReport::VisitorList visitors; 29682f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose unsigned origReportConfigToken, finalReportConfigToken; 2969d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek LocationContextMap LCM; 29702f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 29712f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // While generating diagnostics, it's possible the visitors will decide 29722f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // new symbols and regions are interesting, or add other visitors based on 29732f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // the information they find. If they do, we need to regenerate the path 29742f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // based on our new report configuration. 29752f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose do { 29762f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Get a clean copy of all the visitors. 29772f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose for (BugReport::visitor_iterator I = R->visitor_begin(), 29782f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose E = R->visitor_end(); I != E; ++I) 29792f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose visitors.push_back((*I)->clone()); 29802f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 29812f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Clear out the active path from any previous work. 29822f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose PD.resetPath(); 29832f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose origReportConfigToken = R->getConfigurationChangeToken(); 29842f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 29852f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Generate the very last diagnostic piece - the piece is visible before 29862f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // the trace is expanded. 29872f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose PathDiagnosticPiece *LastPiece = 0; 29882f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose for (BugReport::visitor_iterator I = visitors.begin(), E = visitors.end(); 29892f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose I != E; ++I) { 29902f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose if (PathDiagnosticPiece *Piece = (*I)->getEndPath(PDB, N, *R)) { 29912f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose assert (!LastPiece && 29922f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose "There can only be one final piece in a diagnostic."); 29932f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose LastPiece = Piece; 29942f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose } 29953bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose } 299686ff12c8a8a356ca284ca7687749216fbfd74519Anna Zaks 29972f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose if (ActiveScheme != PathDiagnosticConsumer::None) { 29982f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose if (!LastPiece) 29992f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose LastPiece = BugReporterVisitor::getDefaultEndPath(PDB, N, *R); 30002f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose assert(LastPiece); 3001d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose PD.setEndOfPath(LastPiece); 30028347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose } 30032f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 3004d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek // Make sure we get a clean location context map so we don't 3005d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek // hold onto old mappings. 3006d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek LCM.clear(); 3007d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek 30082f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose switch (ActiveScheme) { 3009af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek case PathDiagnosticConsumer::AlternateExtensive: 3010af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek GenerateAlternateExtensivePathDiagnostic(PD, PDB, N, LCM, visitors); 3011af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek break; 30122f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose case PathDiagnosticConsumer::Extensive: 3013d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek GenerateExtensivePathDiagnostic(PD, PDB, N, LCM, visitors); 30142f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose break; 30152f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose case PathDiagnosticConsumer::Minimal: 3016d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek GenerateMinimalPathDiagnostic(PD, PDB, N, LCM, visitors); 30172f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose break; 30182f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose case PathDiagnosticConsumer::None: 30192f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose GenerateVisitorsOnlyPathDiagnostic(PD, PDB, N, visitors); 30202f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose break; 3021d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose } 30223bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 30232f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Clean up the visitors we used. 30242f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose llvm::DeleteContainerPointers(visitors); 30253bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 30262f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Did anything change while generating this path? 30272f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose finalReportConfigToken = R->getConfigurationChangeToken(); 30282f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose } while (finalReportConfigToken != origReportConfigToken); 30293bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 3030228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (!R->isValid()) 30312f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose continue; 3032b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 30332f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Finally, prune the diagnostic path of uninteresting stuff. 30342f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose if (!PD.path.empty()) { 30352f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Remove messages that are basically the same. 30362f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose removeRedundantMsgs(PD.getMutablePieces()); 30372f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 3038d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks if (R->shouldPrunePath() && getAnalyzerOptions().shouldPrunePaths()) { 3039d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek bool stillHasNotes = removeUnneededCalls(PD.getMutablePieces(), R, LCM); 30402f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose assert(stillHasNotes); 30412f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose (void)stillHasNotes; 30422f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose } 30432f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 30442f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose adjustCallLocations(PD.getMutablePieces()); 3045bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 3046bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (ActiveScheme == PathDiagnosticConsumer::AlternateExtensive) { 3047aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek SourceManager &SM = getSourceManager(); 3048aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek 3049aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek // Reduce the number of edges from a very conservative set 3050aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek // to an aesthetically pleasing subset that conveys the 3051aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek // necessary information. 305215676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek OptimizedCallsSet OCS; 3053bb518991ce4298d8662235fc8cb13813f011c18dJordan Rose while (optimizeEdges(PD.getMutablePieces(), SM, OCS, LCM)) {} 3054aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek 305501f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose // Drop the very first function-entry edge. It's not really necessary 305601f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose // for top-level functions. 305701f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose dropFunctionEntryEdge(PD.getMutablePieces(), LCM, SM); 3058bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek } 3059b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek } 3060afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose 30612f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // We found a report and didn't suppress it. 30622f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose return true; 3063ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek } 30648347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 30652f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // We suppressed all the reports in this equivalence class. 3066228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose assert(!HasInvalid && "Inconsistent suppression"); 3067228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose (void)HasInvalid; 30682f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose return false; 30693106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 30701aa44c7c9198796085b77c6bdd7c90030845a688Ted Kremenek 3071cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekvoid BugReporter::Register(BugType *BT) { 30723baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugTypes = F.add(BugTypes, BT); 307376d90c8bf83d071fd1bdbffa6d9f2af87c6bb7b5Ted Kremenek} 307476d90c8bf83d071fd1bdbffa6d9f2af87c6bb7b5Ted Kremenek 3075785950e59424dca7ce0081bebf13c0acd2c4fff6Jordan Rosevoid BugReporter::emitReport(BugReport* R) { 3076cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek // Compute the bug report's hash to determine its equivalence class. 3077cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek llvm::FoldingSetNodeID ID; 3078cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek R->Profile(ID); 30791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 30801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Lookup the equivance class. If there isn't one, create it. 3081cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugType& BT = R->getBugType(); 3082cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek Register(&BT); 3083cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void *InsertPos; 3084404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis BugReportEquivClass* EQ = EQClasses.FindNodeOrInsertPos(ID, InsertPos); 30851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3086cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek if (!EQ) { 3087cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek EQ = new BugReportEquivClass(R); 3088404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis EQClasses.InsertNode(EQ, InsertPos); 30893b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks EQClassesVector.push_back(EQ); 3090cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek } 3091cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek else 3092cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek EQ->AddReport(R); 309361f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek} 309461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 309506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 309606c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek//===----------------------------------------------------------------------===// 309706c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek// Emitting reports in equivalence classes. 309806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek//===----------------------------------------------------------------------===// 309906c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 310006c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremeneknamespace { 3101ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamstruct FRIEC_WLItem { 310206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek const ExplodedNode *N; 310306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek ExplodedNode::const_succ_iterator I, E; 310406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 310506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek FRIEC_WLItem(const ExplodedNode *n) 310606c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek : N(n), I(N->succ_begin()), E(N->succ_end()) {} 310706c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek}; 310806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek} 310906c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 311061f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenekstatic BugReport * 311161f52bd3c524268e25b48a1ed3730aedd6cc8374Ted KremenekFindReportInEquivalenceClass(BugReportEquivClass& EQ, 31125f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVectorImpl<BugReport*> &bugReports) { 311361f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 311406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek BugReportEquivClass::iterator I = EQ.begin(), E = EQ.end(); 311506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek assert(I != E); 31164a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer BugType& BT = I->getBugType(); 311761f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 311840406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek // If we don't need to suppress any of the nodes because they are 311940406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek // post-dominated by a sink, simply add all the nodes in the equivalence class 312040406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek // to 'Nodes'. Any of the reports will serve as a "representative" report. 312161f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek if (!BT.isSuppressOnSink()) { 31224a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer BugReport *R = I; 312361f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek for (BugReportEquivClass::iterator I=EQ.begin(), E=EQ.end(); I!=E; ++I) { 31249c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *N = I->getErrorNode(); 312561f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek if (N) { 31264a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer R = I; 312740406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek bugReports.push_back(R); 312861f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek } 312961f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek } 313006c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek return R; 313161f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek } 313261f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 313306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // For bug reports that should be suppressed when all paths are post-dominated 313406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // by a sink node, iterate through the reports in the equivalence class 313506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // until we find one that isn't post-dominated (if one exists). We use a 313606c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // DFS traversal of the ExplodedGraph to find a non-sink node. We could write 313706c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // this as a recursive function, but we don't want to risk blowing out the 313806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // stack for very long paths. 313940406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek BugReport *exampleReport = 0; 314061f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 314106c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek for (; I != E; ++I) { 31424a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer const ExplodedNode *errorNode = I->getErrorNode(); 314306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 314440406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek if (!errorNode) 314506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek continue; 314640406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek if (errorNode->isSink()) { 3147b219cfc4d75f0a03630b7c4509ef791b7e97b2c8David Blaikie llvm_unreachable( 314806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek "BugType::isSuppressSink() should not be 'true' for sink end nodes"); 314906c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 315061f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // No successors? By definition this nodes isn't post-dominated by a sink. 315140406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek if (errorNode->succ_empty()) { 31524a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer bugReports.push_back(I); 315340406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek if (!exampleReport) 31544a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer exampleReport = I; 315561f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek continue; 315661f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek } 315761f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 315806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // At this point we know that 'N' is not a sink and it has at least one 315906c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // successor. Use a DFS worklist to find a non-sink end-of-path node. 316006c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek typedef FRIEC_WLItem WLItem; 31615f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner typedef SmallVector<WLItem, 10> DFSWorkList; 316206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek llvm::DenseMap<const ExplodedNode *, unsigned> Visited; 316306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 316406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek DFSWorkList WL; 316540406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek WL.push_back(errorNode); 316640406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek Visited[errorNode] = 1; 316706c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 316806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek while (!WL.empty()) { 316906c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek WLItem &WI = WL.back(); 317006c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek assert(!WI.N->succ_empty()); 317106c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 317206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek for (; WI.I != WI.E; ++WI.I) { 317306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek const ExplodedNode *Succ = *WI.I; 317406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // End-of-path node? 317506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek if (Succ->succ_empty()) { 317661f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // If we found an end-of-path node that is not a sink. 317761f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek if (!Succ->isSink()) { 31784a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer bugReports.push_back(I); 317940406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek if (!exampleReport) 31804a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer exampleReport = I; 318161f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek WL.clear(); 318261f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek break; 318361f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek } 318406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // Found a sink? Continue on to the next successor. 318506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek continue; 318606c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 318706c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // Mark the successor as visited. If it hasn't been explored, 318806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // enqueue it to the DFS worklist. 318906c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek unsigned &mark = Visited[Succ]; 319006c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek if (!mark) { 319106c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek mark = 1; 319206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek WL.push_back(Succ); 319306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek break; 319406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 319506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 319661f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 319761f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // The worklist may have been cleared at this point. First 319861f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // check if it is empty before checking the last item. 319961f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek if (!WL.empty() && &WL.back() == &WI) 320006c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek WL.pop_back(); 320106c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 320206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 320306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 320461f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // ExampleReport will be NULL if all the nodes in the equivalence class 320561f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // were post-dominated by sinks. 320640406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek return exampleReport; 320761f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek} 3208e0a58073b76fc016325a35152533b8468df2bf4aTed Kremenek 3209cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekvoid BugReporter::FlushReport(BugReportEquivClass& EQ) { 32105f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<BugReport*, 10> bugReports; 321140406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek BugReport *exampleReport = FindReportInEquivalenceClass(EQ, bugReports); 3212c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek if (exampleReport) { 3213c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek const PathDiagnosticConsumers &C = getPathDiagnosticConsumers(); 3214c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek for (PathDiagnosticConsumers::const_iterator I=C.begin(), 3215c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek E=C.end(); I != E; ++I) { 3216c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek FlushReport(exampleReport, **I, bugReports); 3217c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek } 3218c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek } 3219c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 3220c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 3221c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekvoid BugReporter::FlushReport(BugReport *exampleReport, 3222c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticConsumer &PD, 3223c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<BugReport*> bugReports) { 32241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3225cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek // FIXME: Make sure we use the 'R' for the path that was actually used. 32261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Probably doesn't make a difference in practice. 322740406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek BugType& BT = exampleReport->getBugType(); 32281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 32296f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<PathDiagnostic> 323007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek D(new PathDiagnostic(exampleReport->getDeclWithIssue(), 323107189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek exampleReport->getBugType().getName(), 32323a46f5fd1709f6df03bbb8b0abf84052dc0f39ffJordan Rose exampleReport->getDescription(), 32333a46f5fd1709f6df03bbb8b0abf84052dc0f39ffJordan Rose exampleReport->getShortDescription(/*Fallback=*/false), 323497bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks BT.getCategory(), 323597bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks exampleReport->getUniqueingLocation(), 323697bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks exampleReport->getUniqueingDecl())); 3237d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek 3238cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose MaxBugClassSize = std::max(bugReports.size(), 3239cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose static_cast<size_t>(MaxBugClassSize)); 3240cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose 3241c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek // Generate the full path diagnostic, using the generation scheme 3242d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // specified by the PathDiagnosticConsumer. Note that we have to generate 3243d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // path diagnostics even for consumers which do not support paths, because 3244d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // the BugReporterVisitors may mark this bug as a false positive. 3245d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose if (!bugReports.empty()) 3246d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose if (!generatePathDiagnostic(*D.get(), PD, bugReports)) 3247d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose return; 32483148eb4a75f70f2636075c364d03104223f004d3Ted Kremenek 3249cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose MaxValidBugClassSize = std::max(bugReports.size(), 3250cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose static_cast<size_t>(MaxValidBugClassSize)); 3251cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose 3252d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks // Examine the report and see if the last piece is in a header. Reset the 3253d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks // report location to the last piece in the main source file. 3254d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks AnalyzerOptions& Opts = getAnalyzerOptions(); 3255d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks if (Opts.shouldReportIssuesInMainSourceFile() && !Opts.AnalyzeAll) 3256d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks D->resetDiagnosticLocationToMainFile(); 3257d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks 3258c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek // If the path is empty, generate a single step path with the location 3259c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek // of the issue. 3260802e02463b880f53a6e645bde78cc412481ce9e0Ted Kremenek if (D->path.empty()) { 3261c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticLocation L = exampleReport->getLocation(getSourceManager()); 3262c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticPiece *piece = 3263c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek new PathDiagnosticEventPiece(L, exampleReport->getDescription()); 3264c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek BugReport::ranges_iterator Beg, End; 3265c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek llvm::tie(Beg, End) = exampleReport->getRanges(); 326607189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek for ( ; Beg != End; ++Beg) 326707189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek piece->addRange(*Beg); 32683a46f5fd1709f6df03bbb8b0abf84052dc0f39ffJordan Rose D->setEndOfPath(piece); 32693148eb4a75f70f2636075c364d03104223f004d3Ted Kremenek } 32701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3271c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek // Get the meta data. 3272c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek const BugReport::ExtraTextList &Meta = exampleReport->getExtraText(); 3273c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek for (BugReport::ExtraTextList::const_iterator i = Meta.begin(), 3274c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek e = Meta.end(); i != e; ++i) { 3275c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek D->addMeta(*i); 3276c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek } 3277c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 3278c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PD.HandlePathDiagnostic(D.take()); 327961f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek} 328057202071e477530e9348bc76671ee369b2399b92Ted Kremenek 328107189521a15d9c088216b943649cb9fe231cbb57Ted Kremenekvoid BugReporter::EmitBasicReport(const Decl *DeclWithIssue, 328207189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek StringRef name, 32835f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner StringRef category, 3284590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef str, PathDiagnosticLocation Loc, 32858c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek SourceRange* RBeg, unsigned NumRanges) { 32861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3287404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // 'BT' is owned by BugReporter. 3288404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis BugType *BT = getBugTypeForName(name, category); 3289590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks BugReport *R = new BugReport(*BT, str, Loc); 329007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek R->setDeclWithIssue(DeclWithIssue); 3291cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek for ( ; NumRanges > 0 ; --NumRanges, ++RBeg) R->addRange(*RBeg); 3292785950e59424dca7ce0081bebf13c0acd2c4fff6Jordan Rose emitReport(R); 3293cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek} 3294404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 32955f9e272e632e951b1efe824cd16acb4d96077930Chris LattnerBugType *BugReporter::getBugTypeForName(StringRef name, 32965f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner StringRef category) { 3297f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith SmallString<136> fullDesc; 3298404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::raw_svector_ostream(fullDesc) << name << ":" << category; 3299404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::StringMapEntry<BugType *> & 3300404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis entry = StrBugTypes.GetOrCreateValue(fullDesc); 3301404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis BugType *BT = entry.getValue(); 3302404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis if (!BT) { 3303404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis BT = new BugType(name, category); 3304404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis entry.setValue(BT); 3305404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis } 3306404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis return BT; 3307404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis} 3308