BugReporter.cpp revision d474da062565596015558856333423199aed5eb1
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 353ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenekstatic bool IsNested(const Stmt *S, ParentMap &PM) { 354ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek if (isa<Expr>(S) && PM.isConsumedExpr(cast<Expr>(S))) 355ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek return true; 3561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 357ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek const Stmt *Parent = PM.getParentIgnoreParens(S); 3581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 359ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek if (Parent) 360ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek switch (Parent->getStmtClass()) { 361ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek case Stmt::ForStmtClass: 362ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek case Stmt::DoStmtClass: 363ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek case Stmt::WhileStmtClass: 364ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek return true; 365ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek default: 366ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek break; 367ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek } 3681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return false; 370ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek} 371ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek 372d8c938b0f6b7a7156181be575239e4c6e15a2adbTed KremenekPathDiagnosticLocation 373d8c938b0f6b7a7156181be575239e4c6e15a2adbTed KremenekPathDiagnosticBuilder::getEnclosingStmtLocation(const Stmt *S) { 3749c378f705405d37f49795d5e915989de774fe11fTed Kremenek assert(S && "Null Stmt *passed to getEnclosingStmtLocation"); 3751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump ParentMap &P = getParentMap(); 3768966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek SourceManager &SMgr = getSourceManager(); 377e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek 378ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek while (IsNested(S, P)) { 3798c8b0ad9601d6ccf3d7b2a3f77a896ef4fb4e6e9Ted Kremenek const Stmt *Parent = P.getParentIgnoreParens(S); 3801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 381af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek if (!Parent) 382af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek break; 3831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 384af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek switch (Parent->getStmtClass()) { 3855fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek case Stmt::BinaryOperatorClass: { 3865fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek const BinaryOperator *B = cast<BinaryOperator>(Parent); 3875fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek if (B->isLogicalOp()) 388220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 3895fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek break; 3901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 391af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::CompoundStmtClass: 392af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::StmtExprClass: 393220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 3941d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek case Stmt::ChooseExprClass: 3951d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek // Similar to '?' if we are referring to condition, just have the edge 3961d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek // point to the entire choose expression. 3971d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek if (cast<ChooseExpr>(Parent)->getCond() == S) 398220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(Parent, SMgr, LC); 3991d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek else 400220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 40156ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall case Stmt::BinaryConditionalOperatorClass: 4021d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek case Stmt::ConditionalOperatorClass: 4031d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek // For '?', if we are referring to condition, just have the edge point 4041d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek // to the entire '?' expression. 40556ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall if (cast<AbstractConditionalOperator>(Parent)->getCond() == S) 406220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(Parent, SMgr, LC); 4071d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek else 408220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 409af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::DoStmtClass: 410220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 411af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::ForStmtClass: 412af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek if (cast<ForStmt>(Parent)->getBody() == S) 413220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 4141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump break; 415af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::IfStmtClass: 416af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek if (cast<IfStmt>(Parent)->getCond() != S) 417220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 4188bd4d037d837e7922c3661d6158229da58a03887Ted Kremenek break; 419af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::ObjCForCollectionStmtClass: 420af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek if (cast<ObjCForCollectionStmt>(Parent)->getBody() == S) 421220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 422af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek break; 423af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::WhileStmtClass: 424af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek if (cast<WhileStmt>(Parent)->getCond() != S) 425220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 426af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek break; 427af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek default: 428af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek break; 429af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek } 430af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek 431d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek S = Parent; 432d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek } 4331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 434d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek assert(S && "Cannot have null Stmt for PathDiagnosticLocation"); 435e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek 436e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek // Special case: DeclStmts can appear in for statement declarations, in which 437e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek // case the ForStmt is the context. 438e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek if (isa<DeclStmt>(S)) { 439e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek if (const Stmt *Parent = P.getParent(S)) { 440e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek switch (Parent->getStmtClass()) { 441e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek case Stmt::ForStmtClass: 442e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek case Stmt::ObjCForCollectionStmtClass: 443220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(Parent, SMgr, LC); 444e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek default: 445e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek break; 4461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 4471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 448e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek } 449e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek else if (isa<BinaryOperator>(S)) { 450e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek // Special case: the binary operator represents the initialization 451e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek // code in a for statement (this can happen when the variable being 452e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek // initialized is an old variable. 453e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek if (const ForStmt *FS = 454e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek dyn_cast_or_null<ForStmt>(P.getParentIgnoreParens(S))) { 455e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek if (FS->getInit() == S) 456220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(FS, SMgr, LC); 457e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek } 458e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek } 459e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek 460220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 461d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek} 462d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek 463cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 464d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose// "Visitors only" path diagnostic generation algorithm. 465d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose//===----------------------------------------------------------------------===// 466d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rosestatic bool GenerateVisitorsOnlyPathDiagnostic(PathDiagnostic &PD, 467d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose PathDiagnosticBuilder &PDB, 468d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose const ExplodedNode *N, 469d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose ArrayRef<BugReporterVisitor *> visitors) { 470d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // All path generation skips the very first node (the error node). 471d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // This is because there is special handling for the end-of-path note. 472d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose N = N->getFirstPred(); 473d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose if (!N) 474d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose return true; 475d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose 476d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose BugReport *R = PDB.getBugReport(); 477d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose while (const ExplodedNode *Pred = N->getFirstPred()) { 478d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose for (ArrayRef<BugReporterVisitor *>::iterator I = visitors.begin(), 479d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose E = visitors.end(); 480d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose I != E; ++I) { 481d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // Visit all the node pairs, but throw the path pieces away. 482d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose PathDiagnosticPiece *Piece = (*I)->VisitNode(N, Pred, PDB, *R); 483d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose delete Piece; 484d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose } 485d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose 486d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose N = Pred; 487d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose } 488d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose 489d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose return R->isValid(); 490d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose} 491d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose 492d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose//===----------------------------------------------------------------------===// 4933106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// "Minimal" path diagnostic generation algorithm. 494cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 49556a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zakstypedef std::pair<PathDiagnosticCallPiece*, const ExplodedNode*> StackDiagPair; 49656a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zakstypedef SmallVector<StackDiagPair, 6> StackDiagVector; 49756a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks 498368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaksstatic void updateStackPiecesWithMessage(PathDiagnosticPiece *P, 49956a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks StackDiagVector &CallStack) { 500368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks // If the piece contains a special message, add it to all the call 501368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks // pieces on the active stack. 502368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks if (PathDiagnosticEventPiece *ep = 503368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks dyn_cast<PathDiagnosticEventPiece>(P)) { 504368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks 50556a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks if (ep->hasCallStackHint()) 50656a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks for (StackDiagVector::iterator I = CallStack.begin(), 50756a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks E = CallStack.end(); I != E; ++I) { 50856a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks PathDiagnosticCallPiece *CP = I->first; 50956a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks const ExplodedNode *N = I->second; 5108fe4525680ce72e90cee3e58b5654e3ae955447fNAKAMURA Takumi std::string stackMsg = ep->getCallStackMessage(N); 51156a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks 512368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks // The last message on the path to final bug is the most important 513368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks // one. Since we traverse the path backwards, do not add the message 514368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks // if one has been previously added. 51556a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks if (!CP->hasCallStackMessage()) 51656a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks CP->setCallStackMessage(stackMsg); 51756a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks } 518368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks } 519368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks} 520cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 52177d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenekstatic void CompactPathDiagnostic(PathPieces &path, const SourceManager& SM); 52214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 5238347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rosestatic bool GenerateMinimalPathDiagnostic(PathDiagnostic& PD, 5243106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PathDiagnosticBuilder &PDB, 5253bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose const ExplodedNode *N, 526d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek LocationContextMap &LCM, 5273bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ArrayRef<BugReporterVisitor *> visitors) { 5288966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek 5293106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek SourceManager& SMgr = PDB.getSourceManager(); 53059950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek const LocationContext *LC = PDB.LC; 5319c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *NextNode = N->pred_empty() 5323106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek ? NULL : *(N->pred_begin()); 533368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks 53456a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks StackDiagVector CallStack; 535368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks 5363106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek while (NextNode) { 5371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump N = NextNode; 53859950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek PDB.LC = N->getLocationContext(); 5390f8579274a010f360a371b53101859d9d6052314Anna Zaks NextNode = N->getFirstPred(); 5401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 54161f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek ProgramPoint P = N->getLocation(); 54280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 54380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks do { 5447a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<CallExitEnd> CE = P.getAs<CallExitEnd>()) { 54580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticCallPiece *C = 54680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticCallPiece::construct(N, *CE, SMgr); 547d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek // Record the mapping from call piece to LocationContext. 548bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 54980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(C); 55080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.pushActivePath(&C->path); 55180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks CallStack.push_back(StackDiagPair(C, N)); 55280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 5539373937945e1e075dfa08169eaccc1ad0b31f699Anna Zaks } 554183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose 5557a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<CallEnter> CE = P.getAs<CallEnter>()) { 55680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Flush all locations, and pop the active path. 55780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks bool VisitedEntireCall = PD.isWithinCall(); 55880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.popActivePath(); 55980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 56080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Either we just added a bunch of stuff to the top-level path, or 56180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // we have a previous CallExitEnd. If the former, it means that the 56280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // path terminated within a function call. We must then take the 56380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // current contents of the active path and place it within 56480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // a new PathDiagnosticCallPiece. 56580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticCallPiece *C; 56680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (VisitedEntireCall) { 56780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks C = cast<PathDiagnosticCallPiece>(PD.getActivePath().front()); 56880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } else { 56980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const Decl *Caller = CE->getLocationContext()->getDecl(); 57080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks C = PathDiagnosticCallPiece::construct(PD.getActivePath(), Caller); 571d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek // Record the mapping from call piece to LocationContext. 572bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 57380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 57480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 57580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks C->setCallee(*CE, SMgr); 57680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (!CallStack.empty()) { 57780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks assert(CallStack.back().first == C); 57880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks CallStack.pop_back(); 57980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 58080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 581368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks } 5821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5837a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<BlockEdge> BE = P.getAs<BlockEdge>()) { 58480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const CFGBlock *Src = BE->getSrc(); 58580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const CFGBlock *Dst = BE->getDst(); 58680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const Stmt *T = Src->getTerminator(); 5871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 58880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (!T) 58980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 5901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 59180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticLocation Start = 59280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticLocation::createBegin(T, SMgr, 59380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks N->getLocationContext()); 5941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 59580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks switch (T->getStmtClass()) { 59661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek default: 59761f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek break; 5981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 59961f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek case Stmt::GotoStmtClass: 6001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump case Stmt::IndirectGotoStmtClass: { 6010f8579274a010f360a371b53101859d9d6052314Anna Zaks const Stmt *S = PathDiagnosticLocation::getNextStmt(N); 6021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 60361f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek if (!S) 60480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 6051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 606297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek std::string sbuf; 6071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump llvm::raw_string_ostream os(sbuf); 608d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek const PathDiagnosticLocation &End = PDB.getEnclosingStmtLocation(S); 6091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 61000605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek os << "Control jumps to line " 61180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks << End.asLocation().getExpansionLineNumber(); 61280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 61380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 61461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek break; 61561f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek } 6161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump case Stmt::SwitchStmtClass: { 61861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek // Figure out what case arm we took. 619297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek std::string sbuf; 620297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek llvm::raw_string_ostream os(sbuf); 6211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6229c378f705405d37f49795d5e915989de774fe11fTed Kremenek if (const Stmt *S = Dst->getLabel()) { 623220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation End(S, SMgr, LC); 6241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6255a429954aedd8a830a70fcea2cb51561673e4fc3Ted Kremenek switch (S->getStmtClass()) { 62680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks default: 62780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << "No cases match in the switch statement. " 62880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks "Control jumps to line " 62980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks << End.asLocation().getExpansionLineNumber(); 63080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 63180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks case Stmt::DefaultStmtClass: 63280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << "Control jumps to the 'default' case at line " 63380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks << End.asLocation().getExpansionLineNumber(); 63480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 63580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 63680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks case Stmt::CaseStmtClass: { 63780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << "Control jumps to 'case "; 63880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const CaseStmt *Case = cast<CaseStmt>(S); 63980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const Expr *LHS = Case->getLHS()->IgnoreParenCasts(); 64080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 64180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Determine if it is an enum. 64280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks bool GetRawInt = true; 64380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 64480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (const DeclRefExpr *DR = dyn_cast<DeclRefExpr>(LHS)) { 64580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // FIXME: Maybe this should be an assertion. Are there cases 64680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // were it is not an EnumConstantDecl? 64780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const EnumConstantDecl *D = 64803509aea098772644bf4662dc1c88634818ceeccZhongxing Xu dyn_cast<EnumConstantDecl>(DR->getDecl()); 6491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 65080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (D) { 65180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks GetRawInt = false; 65280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << *D; 6535a429954aedd8a830a70fcea2cb51561673e4fc3Ted Kremenek } 65480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 6559ec64d6e2fe575b297e1eaa5051efc2983373e25Eli Friedman 65680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (GetRawInt) 65780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << LHS->EvaluateKnownConstInt(PDB.getASTContext()); 6589ec64d6e2fe575b297e1eaa5051efc2983373e25Eli Friedman 65980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << ":' at line " 66080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks << End.asLocation().getExpansionLineNumber(); 66180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 66261f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek } 66380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 66480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 66580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 66661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek } 667567839273dfc395a459cbe77d5f8d128b9ae85bfTed Kremenek else { 668c3517ebb48a51e146badc08bc3684520c41da6c8Ted Kremenek os << "'Default' branch taken. "; 6691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const PathDiagnosticLocation &End = PDB.ExecutionContinues(os, N); 67080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 67180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 672567839273dfc395a459cbe77d5f8d128b9ae85bfTed Kremenek } 6731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 67461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek break; 67561f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek } 6761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6772673c9ff76ebdb72b7f846e2ff1e0f4256372e19Ted Kremenek case Stmt::BreakStmtClass: 6782673c9ff76ebdb72b7f846e2ff1e0f4256372e19Ted Kremenek case Stmt::ContinueStmtClass: { 679297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek std::string sbuf; 680297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek llvm::raw_string_ostream os(sbuf); 68100605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(os, N); 68280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 68380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 6842673c9ff76ebdb72b7f846e2ff1e0f4256372e19Ted Kremenek break; 6852673c9ff76ebdb72b7f846e2ff1e0f4256372e19Ted Kremenek } 6861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 68780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Determine control-flow for ternary '?'. 68856ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall case Stmt::BinaryConditionalOperatorClass: 689706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek case Stmt::ConditionalOperatorClass: { 690297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek std::string sbuf; 691297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek llvm::raw_string_ostream os(sbuf); 6921d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek os << "'?' condition is "; 6931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 694706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek if (*(Src->succ_begin()+1) == Dst) 695082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek os << "false"; 696706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek else 697082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek os << "true"; 6981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 69900605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 7001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7011d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek if (const Stmt *S = End.asStmt()) 7021d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek End = PDB.getEnclosingStmtLocation(S); 7031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 70480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 70580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 706babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek break; 707babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek } 7081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 70980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Determine control-flow for short-circuited '&&' and '||'. 710babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek case Stmt::BinaryOperatorClass: { 711babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek if (!PDB.supportsLogicalOpControlFlow()) 712babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek break; 7131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 71403509aea098772644bf4662dc1c88634818ceeccZhongxing Xu const BinaryOperator *B = cast<BinaryOperator>(T); 715babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek std::string sbuf; 716babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek llvm::raw_string_ostream os(sbuf); 717babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek os << "Left side of '"; 7181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7192de56d1d0c3a504ad1529de2677628bdfbb95cd4John McCall if (B->getOpcode() == BO_LAnd) { 720f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "&&" << "' is "; 7211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 722f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek if (*(Src->succ_begin()+1) == Dst) { 723f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "false"; 724220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation End(B->getLHS(), SMgr, LC); 7250cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PathDiagnosticLocation Start = 72680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticLocation::createOperatorLoc(B, SMgr); 72780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 72880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 7291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 730f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek else { 731f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "true"; 732220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Start(B->getLHS(), SMgr, LC); 733f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 73480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 73580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 7361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 737babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek } 738babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek else { 7392de56d1d0c3a504ad1529de2677628bdfbb95cd4John McCall assert(B->getOpcode() == BO_LOr); 740f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "||" << "' is "; 7411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 742f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek if (*(Src->succ_begin()+1) == Dst) { 743f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "false"; 744220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Start(B->getLHS(), SMgr, LC); 745f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 74680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 74780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 748f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek } 749f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek else { 750f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "true"; 751220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation End(B->getLHS(), SMgr, LC); 7520cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PathDiagnosticLocation Start = 75380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticLocation::createOperatorLoc(B, SMgr); 75480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 75580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 756f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek } 757babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek } 7581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 759706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek break; 760706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek } 7611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump case Stmt::DoStmtClass: { 763706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek if (*(Src->succ_begin()) == Dst) { 764297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek std::string sbuf; 765297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek llvm::raw_string_ostream os(sbuf); 7661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 767c3517ebb48a51e146badc08bc3684520c41da6c8Ted Kremenek os << "Loop condition is true. "; 768d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(os, N); 7691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 770d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek if (const Stmt *S = End.asStmt()) 771d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek End = PDB.getEnclosingStmtLocation(S); 7721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 77380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 77480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 775082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek } 776082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek else { 77700605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 7781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 779d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek if (const Stmt *S = End.asStmt()) 780d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek End = PDB.getEnclosingStmtLocation(S); 7811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 78280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 78380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, "Loop condition is false. Exiting loop")); 7843106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 7851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7863106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 7873106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 7881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7893106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek case Stmt::WhileStmtClass: 7901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump case Stmt::ForStmtClass: { 7913106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (*(Src->succ_begin()+1) == Dst) { 7923106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek std::string sbuf; 7933106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek llvm::raw_string_ostream os(sbuf); 7941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7953106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek os << "Loop condition is false. "; 7963106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(os, N); 7973106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (const Stmt *S = End.asStmt()) 7983106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek End = PDB.getEnclosingStmtLocation(S); 7991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 80080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 80180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 8023106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 8033106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek else { 8043106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 8053106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (const Stmt *S = End.asStmt()) 8063106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek End = PDB.getEnclosingStmtLocation(S); 8071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 80880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 80980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, "Loop condition is true. Entering loop body")); 8103106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 8111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8123106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 8133106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 8141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8153106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek case Stmt::IfStmtClass: { 8163106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 8171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8183106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (const Stmt *S = End.asStmt()) 8193106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek End = PDB.getEnclosingStmtLocation(S); 8201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8213106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (*(Src->succ_begin()+1) == Dst) 82280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 82380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, "Taking false branch")); 8241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 82580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 82680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, "Taking true branch")); 8271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8283106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 8293106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 83080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 8313106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 83280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } while(0); 8331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 834dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek if (NextNode) { 8358e6431adab313e283a992698f6fc7afe62420999Anna Zaks // Add diagnostic pieces from custom visitors. 8368e6431adab313e283a992698f6fc7afe62420999Anna Zaks BugReport *R = PDB.getBugReport(); 8373bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose for (ArrayRef<BugReporterVisitor *>::iterator I = visitors.begin(), 8383bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose E = visitors.end(); 8393bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose I != E; ++I) { 840368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks if (PathDiagnosticPiece *p = (*I)->VisitNode(N, NextNode, PDB, *R)) { 8412042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek PD.getActivePath().push_front(p); 842368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks updateStackPiecesWithMessage(p, CallStack); 843368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks } 844dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 8458966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 8463106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 8471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8488347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose if (!PDB.getBugReport()->isValid()) 8498347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose return false; 8508347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 85114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // After constructing the full PathDiagnostic, do a pass over it to compact 85214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // PathDiagnosticPieces that occur within a macro. 85377d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek CompactPathDiagnostic(PD.getMutablePieces(), PDB.getSourceManager()); 8548347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose return true; 8553106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 8563106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 8573106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 8585fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek// "Extensive" PathDiagnostic generation. 8595fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek//===----------------------------------------------------------------------===// 8605fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek 8615fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenekstatic bool IsControlFlowExpr(const Stmt *S) { 8625fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek const Expr *E = dyn_cast<Expr>(S); 8631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8645fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek if (!E) 8655fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek return false; 8661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump E = E->IgnoreParenCasts(); 8681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 86956ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall if (isa<AbstractConditionalOperator>(E)) 8705fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek return true; 8711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8725fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek if (const BinaryOperator *B = dyn_cast<BinaryOperator>(E)) 8735fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek if (B->isLogicalOp()) 8745fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek return true; 8751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return false; 8775fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek} 8785fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek 87914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremeneknamespace { 880ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass ContextLocation : public PathDiagnosticLocation { 8818f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek bool IsDead; 8828f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenekpublic: 8838f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek ContextLocation(const PathDiagnosticLocation &L, bool isdead = false) 8848f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek : PathDiagnosticLocation(L), IsDead(isdead) {} 8851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump void markDead() { IsDead = true; } 8878f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek bool isDead() const { return IsDead; } 8888f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek}; 8891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 890e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenekstatic PathDiagnosticLocation cleanUpLocation(PathDiagnosticLocation L, 891e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek const LocationContext *LC, 892e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek bool firstCharOnly = false) { 893e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek if (const Stmt *S = L.asStmt()) { 894e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek const Stmt *Original = S; 895e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek while (1) { 896e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek // Adjust the location for some expressions that are best referenced 897e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek // by one of their subexpressions. 898e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek switch (S->getStmtClass()) { 899e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek default: 900e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek break; 901e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::ParenExprClass: 902e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::GenericSelectionExprClass: 903e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek S = cast<Expr>(S)->IgnoreParens(); 904e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek firstCharOnly = true; 905e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek continue; 906e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::BinaryConditionalOperatorClass: 907e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::ConditionalOperatorClass: 908e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek S = cast<AbstractConditionalOperator>(S)->getCond(); 909e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek firstCharOnly = true; 910e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek continue; 911e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::ChooseExprClass: 912e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek S = cast<ChooseExpr>(S)->getCond(); 913e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek firstCharOnly = true; 914e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek continue; 915e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::BinaryOperatorClass: 916e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek S = cast<BinaryOperator>(S)->getLHS(); 917e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek firstCharOnly = true; 918e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek continue; 919e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek } 920e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek 921e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek break; 922e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek } 923e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek 924e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek if (S != Original) 925e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek L = PathDiagnosticLocation(S, L.getManager(), LC); 926e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek } 927e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek 928e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek if (firstCharOnly) 929e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek L = PathDiagnosticLocation::createSingleLocation(L); 930e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek 931e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek return L; 932e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek} 933e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek 934ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass EdgeBuilder { 9358f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek std::vector<ContextLocation> CLocs; 9368f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek typedef std::vector<ContextLocation>::iterator iterator; 93714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PathDiagnostic &PD; 93814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PathDiagnosticBuilder &PDB; 93914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PathDiagnosticLocation PrevLoc; 9401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9418f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek bool IsConsumedExpr(const PathDiagnosticLocation &L); 9421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 94314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek bool containsLocation(const PathDiagnosticLocation &Container, 94414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek const PathDiagnosticLocation &Containee); 9451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 94614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PathDiagnosticLocation getContextLocation(const PathDiagnosticLocation &L); 9471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 95014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek void popLocation() { 9518f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek if (!CLocs.back().isDead() && CLocs.back().asLocation().isFileID()) { 9525c7168cbe8a0eabd05e0e12e469090d2cabd27c0Ted Kremenek // For contexts, we only one the first character as the range. 953e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek rawAddEdge(cleanUpLocation(CLocs.back(), PDB.LC, true)); 9545c7168cbe8a0eabd05e0e12e469090d2cabd27c0Ted Kremenek } 95514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek CLocs.pop_back(); 95614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 9571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 95814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenekpublic: 95914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek EdgeBuilder(PathDiagnostic &pd, PathDiagnosticBuilder &pdb) 96014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek : PD(pd), PDB(pdb) { 9611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 962a301a6773db085575ac51e3c966858180390c25bTed Kremenek // If the PathDiagnostic already has pieces, add the enclosing statement 963a301a6773db085575ac51e3c966858180390c25bTed Kremenek // of the first piece as a context as well. 964802e02463b880f53a6e645bde78cc412481ce9e0Ted Kremenek if (!PD.path.empty()) { 965ed866e73bab7733f5226f84c52edefe23d694b2fTed Kremenek PrevLoc = (*PD.path.begin())->getLocation(); 9661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 96714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (const Stmt *S = PrevLoc.asStmt()) 968e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek addExtendedContext(PDB.getEnclosingStmtLocation(S).asStmt()); 96914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 97014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 97114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 97214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek ~EdgeBuilder() { 97314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek while (!CLocs.empty()) popLocation(); 9740cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks 975a301a6773db085575ac51e3c966858180390c25bTed Kremenek // Finally, add an initial edge from the start location of the first 976a301a6773db085575ac51e3c966858180390c25bTed Kremenek // statement (if it doesn't already exist). 9770cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PathDiagnosticLocation L = PathDiagnosticLocation::createDeclBegin( 97859950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek PDB.LC, 9790cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PDB.getSourceManager()); 9800cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks if (L.isValid()) 9810cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks rawAddEdge(L); 98214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 98314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 9845de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek void flushLocations() { 9855de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek while (!CLocs.empty()) 9865de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek popLocation(); 9875de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek PrevLoc = PathDiagnosticLocation(); 9885de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek } 9895de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek 9903ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose void addEdge(PathDiagnosticLocation NewLoc, bool alwaysAdd = false, 9913ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose bool IsPostJump = false); 9921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9938bd4d037d837e7922c3661d6158229da58a03887Ted Kremenek void rawAddEdge(PathDiagnosticLocation NewLoc); 9941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 99514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek void addContext(const Stmt *S); 996183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose void addContext(const PathDiagnosticLocation &L); 997e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek void addExtendedContext(const Stmt *S); 9981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump}; 99914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} // end anonymous namespace 100014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 100114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 100214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted KremenekPathDiagnosticLocation 100314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted KremenekEdgeBuilder::getContextLocation(const PathDiagnosticLocation &L) { 100414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (const Stmt *S = L.asStmt()) { 100514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (IsControlFlowExpr(S)) 100614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return L; 10071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return PDB.getEnclosingStmtLocation(S); 100914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 10101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 101114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return L; 101214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 101314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 101414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenekbool EdgeBuilder::containsLocation(const PathDiagnosticLocation &Container, 101514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek const PathDiagnosticLocation &Containee) { 101614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 101714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (Container == Containee) 101814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return true; 10191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 102014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (Container.asDecl()) 102114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return true; 10221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 102314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (const Stmt *S = Containee.asStmt()) 102414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (const Stmt *ContainerS = Container.asStmt()) { 102514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek while (S) { 102614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (S == ContainerS) 102714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return true; 102814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek S = PDB.getParent(S); 102914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 103014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return false; 103114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 103214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 103314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // Less accurate: compare using source ranges. 103414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek SourceRange ContainerR = Container.asRange(); 103514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek SourceRange ContaineeR = Containee.asRange(); 10361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 103714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek SourceManager &SM = PDB.getSourceManager(); 1038402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SourceLocation ContainerRBeg = SM.getExpansionLoc(ContainerR.getBegin()); 1039402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SourceLocation ContainerREnd = SM.getExpansionLoc(ContainerR.getEnd()); 1040402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SourceLocation ContaineeRBeg = SM.getExpansionLoc(ContaineeR.getBegin()); 1041402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SourceLocation ContaineeREnd = SM.getExpansionLoc(ContaineeR.getEnd()); 10421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1043642116259e8df6286063a17361c20e95b5017a0aChandler Carruth unsigned ContainerBegLine = SM.getExpansionLineNumber(ContainerRBeg); 1044642116259e8df6286063a17361c20e95b5017a0aChandler Carruth unsigned ContainerEndLine = SM.getExpansionLineNumber(ContainerREnd); 1045642116259e8df6286063a17361c20e95b5017a0aChandler Carruth unsigned ContaineeBegLine = SM.getExpansionLineNumber(ContaineeRBeg); 1046642116259e8df6286063a17361c20e95b5017a0aChandler Carruth unsigned ContaineeEndLine = SM.getExpansionLineNumber(ContaineeREnd); 10471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 104814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek assert(ContainerBegLine <= ContainerEndLine); 10491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert(ContaineeBegLine <= ContaineeEndLine); 10501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 105114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return (ContainerBegLine <= ContaineeBegLine && 105214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek ContainerEndLine >= ContaineeEndLine && 105314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek (ContainerBegLine != ContaineeBegLine || 1054a77c031cb66f75d22672070052cc6e0205289ff8Chandler Carruth SM.getExpansionColumnNumber(ContainerRBeg) <= 1055a77c031cb66f75d22672070052cc6e0205289ff8Chandler Carruth SM.getExpansionColumnNumber(ContaineeRBeg)) && 105614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek (ContainerEndLine != ContaineeEndLine || 1057a77c031cb66f75d22672070052cc6e0205289ff8Chandler Carruth SM.getExpansionColumnNumber(ContainerREnd) >= 10586488dc31153be6f98b404c7860be6c66bb4ec917Ted Kremenek SM.getExpansionColumnNumber(ContaineeREnd))); 105914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 106014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 106114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenekvoid EdgeBuilder::rawAddEdge(PathDiagnosticLocation NewLoc) { 106214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (!PrevLoc.isValid()) { 106314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PrevLoc = NewLoc; 106414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 106514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 10661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1067e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek const PathDiagnosticLocation &NewLocClean = cleanUpLocation(NewLoc, PDB.LC); 1068e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek const PathDiagnosticLocation &PrevLocClean = cleanUpLocation(PrevLoc, PDB.LC); 10691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1070a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek if (PrevLocClean.asLocation().isInvalid()) { 1071a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek PrevLoc = NewLoc; 1072a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek return; 1073a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek } 1074a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek 10758c8b0ad9601d6ccf3d7b2a3f77a896ef4fb4e6e9Ted Kremenek if (NewLocClean.asLocation() == PrevLocClean.asLocation()) 107614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 10771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 107814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // FIXME: Ignore intra-macro edges for now. 1079402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth if (NewLocClean.asLocation().getExpansionLoc() == 1080402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth PrevLocClean.asLocation().getExpansionLoc()) 108114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 108214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 10832042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece(NewLocClean, PrevLocClean)); 10848c8b0ad9601d6ccf3d7b2a3f77a896ef4fb4e6e9Ted Kremenek PrevLoc = NewLoc; 108514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 108614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 10873ea09a802f973c2726b2a489ae08a4bded93410bJordan Rosevoid EdgeBuilder::addEdge(PathDiagnosticLocation NewLoc, bool alwaysAdd, 10883ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose bool IsPostJump) { 10891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1090a301a6773db085575ac51e3c966858180390c25bTed Kremenek if (!alwaysAdd && NewLoc.asLocation().isMacroID()) 1091a301a6773db085575ac51e3c966858180390c25bTed Kremenek return; 10921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 109314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek const PathDiagnosticLocation &CLoc = getContextLocation(NewLoc); 109414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 109514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek while (!CLocs.empty()) { 10968f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek ContextLocation &TopContextLoc = CLocs.back(); 10971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 109814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // Is the top location context the same as the one for the new location? 109914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (TopContextLoc == CLoc) { 11008f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek if (alwaysAdd) { 11013ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose if (IsConsumedExpr(TopContextLoc)) 11023ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose TopContextLoc.markDead(); 11038f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek 110414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek rawAddEdge(NewLoc); 11058f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek } 110614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 11073ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose if (IsPostJump) 11083ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose TopContextLoc.markDead(); 110914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 111014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 111114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 111214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (containsLocation(TopContextLoc, CLoc)) { 11138f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek if (alwaysAdd) { 111414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek rawAddEdge(NewLoc); 11151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11163ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose if (IsConsumedExpr(CLoc)) { 11173ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose CLocs.push_back(ContextLocation(CLoc, /*IsDead=*/true)); 11188f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek return; 11198f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek } 11208f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek } 11211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11223ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose CLocs.push_back(ContextLocation(CLoc, /*IsDead=*/IsPostJump)); 11231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return; 112414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 112514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 112614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // Context does not contain the location. Flush it. 112714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek popLocation(); 112814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 11291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11305c7168cbe8a0eabd05e0e12e469090d2cabd27c0Ted Kremenek // If we reach here, there is no enclosing context. Just add the edge. 11315c7168cbe8a0eabd05e0e12e469090d2cabd27c0Ted Kremenek rawAddEdge(NewLoc); 113214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 113314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 11348f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenekbool EdgeBuilder::IsConsumedExpr(const PathDiagnosticLocation &L) { 11358f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek if (const Expr *X = dyn_cast_or_null<Expr>(L.asStmt())) 11368f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek return PDB.getParentMap().isConsumedExpr(X) && !IsControlFlowExpr(X); 11371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11388f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek return false; 11398f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek} 11401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1141e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenekvoid EdgeBuilder::addExtendedContext(const Stmt *S) { 1142e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek if (!S) 1143e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek return; 11441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const Stmt *Parent = PDB.getParent(S); 1146e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek while (Parent) { 1147e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek if (isa<CompoundStmt>(Parent)) 1148e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek Parent = PDB.getParent(Parent); 1149e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek else 1150e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek break; 1151e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek } 1152e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek 1153e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek if (Parent) { 1154e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek switch (Parent->getStmtClass()) { 1155e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek case Stmt::DoStmtClass: 1156e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek case Stmt::ObjCAtSynchronizedStmtClass: 1157e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek addContext(Parent); 1158e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek default: 1159e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek break; 1160e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek } 1161e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek } 11621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1163e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek addContext(S); 1164e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek} 11651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 116614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenekvoid EdgeBuilder::addContext(const Stmt *S) { 116714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (!S) 116814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 116914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 117059950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek PathDiagnosticLocation L(S, PDB.getSourceManager(), PDB.LC); 1171183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose addContext(L); 1172183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose} 11731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1174183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rosevoid EdgeBuilder::addContext(const PathDiagnosticLocation &L) { 117514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek while (!CLocs.empty()) { 117614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek const PathDiagnosticLocation &TopContextLoc = CLocs.back(); 117714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 117814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // Is the top location context the same as the one for the new location? 117914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (TopContextLoc == L) 118014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 118114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 118214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (containsLocation(TopContextLoc, L)) { 118314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek CLocs.push_back(L); 11841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return; 118514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 118614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 118714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // Context does not contain the location. Flush it. 118814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek popLocation(); 118914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 119014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 119114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek CLocs.push_back(L); 119214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 119314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 119411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// Cone-of-influence: support the reverse propagation of "interesting" symbols 119511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// and values by tracing interesting calculations backwards through evaluated 119611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// expressions along a path. This is probably overly complicated, but the idea 119711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// is that if an expression computed an "interesting" value, the child 119811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// expressions are are also likely to be "interesting" as well (which then 119911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// propagates to the values they in turn compute). This reverse propagation 120011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// is needed to track interesting correlations across function call boundaries, 120111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// where formal arguments bind to actual arguments, etc. This is also needed 120211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// because the constraint solver sometimes simplifies certain symbolic values 120311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// into constants when appropriate, and this complicates reasoning about 120411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// interesting values. 120511abcecc8c919673237cf37384290a1ef1943976Ted Kremenektypedef llvm::DenseSet<const Expr *> InterestingExprs; 120611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek 120711abcecc8c919673237cf37384290a1ef1943976Ted Kremenekstatic void reversePropagateIntererstingSymbols(BugReport &R, 120811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek InterestingExprs &IE, 120911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const ProgramState *State, 121011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const Expr *Ex, 121111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const LocationContext *LCtx) { 121211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek SVal V = State->getSVal(Ex, LCtx); 121311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (!(R.isInteresting(V) || IE.count(Ex))) 121411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek return; 121511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek 121611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek switch (Ex->getStmtClass()) { 121711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek default: 121811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (!isa<CastExpr>(Ex)) 121911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek break; 122011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek // Fall through. 122111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek case Stmt::BinaryOperatorClass: 122211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek case Stmt::UnaryOperatorClass: { 122311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek for (Stmt::const_child_iterator CI = Ex->child_begin(), 122411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek CE = Ex->child_end(); 122511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek CI != CE; ++CI) { 122611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (const Expr *child = dyn_cast_or_null<Expr>(*CI)) { 122711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek IE.insert(child); 122811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek SVal ChildV = State->getSVal(child, LCtx); 122911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek R.markInteresting(ChildV); 123011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 123111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek break; 123211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 123311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 123411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 123511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek 123611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek R.markInteresting(V); 123711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek} 123811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek 123911abcecc8c919673237cf37384290a1ef1943976Ted Kremenekstatic void reversePropagateInterestingSymbols(BugReport &R, 124011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek InterestingExprs &IE, 124111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const ProgramState *State, 124211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const LocationContext *CalleeCtx, 124311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const LocationContext *CallerCtx) 124411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek{ 1245852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // FIXME: Handle non-CallExpr-based CallEvents. 124611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const StackFrameContext *Callee = CalleeCtx->getCurrentStackFrame(); 124711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const Stmt *CallSite = Callee->getCallSite(); 1248852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (const CallExpr *CE = dyn_cast_or_null<CallExpr>(CallSite)) { 124911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(CalleeCtx->getDecl())) { 125011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek FunctionDecl::param_const_iterator PI = FD->param_begin(), 125111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek PE = FD->param_end(); 125211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek CallExpr::const_arg_iterator AI = CE->arg_begin(), AE = CE->arg_end(); 125311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek for (; AI != AE && PI != PE; ++AI, ++PI) { 125411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (const Expr *ArgE = *AI) { 125511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (const ParmVarDecl *PD = *PI) { 125611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek Loc LV = State->getLValue(PD, CalleeCtx); 125711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (R.isInteresting(LV) || R.isInteresting(State->getRawSVal(LV))) 125811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek IE.insert(ArgE); 125911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 126011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 126111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 126211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 126311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 126411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek} 12658185674528423e2504a1fae35c28c24104846510Ted Kremenek 1266b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek//===----------------------------------------------------------------------===// 1267b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek// Functions for determining if a loop was executed 0 times. 1268b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek//===----------------------------------------------------------------------===// 1269b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 1270b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenekstatic bool isLoop(const Stmt *Term) { 12718185674528423e2504a1fae35c28c24104846510Ted Kremenek switch (Term->getStmtClass()) { 12728185674528423e2504a1fae35c28c24104846510Ted Kremenek case Stmt::ForStmtClass: 12738185674528423e2504a1fae35c28c24104846510Ted Kremenek case Stmt::WhileStmtClass: 1274c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek case Stmt::ObjCForCollectionStmtClass: 1275b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek return true; 12768185674528423e2504a1fae35c28c24104846510Ted Kremenek default: 12778185674528423e2504a1fae35c28c24104846510Ted Kremenek // Note that we intentionally do not include do..while here. 12788185674528423e2504a1fae35c28c24104846510Ted Kremenek return false; 12798185674528423e2504a1fae35c28c24104846510Ted Kremenek } 1280b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek} 12818185674528423e2504a1fae35c28c24104846510Ted Kremenek 1282b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenekstatic bool isJumpToFalseBranch(const BlockEdge *BE) { 12838185674528423e2504a1fae35c28c24104846510Ted Kremenek const CFGBlock *Src = BE->getSrc(); 12848185674528423e2504a1fae35c28c24104846510Ted Kremenek assert(Src->succ_size() == 2); 12858185674528423e2504a1fae35c28c24104846510Ted Kremenek return (*(Src->succ_begin()+1) == BE->getDst()); 12868185674528423e2504a1fae35c28c24104846510Ted Kremenek} 12878185674528423e2504a1fae35c28c24104846510Ted Kremenek 1288b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek/// Return true if the terminator is a loop and the destination is the 1289b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek/// false branch. 1290b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenekstatic bool isLoopJumpPastBody(const Stmt *Term, const BlockEdge *BE) { 1291b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek if (!isLoop(Term)) 1292b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek return false; 1293b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1294b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek // Did we take the false branch? 1295b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek return isJumpToFalseBranch(BE); 1296b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek} 1297b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1298b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenekstatic bool isContainedByStmt(ParentMap &PM, const Stmt *S, const Stmt *SubS) { 1299b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek while (SubS) { 1300b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek if (SubS == S) 1301b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return true; 1302b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek SubS = PM.getParent(SubS); 1303b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek } 1304b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return false; 1305b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek} 1306b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 1307b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenekstatic const Stmt *getStmtBeforeCond(ParentMap &PM, const Stmt *Term, 1308b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek const ExplodedNode *N) { 1309b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek while (N) { 1310b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek Optional<StmtPoint> SP = N->getLocation().getAs<StmtPoint>(); 1311b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek if (SP) { 1312b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek const Stmt *S = SP->getStmt(); 1313b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek if (!isContainedByStmt(PM, Term, S)) 1314b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return S; 1315b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek } 13160f8579274a010f360a371b53101859d9d6052314Anna Zaks N = N->getFirstPred(); 1317b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek } 1318b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return 0; 1319b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek} 1320b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 1321b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenekstatic bool isInLoopBody(ParentMap &PM, const Stmt *S, const Stmt *Term) { 1322b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek const Stmt *LoopBody = 0; 1323b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek switch (Term->getStmtClass()) { 1324b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek case Stmt::ForStmtClass: { 1325b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek const ForStmt *FS = cast<ForStmt>(Term); 1326b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek if (isContainedByStmt(PM, FS->getInc(), S)) 1327b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return true; 1328b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek LoopBody = FS->getBody(); 1329b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek break; 1330b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek } 1331c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek case Stmt::ObjCForCollectionStmtClass: { 1332c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek const ObjCForCollectionStmt *FC = cast<ObjCForCollectionStmt>(Term); 1333c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek LoopBody = FC->getBody(); 1334c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek break; 1335c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek } 1336b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek case Stmt::WhileStmtClass: 1337b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek LoopBody = cast<WhileStmt>(Term)->getBody(); 1338b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek break; 1339b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek default: 1340b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return false; 1341b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek } 1342b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return isContainedByStmt(PM, LoopBody, S); 1343b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek} 1344b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 1345b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek//===----------------------------------------------------------------------===// 1346b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek// Top-level logic for generating extensive path diagnostics. 1347b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek//===----------------------------------------------------------------------===// 1348b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 13498347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rosestatic bool GenerateExtensivePathDiagnostic(PathDiagnostic& PD, 135014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PathDiagnosticBuilder &PDB, 13513bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose const ExplodedNode *N, 1352d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek LocationContextMap &LCM, 13533bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ArrayRef<BugReporterVisitor *> visitors) { 135414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek EdgeBuilder EB(PD, PDB); 13550cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks const SourceManager& SM = PDB.getSourceManager(); 135656a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks StackDiagVector CallStack; 135711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek InterestingExprs IE; 135814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 13599c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *NextNode = N->pred_empty() ? NULL : *(N->pred_begin()); 136014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek while (NextNode) { 136114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek N = NextNode; 13620f8579274a010f360a371b53101859d9d6052314Anna Zaks NextNode = N->getFirstPred(); 136314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek ProgramPoint P = N->getLocation(); 136414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 1365dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek do { 13667a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<PostStmt> PS = P.getAs<PostStmt>()) { 136711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (const Expr *Ex = PS->getStmtAs<Expr>()) 136811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek reversePropagateIntererstingSymbols(*PDB.getBugReport(), IE, 136911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek N->getState().getPtr(), Ex, 137011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek N->getLocationContext()); 137111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 137211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek 13737a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<CallExitEnd> CE = P.getAs<CallExitEnd>()) { 1374183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose const Stmt *S = CE->getCalleeContext()->getCallSite(); 1375183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose if (const Expr *Ex = dyn_cast_or_null<Expr>(S)) { 1376852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose reversePropagateIntererstingSymbols(*PDB.getBugReport(), IE, 1377852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose N->getState().getPtr(), Ex, 1378852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose N->getLocationContext()); 1379852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose } 1380183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose 1381183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose PathDiagnosticCallPiece *C = 1382183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose PathDiagnosticCallPiece::construct(N, *CE, SM); 1383bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 1384183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose 13853ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose EB.addEdge(C->callReturn, /*AlwaysAdd=*/true, /*IsPostJump=*/true); 1386183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose EB.flushLocations(); 1387183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose 1388183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose PD.getActivePath().push_front(C); 1389183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose PD.pushActivePath(&C->path); 1390183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose CallStack.push_back(StackDiagPair(C, N)); 13915de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek break; 13925de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek } 13934ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek 13942042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek // Pop the call hierarchy if we are done walking the contents 13952042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek // of a function call. 13967a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<CallEnter> CE = P.getAs<CallEnter>()) { 1397097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek // Add an edge to the start of the function. 1398097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek const Decl *D = CE->getCalleeContext()->getDecl(); 1399097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek PathDiagnosticLocation pos = 1400097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek PathDiagnosticLocation::createBegin(D, SM); 1401097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek EB.addEdge(pos); 1402097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek 1403097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek // Flush all locations, and pop the active path. 1404183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose bool VisitedEntireCall = PD.isWithinCall(); 14054ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek EB.flushLocations(); 14062042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek PD.popActivePath(); 14074ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek PDB.LC = N->getLocationContext(); 1408097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek 1409183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose // Either we just added a bunch of stuff to the top-level path, or 1410183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose // we have a previous CallExitEnd. If the former, it means that the 14112042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek // path terminated within a function call. We must then take the 14122042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek // current contents of the active path and place it within 14132042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek // a new PathDiagnosticCallPiece. 1414183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose PathDiagnosticCallPiece *C; 1415183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose if (VisitedEntireCall) { 1416183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose C = cast<PathDiagnosticCallPiece>(PD.getActivePath().front()); 1417183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose } else { 1418183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose const Decl *Caller = CE->getLocationContext()->getDecl(); 14199373937945e1e075dfa08169eaccc1ad0b31f699Anna Zaks C = PathDiagnosticCallPiece::construct(PD.getActivePath(), Caller); 1420bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 14219373937945e1e075dfa08169eaccc1ad0b31f699Anna Zaks } 1422852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose 1423183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose C->setCallee(*CE, SM); 1424183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose EB.addContext(C->getLocation()); 1425368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks 1426368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks if (!CallStack.empty()) { 142756a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks assert(CallStack.back().first == C); 1428368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks CallStack.pop_back(); 1429368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks } 14302042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek break; 14312042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek } 14324ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek 14334ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek // Note that is important that we update the LocationContext 14344ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek // after looking at CallExits. CallExit basically adds an 14354ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek // edge in the *caller*, so we don't want to update the LocationContext 14364ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek // too soon. 14374ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek PDB.LC = N->getLocationContext(); 14385de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek 1439dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek // Block edges. 14407a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<BlockEdge> BE = P.getAs<BlockEdge>()) { 144111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek // Does this represent entering a call? If so, look at propagating 144211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek // interesting symbols across call boundaries. 144311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (NextNode) { 144411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const LocationContext *CallerCtx = NextNode->getLocationContext(); 144511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const LocationContext *CalleeCtx = PDB.LC; 144611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (CallerCtx != CalleeCtx) { 144711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek reversePropagateInterestingSymbols(*PDB.getBugReport(), IE, 144811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek N->getState().getPtr(), 144911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek CalleeCtx, CallerCtx); 145011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 145111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 145211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek 1453dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek // Are we jumping to the head of a loop? Add a special diagnostic. 1454f57a2aa02c0578c5bd834fec0d44c16ad9908620Ted Kremenek if (const Stmt *Loop = BE->getSrc()->getLoopTarget()) { 145559950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek PathDiagnosticLocation L(Loop, SM, PDB.LC); 1456ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek const CompoundStmt *CS = NULL; 14571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1458f57a2aa02c0578c5bd834fec0d44c16ad9908620Ted Kremenek if (const ForStmt *FS = dyn_cast<ForStmt>(Loop)) 1459f57a2aa02c0578c5bd834fec0d44c16ad9908620Ted Kremenek CS = dyn_cast<CompoundStmt>(FS->getBody()); 1460f57a2aa02c0578c5bd834fec0d44c16ad9908620Ted Kremenek else if (const WhileStmt *WS = dyn_cast<WhileStmt>(Loop)) 1461f57a2aa02c0578c5bd834fec0d44c16ad9908620Ted Kremenek CS = dyn_cast<CompoundStmt>(WS->getBody()); 14621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1463dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek PathDiagnosticEventPiece *p = 1464dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek new PathDiagnosticEventPiece(L, 146507c015cbcee31f72e2d320ba2c713c046bed42faTed Kremenek "Looping back to the head of the loop"); 14662dd17abf11ae64339fa6bfaa57d76e13a5fbe5b8Ted Kremenek p->setPrunable(true); 14671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1468dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek EB.addEdge(p->getLocation(), true); 14692042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek PD.getActivePath().push_front(p); 14701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1471ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek if (CS) { 14720cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PathDiagnosticLocation BL = 14730cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PathDiagnosticLocation::createEndBrace(CS, SM); 147407c015cbcee31f72e2d320ba2c713c046bed42faTed Kremenek EB.addEdge(BL); 1475dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 14768bd4d037d837e7922c3661d6158229da58a03887Ted Kremenek } 14778185674528423e2504a1fae35c28c24104846510Ted Kremenek 1478b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek const CFGBlock *BSrc = BE->getSrc(); 1479b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek ParentMap &PM = PDB.getParentMap(); 1480b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 1481b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek if (const Stmt *Term = BSrc->getTerminator()) { 14828185674528423e2504a1fae35c28c24104846510Ted Kremenek // Are we jumping past the loop body without ever executing the 14838185674528423e2504a1fae35c28c24104846510Ted Kremenek // loop (because the condition was false)? 14847a95de68c093991047ed8d339479ccad51b88663David Blaikie if (isLoopJumpPastBody(Term, &*BE) && 1485b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek !isInLoopBody(PM, 1486b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek getStmtBeforeCond(PM, 1487b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek BSrc->getTerminatorCondition(), 1488b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek N), 1489b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek Term)) { 14908185674528423e2504a1fae35c28c24104846510Ted Kremenek PathDiagnosticLocation L(Term, SM, PDB.LC); 14918185674528423e2504a1fae35c28c24104846510Ted Kremenek PathDiagnosticEventPiece *PE = 1492b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek new PathDiagnosticEventPiece(L, "Loop body executed 0 times"); 14938185674528423e2504a1fae35c28c24104846510Ted Kremenek PE->setPrunable(true); 14948185674528423e2504a1fae35c28c24104846510Ted Kremenek 14958185674528423e2504a1fae35c28c24104846510Ted Kremenek EB.addEdge(PE->getLocation(), true); 14968185674528423e2504a1fae35c28c24104846510Ted Kremenek PD.getActivePath().push_front(PE); 14978185674528423e2504a1fae35c28c24104846510Ted Kremenek } 14988185674528423e2504a1fae35c28c24104846510Ted Kremenek 1499b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek // In any case, add the terminator as the current statement 1500b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek // context for control edges. 1501ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek EB.addContext(Term); 15028185674528423e2504a1fae35c28c24104846510Ted Kremenek } 15031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1504dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek break; 15058bd4d037d837e7922c3661d6158229da58a03887Ted Kremenek } 150614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 15077a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<BlockEntrance> BE = P.getAs<BlockEntrance>()) { 1508b07805485c603be3d8011f72611465324c9e664bDavid Blaikie Optional<CFGElement> First = BE->getFirstElement(); 1509b07805485c603be3d8011f72611465324c9e664bDavid Blaikie if (Optional<CFGStmt> S = First ? First->getAs<CFGStmt>() : None) { 1510b07805485c603be3d8011f72611465324c9e664bDavid Blaikie const Stmt *stmt = S->getStmt(); 15113c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek if (IsControlFlowExpr(stmt)) { 1512b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu // Add the proper context for '&&', '||', and '?'. 15133c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek EB.addContext(stmt); 1514b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu } 1515b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu else 15163c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek EB.addExtendedContext(PDB.getEnclosingStmtLocation(stmt).asStmt()); 1517dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 1518b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu 1519dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek break; 1520dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 15215de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek 15225de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek 1523dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } while (0); 15241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1525dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek if (!NextNode) 152614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek continue; 15271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15288e6431adab313e283a992698f6fc7afe62420999Anna Zaks // Add pieces from custom visitors. 15298e6431adab313e283a992698f6fc7afe62420999Anna Zaks BugReport *R = PDB.getBugReport(); 15303bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose for (ArrayRef<BugReporterVisitor *>::iterator I = visitors.begin(), 15313bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose E = visitors.end(); 15323bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose I != E; ++I) { 15338e6431adab313e283a992698f6fc7afe62420999Anna Zaks if (PathDiagnosticPiece *p = (*I)->VisitNode(N, NextNode, PDB, *R)) { 15348966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek const PathDiagnosticLocation &Loc = p->getLocation(); 15358966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek EB.addEdge(Loc, true); 15362042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek PD.getActivePath().push_front(p); 1537368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks updateStackPiecesWithMessage(p, CallStack); 1538368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks 15398966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek if (const Stmt *S = Loc.asStmt()) 15401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump EB.addExtendedContext(PDB.getEnclosingStmtLocation(S).asStmt()); 15418966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 15421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 154314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 15448347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 15458347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose return PDB.getBugReport()->isValid(); 154614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 154714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 1548af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek/// \brief Adds a sanitized control-flow diagnostic edge to a path. 1549af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenekstatic void addEdgeToPath(PathPieces &path, 1550af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticLocation &PrevLoc, 1551af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticLocation NewLoc, 1552af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const LocationContext *LC) { 1553bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (!NewLoc.isValid()) 1554af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek return; 1555af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1556bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek SourceLocation NewLocL = NewLoc.asLocation(); 1557bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (NewLocL.isInvalid() || NewLocL.isMacroID()) 1558af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek return; 1559af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1560bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (!PrevLoc.isValid()) { 1561af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PrevLoc = NewLoc; 1562af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek return; 1563af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1564af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1565af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // FIXME: ignore intra-macro edges for now. 1566bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (NewLoc.asLocation().getExpansionLoc() == 1567bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek PrevLoc.asLocation().getExpansionLoc()) 1568af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek return; 1569af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1570bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek path.push_front(new PathDiagnosticControlFlowPiece(NewLoc, 1571bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek PrevLoc)); 1572af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PrevLoc = NewLoc; 1573af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek} 1574af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1575e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek/// A customized wrapper for CFGBlock::getTerminatorCondition() 1576e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek/// which returns the element for ObjCForCollectionStmts. 1577e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenekstatic const Stmt *getTerminatorCondition(const CFGBlock *B) { 1578e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek const Stmt *S = B->getTerminatorCondition(); 1579e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek if (const ObjCForCollectionStmt *FS = 1580e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek dyn_cast_or_null<ObjCForCollectionStmt>(S)) 1581e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek return FS->getElement(); 1582e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek return S; 1583e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek} 1584e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek 1585af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenekstatic bool 1586af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted KremenekGenerateAlternateExtensivePathDiagnostic(PathDiagnostic& PD, 1587af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticBuilder &PDB, 1588af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const ExplodedNode *N, 1589af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek LocationContextMap &LCM, 1590af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek ArrayRef<BugReporterVisitor *> visitors) { 1591af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1592af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek BugReport *report = PDB.getBugReport(); 1593af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const SourceManager& SM = PDB.getSourceManager(); 1594af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek StackDiagVector CallStack; 1595af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek InterestingExprs IE; 1596af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 15975a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose PathDiagnosticLocation PrevLoc = PD.getLocation(); 1598af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1599af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const ExplodedNode *NextNode = N->getFirstPred(); 1600af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek while (NextNode) { 1601af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek N = NextNode; 1602af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek NextNode = N->getFirstPred(); 1603af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek ProgramPoint P = N->getLocation(); 1604af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1605af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek do { 1606be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Have we encountered an entrance to a call? It may be 1607be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // the case that we have not encountered a matching 1608be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // call exit before this point. This means that the path 1609be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // terminated within the call itself. 1610be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek if (Optional<CallEnter> CE = P.getAs<CallEnter>()) { 1611be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Did we visit an entire call? 1612be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek bool VisitedEntireCall = PD.isWithinCall(); 1613be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PD.popActivePath(); 1614be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1615be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PathDiagnosticCallPiece *C; 1616be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek if (VisitedEntireCall) { 1617be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PathDiagnosticPiece *P = PD.getActivePath().front().getPtr(); 1618be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek C = cast<PathDiagnosticCallPiece>(P); 1619be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek } else { 1620be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek const Decl *Caller = CE->getLocationContext()->getDecl(); 1621be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek C = PathDiagnosticCallPiece::construct(PD.getActivePath(), Caller); 1622be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1623be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Since we just transferred the path over to the call piece, 1624be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // reset the mapping from active to location context. 1625be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek assert(PD.getActivePath().size() == 1 && 1626be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PD.getActivePath().front() == C); 1627be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek LCM[&PD.getActivePath()] = 0; 1628be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1629be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Record the location context mapping for the path within 1630be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // the call. 1631be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek assert(LCM[&C->path] == 0 || 1632be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek LCM[&C->path] == CE->getCalleeContext()); 1633be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 1634be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1635be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // If this is the first item in the active path, record 1636be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // the new mapping from active path to location context. 1637be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek const LocationContext *&NewLC = LCM[&PD.getActivePath()]; 16385a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose if (!NewLC) 1639be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek NewLC = N->getLocationContext(); 1640be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 16415a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose PDB.LC = NewLC; 1642be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek } 1643be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek C->setCallee(*CE, SM); 1644be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 16455a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose // Update the previous location in the active path. 16465a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose PrevLoc = C->getLocation(); 16475a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose 1648be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek if (!CallStack.empty()) { 1649be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek assert(CallStack.back().first == C); 1650be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek CallStack.pop_back(); 1651be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek } 1652af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek break; 1653af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1654af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1655be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Query the location context here and the previous location 1656be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // as processing CallEnter may change the active path. 1657be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PDB.LC = N->getLocationContext(); 1658be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1659be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Record the mapping from the active path to the location 1660be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // context. 1661be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek assert(!LCM[&PD.getActivePath()] || 1662be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek LCM[&PD.getActivePath()] == PDB.LC); 1663be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek LCM[&PD.getActivePath()] = PDB.LC; 1664be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1665af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Have we encountered an exit from a function call? 1666af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (Optional<CallExitEnd> CE = P.getAs<CallExitEnd>()) { 1667af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const Stmt *S = CE->getCalleeContext()->getCallSite(); 1668af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Propagate the interesting symbols accordingly. 1669af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (const Expr *Ex = dyn_cast_or_null<Expr>(S)) { 1670af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek reversePropagateIntererstingSymbols(*PDB.getBugReport(), IE, 1671af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek N->getState().getPtr(), Ex, 1672af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek N->getLocationContext()); 1673af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1674af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1675af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // We are descending into a call (backwards). Construct 1676af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // a new call piece to contain the path pieces for that call. 1677af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticCallPiece *C = 1678af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticCallPiece::construct(N, *CE, SM); 1679af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1680af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Record the location context for this call piece. 1681bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 1682af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1683af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Add the edge to the return site. 1684be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, C->callReturn, PDB.LC); 1685be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PD.getActivePath().push_front(C); 16865a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose PrevLoc.invalidate(); 1687af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1688af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Make the contents of the call the active path for now. 1689af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PD.pushActivePath(&C->path); 1690af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek CallStack.push_back(StackDiagPair(C, N)); 1691af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek break; 1692af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1693af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1694be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek if (Optional<PostStmt> PS = P.getAs<PostStmt>()) { 1695be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // For expressions, make sure we propagate the 1696be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // interesting symbols correctly. 1697be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek if (const Expr *Ex = PS->getStmtAs<Expr>()) 1698be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek reversePropagateIntererstingSymbols(*PDB.getBugReport(), IE, 1699be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek N->getState().getPtr(), Ex, 1700be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek N->getLocationContext()); 1701af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1702e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // Add an edge. If this is an ObjCForCollectionStmt do 1703e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // not add an edge here as it appears in the CFG both 1704e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // as a terminator and as a terminator condition. 1705e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek if (!isa<ObjCForCollectionStmt>(PS->getStmt())) { 1706e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek PathDiagnosticLocation L = 1707e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek PathDiagnosticLocation(PS->getStmt(), SM, PDB.LC); 1708e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, L, PDB.LC); 1709e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek } 1710af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek break; 1711af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1712af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1713af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Block edges. 1714af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (Optional<BlockEdge> BE = P.getAs<BlockEdge>()) { 1715af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Does this represent entering a call? If so, look at propagating 1716af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // interesting symbols across call boundaries. 1717af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (NextNode) { 1718af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const LocationContext *CallerCtx = NextNode->getLocationContext(); 1719af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const LocationContext *CalleeCtx = PDB.LC; 1720af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (CallerCtx != CalleeCtx) { 1721af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek reversePropagateInterestingSymbols(*PDB.getBugReport(), IE, 1722af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek N->getState().getPtr(), 1723af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek CalleeCtx, CallerCtx); 1724af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1725af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1726af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1727af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Are we jumping to the head of a loop? Add a special diagnostic. 1728af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (const Stmt *Loop = BE->getSrc()->getLoopTarget()) { 1729af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticLocation L(Loop, SM, PDB.LC); 1730afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek const CompoundStmt *CS = NULL; 1731afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek 1732afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek if (const ForStmt *FS = dyn_cast<ForStmt>(Loop)) 1733afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek CS = dyn_cast<CompoundStmt>(FS->getBody()); 1734afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek else if (const WhileStmt *WS = dyn_cast<WhileStmt>(Loop)) 1735afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek CS = dyn_cast<CompoundStmt>(WS->getBody()); 1736e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek else if (const ObjCForCollectionStmt *OFS = 1737e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek dyn_cast<ObjCForCollectionStmt>(Loop)) { 1738e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek CS = dyn_cast<CompoundStmt>(OFS->getBody()); 1739e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek } 1740af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1741af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticEventPiece *p = 1742af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek new PathDiagnosticEventPiece(L, "Looping back to the head " 1743af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek "of the loop"); 1744af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek p->setPrunable(true); 1745af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1746be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, p->getLocation(), PDB.LC); 1747cd389d8cc9abeffb1416b70dd58148e66e5d822bTed Kremenek PD.getActivePath().push_front(p); 1748afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek 1749afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek if (CS) { 1750afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, 1751afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek PathDiagnosticLocation::createEndBrace(CS, SM), 1752afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek PDB.LC); 1753afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek } 1754af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1755b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1756af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const CFGBlock *BSrc = BE->getSrc(); 1757af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek ParentMap &PM = PDB.getParentMap(); 1758af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1759af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (const Stmt *Term = BSrc->getTerminator()) { 1760af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Are we jumping past the loop body without ever executing the 1761af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // loop (because the condition was false)? 1762b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek if (isLoop(Term)) { 1763e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek const Stmt *TermCond = getTerminatorCondition(BSrc); 1764b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek bool IsInLoopBody = 1765b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek isInLoopBody(PM, getStmtBeforeCond(PM, TermCond, N), Term); 1766b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1767b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek const char *str = 0; 1768b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1769b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek if (isJumpToFalseBranch(&*BE)) { 1770b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek if (!IsInLoopBody) { 1771b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek str = "Loop body executed 0 times"; 1772b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek } 1773b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek } 1774b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek else { 1775b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek str = "Entering loop body"; 1776b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek } 1777b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1778b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek if (str) { 1779d0f5faf319550b0504b2f8f822d06a6b0279285bTed Kremenek PathDiagnosticLocation L(TermCond, SM, PDB.LC); 1780b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek PathDiagnosticEventPiece *PE = 1781b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek new PathDiagnosticEventPiece(L, str); 1782b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek PE->setPrunable(true); 1783b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, 1784be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PE->getLocation(), PDB.LC); 1785b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek PD.getActivePath().push_front(PE); 1786b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek } 1787af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1788bc0fd8129626ff4e485388311b081e76d0f96795Ted Kremenek else if (isa<BreakStmt>(Term) || isa<ContinueStmt>(Term) || 1789bc0fd8129626ff4e485388311b081e76d0f96795Ted Kremenek isa<GotoStmt>(Term)) { 1790bc0fd8129626ff4e485388311b081e76d0f96795Ted Kremenek PathDiagnosticLocation L(Term, SM, PDB.LC); 1791be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, L, PDB.LC); 1792bc0fd8129626ff4e485388311b081e76d0f96795Ted Kremenek } 1793af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1794af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek break; 1795af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1796af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } while (0); 1797af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1798af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (!NextNode) 1799af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek continue; 1800af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1801af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Add pieces from custom visitors. 1802af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek for (ArrayRef<BugReporterVisitor *>::iterator I = visitors.begin(), 1803af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek E = visitors.end(); 1804af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek I != E; ++I) { 1805cd389d8cc9abeffb1416b70dd58148e66e5d822bTed Kremenek if (PathDiagnosticPiece *p = (*I)->VisitNode(N, NextNode, PDB, *report)) { 1806be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, p->getLocation(), PDB.LC); 1807cd389d8cc9abeffb1416b70dd58148e66e5d822bTed Kremenek PD.getActivePath().push_front(p); 1808af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek updateStackPiecesWithMessage(p, CallStack); 1809af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1810af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1811af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1812af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1813af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek return report->isValid(); 1814af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek} 1815af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1816b1a4d37c0549501fe12907bc6ffa81bc5d04b98aBenjamin Kramerstatic const Stmt *getLocStmt(PathDiagnosticLocation L) { 1817bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (!L.isValid()) 1818bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek return 0; 1819f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek return L.asStmt(); 1820f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek} 1821f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek 1822b1a4d37c0549501fe12907bc6ffa81bc5d04b98aBenjamin Kramerstatic const Stmt *getStmtParent(const Stmt *S, ParentMap &PM) { 1823bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (!S) 1824bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek return 0; 1825a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek 1826a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek while (true) { 1827a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek S = PM.getParentIgnoreParens(S); 1828a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek 1829a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek if (!S) 1830a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek break; 1831a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek 1832a327bb12b1cd0c142eb06e30b4f6018b96d5babfTed Kremenek if (isa<ExprWithCleanups>(S) || 1833a327bb12b1cd0c142eb06e30b4f6018b96d5babfTed Kremenek isa<CXXBindTemporaryExpr>(S) || 1834a327bb12b1cd0c142eb06e30b4f6018b96d5babfTed Kremenek isa<SubstNonTypeTemplateParmExpr>(S)) 1835a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek continue; 1836a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek 1837a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek break; 1838a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek } 1839a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek 1840a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek return S; 1841bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek} 1842bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 184315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenekstatic bool isConditionForTerminator(const Stmt *S, const Stmt *Cond) { 184415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek switch (S->getStmtClass()) { 184503194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek case Stmt::BinaryOperatorClass: { 184603194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek const BinaryOperator *BO = cast<BinaryOperator>(S); 184703194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek if (!BO->isLogicalOp()) 184803194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek return false; 184903194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek return BO->getLHS() == Cond || BO->getRHS() == Cond; 185003194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek } 1851a399f776ee29e099da33eaf7f9d585b4edc4b61dTed Kremenek case Stmt::IfStmtClass: 1852a399f776ee29e099da33eaf7f9d585b4edc4b61dTed Kremenek return cast<IfStmt>(S)->getCond() == Cond; 185315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::ForStmtClass: 185415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<ForStmt>(S)->getCond() == Cond; 185515676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::WhileStmtClass: 185615676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<WhileStmt>(S)->getCond() == Cond; 185715676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::DoStmtClass: 185815676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<DoStmt>(S)->getCond() == Cond; 185915676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::ChooseExprClass: 186015676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<ChooseExpr>(S)->getCond() == Cond; 186115676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::IndirectGotoStmtClass: 186215676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<IndirectGotoStmt>(S)->getTarget() == Cond; 186315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::SwitchStmtClass: 186415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<SwitchStmt>(S)->getCond() == Cond; 186515676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::BinaryConditionalOperatorClass: 186615676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<BinaryConditionalOperator>(S)->getCond() == Cond; 18678484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek case Stmt::ConditionalOperatorClass: { 18688484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek const ConditionalOperator *CO = cast<ConditionalOperator>(S); 18698484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek return CO->getCond() == Cond || 18708484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek CO->getLHS() == Cond || 18718484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek CO->getRHS() == Cond; 18728484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek } 187315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::ObjCForCollectionStmtClass: 187415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<ObjCForCollectionStmt>(S)->getElement() == Cond; 187515676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek default: 187615676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return false; 187715676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek } 187815676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek} 187915676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek 188096b8134337883908fcc45484486fe200d6b3e32fTed Kremenekstatic bool isIncrementOrInitInForLoop(const Stmt *S, const Stmt *FL) { 1881e2f7337958f21802e98777f441fe20ef7ba2adffTed Kremenek const ForStmt *FS = dyn_cast<ForStmt>(FL); 188296b8134337883908fcc45484486fe200d6b3e32fTed Kremenek if (!FS) 1883e2f7337958f21802e98777f441fe20ef7ba2adffTed Kremenek return false; 188496b8134337883908fcc45484486fe200d6b3e32fTed Kremenek return FS->getInc() == S || FS->getInit() == S; 1885e2f7337958f21802e98777f441fe20ef7ba2adffTed Kremenek} 1886e2f7337958f21802e98777f441fe20ef7ba2adffTed Kremenek 188715676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenektypedef llvm::DenseSet<const PathDiagnosticCallPiece *> 188815676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek OptimizedCallsSet; 188915676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek 1890d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rosevoid PathPieces::dump() const { 1891d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose unsigned index = 0; 1892d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose for (PathPieces::const_iterator I = begin(), E = end(); I != E; ++I ) { 1893d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << "[" << index++ << "]"; 1894d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose 1895d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose switch ((*I)->getKind()) { 1896d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose case PathDiagnosticPiece::Call: 1897d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << " CALL\n--------------\n"; 1898d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose 1899d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose if (const Stmt *SLoc = getLocStmt((*I)->getLocation())) { 1900d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose SLoc->dump(); 1901d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose } else { 1902d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose const PathDiagnosticCallPiece *Call = cast<PathDiagnosticCallPiece>(*I); 1903d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose if (const NamedDecl *ND = dyn_cast<NamedDecl>(Call->getCallee())) 1904d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << *ND << "\n"; 1905d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose } 1906d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose break; 1907d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose case PathDiagnosticPiece::Event: 1908d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << " EVENT\n--------------\n"; 1909d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << (*I)->getString() << "\n"; 1910d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose if (const Stmt *SLoc = getLocStmt((*I)->getLocation())) { 1911d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << " ---- at ----\n"; 1912d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose SLoc->dump(); 1913d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose } 1914d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose break; 1915d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose case PathDiagnosticPiece::Macro: 1916d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << " MACRO\n--------------\n"; 1917d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose // FIXME: print which macro is being invoked. 1918d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose break; 1919d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose case PathDiagnosticPiece::ControlFlow: { 1920d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose const PathDiagnosticControlFlowPiece *CP = 1921d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose cast<PathDiagnosticControlFlowPiece>(*I); 1922d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << " CONTROL\n--------------\n"; 1923d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose 1924d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose if (const Stmt *s1Start = getLocStmt(CP->getStartLocation())) 1925d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose s1Start->dump(); 1926d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose else 1927d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << "NULL\n"; 1928d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose 1929d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << " ---- to ----\n"; 1930d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose 1931d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose if (const Stmt *s1End = getLocStmt(CP->getEndLocation())) 1932d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose s1End->dump(); 1933d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose else 1934d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << "NULL\n"; 1935d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose 1936d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose break; 1937d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose } 1938d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose } 1939d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose 1940d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose llvm::errs() << "\n"; 1941d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose } 1942d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose} 1943d1913d89e2ff3b38bb6293833cfd9d8ead76348eJordan Rose 194452f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek/// \brief Return true if X is contained by Y. 194552f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenekstatic bool lexicalContains(ParentMap &PM, 194652f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek const Stmt *X, 194752f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek const Stmt *Y) { 194852f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek while (X) { 194952f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek if (X == Y) 195052f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek return true; 195152f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek X = PM.getParent(X); 195252f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek } 195352f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek return false; 195452f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek} 195552f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek 1956de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek// Remove short edges on the same line less than 3 columns in difference. 1957de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenekstatic void removePunyEdges(PathPieces &path, 1958de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek SourceManager &SM, 1959de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek ParentMap &PM) { 1960de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 1961de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek bool erased = false; 1962de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 1963de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek for (PathPieces::iterator I = path.begin(), E = path.end(); I != E; 1964de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek erased ? I : ++I) { 1965de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 1966de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek erased = false; 1967de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 1968de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek PathDiagnosticControlFlowPiece *PieceI = 1969de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek dyn_cast<PathDiagnosticControlFlowPiece>(*I); 1970de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 1971de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (!PieceI) 1972de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 1973de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 1974de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek const Stmt *start = getLocStmt(PieceI->getStartLocation()); 1975de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek const Stmt *end = getLocStmt(PieceI->getEndLocation()); 1976de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 1977de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (!start || !end) 1978de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 1979de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 1980de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek const Stmt *endParent = PM.getParent(end); 1981de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (!endParent) 1982de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 1983de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 1984de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (isConditionForTerminator(end, endParent)) 1985de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 1986de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 1987de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek bool Invalid = false; 1988de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek FullSourceLoc StartL(start->getLocStart(), SM); 1989de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek FullSourceLoc EndL(end->getLocStart(), SM); 1990de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 1991de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek unsigned startLine = StartL.getSpellingLineNumber(&Invalid); 1992de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (Invalid) 1993de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 1994de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 1995de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek unsigned endLine = EndL.getSpellingLineNumber(&Invalid); 1996de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (Invalid) 1997de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 1998de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 1999de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (startLine != endLine) 2000de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2001de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2002de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek unsigned startCol = StartL.getSpellingColumnNumber(&Invalid); 2003de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (Invalid) 2004de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2005de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2006de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek unsigned endCol = EndL.getSpellingColumnNumber(&Invalid); 2007de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (Invalid) 2008de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2009de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 201034bd3331b5ed34cc9027ee00e1aaabfecff8f742Pete Cooper if (abs((int)startCol - (int)endCol) <= 2) { 2011a705980a7c3315b7c72d99ce675342ad91b50642Ted Kremenek I = path.erase(I); 2012de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek erased = true; 2013de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2014de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek } 2015de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek } 2016de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek} 2017de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 20181d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenekstatic void removeIdenticalEvents(PathPieces &path) { 20191d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek for (PathPieces::iterator I = path.begin(), E = path.end(); I != E; ++I) { 20201d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek PathDiagnosticEventPiece *PieceI = 20211d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek dyn_cast<PathDiagnosticEventPiece>(*I); 20221d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 20231d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek if (!PieceI) 20241d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek continue; 20251d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 20261d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek PathPieces::iterator NextI = I; ++NextI; 20271d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek if (NextI == E) 20281d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek return; 20291d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 20301d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek PathDiagnosticEventPiece *PieceNextI = 20310fa3504acfc7c20a87973c58ad3474adc94dd97dTed Kremenek dyn_cast<PathDiagnosticEventPiece>(*NextI); 20321d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 20331d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek if (!PieceNextI) 20341d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek continue; 20351d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 20361d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek // Erase the second piece if it has the same exact message text. 20371d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek if (PieceI->getString() == PieceNextI->getString()) { 20381d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek path.erase(NextI); 20391d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek } 20401d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek } 20411d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek} 20421d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 204315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenekstatic bool optimizeEdges(PathPieces &path, SourceManager &SM, 204415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek OptimizedCallsSet &OCS, 2045bb518991ce4298d8662235fc8cb13813f011c18dJordan Rose LocationContextMap &LCM) { 2046bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek bool hasChanges = false; 2047bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek const LocationContext *LC = LCM[&path]; 2048bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek assert(LC); 2049de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek ParentMap &PM = LC->getParentMap(); 2050f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek bool isFirst = true; 2051bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2052481da5554d03271b0d87b695449963f7728c5895Ted Kremenek for (PathPieces::iterator I = path.begin(), E = path.end(); I != E; ) { 205315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek bool wasFirst = isFirst; 205415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek isFirst = false; 2055bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2056bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // Optimize subpaths. 2057bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (PathDiagnosticCallPiece *CallI = dyn_cast<PathDiagnosticCallPiece>(*I)){ 2058481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // Record the fact that a call has been optimized so we only do the 2059481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // effort once. 206015676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek if (!OCS.count(CallI)) { 2061bb518991ce4298d8662235fc8cb13813f011c18dJordan Rose while (optimizeEdges(CallI->path, SM, OCS, LCM)) {} 206215676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek OCS.insert(CallI); 206315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek } 2064481da5554d03271b0d87b695449963f7728c5895Ted Kremenek ++I; 2065bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek continue; 2066bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek } 2067bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2068bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // Pattern match the current piece and its successor. 2069bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek PathDiagnosticControlFlowPiece *PieceI = 2070bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek dyn_cast<PathDiagnosticControlFlowPiece>(*I); 2071bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2072481da5554d03271b0d87b695449963f7728c5895Ted Kremenek if (!PieceI) { 2073481da5554d03271b0d87b695449963f7728c5895Ted Kremenek ++I; 2074bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek continue; 2075481da5554d03271b0d87b695449963f7728c5895Ted Kremenek } 2076bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2077f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *s1Start = getLocStmt(PieceI->getStartLocation()); 2078f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *s1End = getLocStmt(PieceI->getEndLocation()); 2079f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *level1 = getStmtParent(s1Start, PM); 2080f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *level2 = getStmtParent(s1End, PM); 2081f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek 208215676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek if (wasFirst) { 2083a399f776ee29e099da33eaf7f9d585b4edc4b61dTed Kremenek // If the first edge (in isolation) is just a transition from 2084a399f776ee29e099da33eaf7f9d585b4edc4b61dTed Kremenek // an expression to a parent expression then eliminate that edge. 2085a399f776ee29e099da33eaf7f9d585b4edc4b61dTed Kremenek if (level1 && level2 && level2 == PM.getParent(level1)) { 2086f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek path.erase(I); 2087f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // Since we are erasing the current edge at the start of the 2088f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // path, just return now so we start analyzing the start of the path 2089f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // again. 2090f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek return true; 2091f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek } 209296b8134337883908fcc45484486fe200d6b3e32fTed Kremenek 209396b8134337883908fcc45484486fe200d6b3e32fTed Kremenek // If the first edge (in isolation) is a transition from the 209496b8134337883908fcc45484486fe200d6b3e32fTed Kremenek // initialization or increment in a for loop then remove it. 209596b8134337883908fcc45484486fe200d6b3e32fTed Kremenek if (level1 && isIncrementOrInitInForLoop(s1Start, level1)) { 209696b8134337883908fcc45484486fe200d6b3e32fTed Kremenek path.erase(I); 209796b8134337883908fcc45484486fe200d6b3e32fTed Kremenek return true; 209896b8134337883908fcc45484486fe200d6b3e32fTed Kremenek } 2099f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek } 2100f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek 210115676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek PathPieces::iterator NextI = I; ++NextI; 210215676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek if (NextI == E) 210315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek break; 210415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek 2105bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek PathDiagnosticControlFlowPiece *PieceNextI = 2106bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek dyn_cast<PathDiagnosticControlFlowPiece>(*NextI); 2107bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2108481da5554d03271b0d87b695449963f7728c5895Ted Kremenek if (!PieceNextI) { 2109481da5554d03271b0d87b695449963f7728c5895Ted Kremenek ++I; 2110bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek continue; 2111481da5554d03271b0d87b695449963f7728c5895Ted Kremenek } 2112bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2113f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *s2Start = getLocStmt(PieceNextI->getStartLocation()); 2114f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *s2End = getLocStmt(PieceNextI->getEndLocation()); 2115f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *level3 = getStmtParent(s2Start, PM); 2116f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *level4 = getStmtParent(s2End, PM); 2117bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2118bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // Rule I. 2119bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // 2120bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // If we have two consecutive control edges whose end/begin locations 2121481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // are at the same level (e.g. statements or top-level expressions within 2122481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // a compound statement, or siblings share a single ancestor expression), 2123481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // then merge them if they have no interesting intermediate event. 2124bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // 2125bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // For example: 2126bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // 2127bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // (1.1 -> 1.2) -> (1.2 -> 1.3) becomes (1.1 -> 1.3) because the common 2128481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // parent is '1'. Here 'x.y.z' represents the hierarchy of statements. 2129bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // 2130bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // NOTE: this will be limited later in cases where we add barriers 2131bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // to prevent this optimization. 2132f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // 2133481da5554d03271b0d87b695449963f7728c5895Ted Kremenek if (level1 && level1 == level2 && level1 == level3 && level1 == level4) { 2134bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek PieceI->setEndLocation(PieceNextI->getEndLocation()); 2135bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek path.erase(NextI); 2136bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek hasChanges = true; 2137bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek continue; 2138bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek } 2139b9e13d555fc9f3e5515e2b1fa6f720e6f10bb076Ted Kremenek 2140b9e13d555fc9f3e5515e2b1fa6f720e6f10bb076Ted Kremenek // Rule II. 2141b9e13d555fc9f3e5515e2b1fa6f720e6f10bb076Ted Kremenek // 2142a399f776ee29e099da33eaf7f9d585b4edc4b61dTed Kremenek // Eliminate edges between subexpressions and parent expressions 2143a399f776ee29e099da33eaf7f9d585b4edc4b61dTed Kremenek // when the subexpression is consumed. 2144f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // 2145f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // NOTE: this will be limited later in cases where we add barriers 2146f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // to prevent this optimization. 2147f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // 214896b8134337883908fcc45484486fe200d6b3e32fTed Kremenek if (s1End && s1End == s2Start && level2) { 214952f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek bool removeEdge = false; 215052f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // Remove edges into the increment or initialization of a 215152f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // loop that have no interleaving event. This means that 215252f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // they aren't interesting. 215352f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek if (isIncrementOrInitInForLoop(s1End, level2)) 215452f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek removeEdge = true; 215552f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // Next only consider edges that are not anchored on 215652f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // the condition of a terminator. This are intermediate edges 215752f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // that we might want to trim. 215852f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek else if (!isConditionForTerminator(level2, s1End)) { 215952f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // Trim edges on expressions that are consumed by 216052f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // the parent expression. 216152f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek if (isa<Expr>(s1End) && PM.isConsumedExpr(cast<Expr>(s1End))) { 216252f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek removeEdge = true; 216352f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek } 216452f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // Trim edges where a lexical containment doesn't exist. 216552f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // For example: 216652f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // 216752f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // X -> Y -> Z 216852f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // 216952f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // If 'Z' lexically contains Y (it is an ancestor) and 217052f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // 'X' does not lexically contain Y (it is a descendant OR 217152f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // it has no lexical relationship at all) then trim. 217252f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // 217352f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // This can eliminate edges where we dive into a subexpression 217452f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // and then pop back out, etc. 217552f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek else if (s1Start && s2End && 217652f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek lexicalContains(PM, s2Start, s2End) && 217752f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek !lexicalContains(PM, s1End, s1Start)) { 217852f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek removeEdge = true; 217952f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek } 218052f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek } 218152f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek 218252f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek if (removeEdge) { 218396b8134337883908fcc45484486fe200d6b3e32fTed Kremenek PieceI->setEndLocation(PieceNextI->getEndLocation()); 218496b8134337883908fcc45484486fe200d6b3e32fTed Kremenek path.erase(NextI); 218596b8134337883908fcc45484486fe200d6b3e32fTed Kremenek hasChanges = true; 218696b8134337883908fcc45484486fe200d6b3e32fTed Kremenek continue; 218796b8134337883908fcc45484486fe200d6b3e32fTed Kremenek } 2188f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek } 2189481da5554d03271b0d87b695449963f7728c5895Ted Kremenek 2190e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // Optimize edges for ObjC fast-enumeration loops. 2191e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // 2192e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // (X -> collection) -> (collection -> element) 2193e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // 2194e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // becomes: 2195e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // 2196e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // (X -> element) 2197e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek if (s1End == s2Start) { 2198e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek const ObjCForCollectionStmt *FS = 2199e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek dyn_cast_or_null<ObjCForCollectionStmt>(level3); 2200e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek if (FS && FS->getCollection()->IgnoreParens() == s2Start && 2201e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek s2End == FS->getElement()) { 2202e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek PieceI->setEndLocation(PieceNextI->getEndLocation()); 2203e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek path.erase(NextI); 2204e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek hasChanges = true; 2205e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek continue; 2206e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek } 2207e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek } 2208e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek 2209481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // No changes at this index? Move to the next one. 2210481da5554d03271b0d87b695449963f7728c5895Ted Kremenek ++I; 2211bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek } 2212bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2213de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (!hasChanges) { 2214de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek // Remove any puny edges left over after primary optimization pass. 2215de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek removePunyEdges(path, SM, PM); 22161d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek // Remove identical events. 22171d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek removeIdenticalEvents(path); 2218de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek } 2219de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2220bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek return hasChanges; 2221bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek} 2222bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2223a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenekstatic void adjustBranchEdges(PathPieces &pieces, LocationContextMap &LCM, 2224aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek SourceManager &SM) { 2225aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek // Retrieve the parent map for this path. 2226aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek const LocationContext *LC = LCM[&pieces]; 2227aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek ParentMap &PM = LC->getParentMap(); 2228aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek PathPieces::iterator Prev = pieces.end(); 2229aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek for (PathPieces::iterator I = pieces.begin(), E = pieces.end(); I != E; 2230aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek Prev = I, ++I) { 2231aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek // Adjust edges in subpaths. 2232aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek if (PathDiagnosticCallPiece *Call = dyn_cast<PathDiagnosticCallPiece>(*I)) { 2233a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek adjustBranchEdges(Call->path, LCM, SM); 2234aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek continue; 2235aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek } 2236aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek 2237aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek PathDiagnosticControlFlowPiece *PieceI = 2238aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek dyn_cast<PathDiagnosticControlFlowPiece>(*I); 2239aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek 2240aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek if (!PieceI) 2241aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek continue; 2242aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek 2243aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek // We are looking at two edges. Is the second one incident 2244a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek // on an expression (or subexpression) of a branch condition. 2245aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek const Stmt *Dst = getLocStmt(PieceI->getEndLocation()); 2246aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek const Stmt *Src = getLocStmt(PieceI->getStartLocation()); 2247aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek 2248aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek if (!Dst || !Src) 2249aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek continue; 2250aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek 2251a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek const Stmt *Branch = 0; 2252aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek const Stmt *S = Dst; 2253a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek while (const Stmt *Parent = getStmtParent(S, PM)) { 22548841c532f217d938f47f4feaa3707b929cd71181Ted Kremenek if (const ForStmt *FS = dyn_cast<ForStmt>(Parent)) { 22558841c532f217d938f47f4feaa3707b929cd71181Ted Kremenek if (FS->getCond()->IgnoreParens() == S) 2256a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek Branch = FS; 22578841c532f217d938f47f4feaa3707b929cd71181Ted Kremenek break; 22588841c532f217d938f47f4feaa3707b929cd71181Ted Kremenek } 22598841c532f217d938f47f4feaa3707b929cd71181Ted Kremenek if (const WhileStmt *WS = dyn_cast<WhileStmt>(Parent)) { 22608841c532f217d938f47f4feaa3707b929cd71181Ted Kremenek if (WS->getCond()->IgnoreParens() == S) 2261a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek Branch = WS; 2262a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek break; 2263a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek } 2264a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek if (const IfStmt *IS = dyn_cast<IfStmt>(Parent)) { 2265a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek if (IS->getCond()->IgnoreParens() == S) 2266a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek Branch = IS; 2267aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek break; 2268aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek } 2269e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek if (const ObjCForCollectionStmt *OFS = 2270e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek dyn_cast<ObjCForCollectionStmt>(Parent)) { 2271e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek if (OFS->getElement() == S) 2272e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek Branch = OFS; 2273e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek break; 2274e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek } 2275e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek 2276aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek S = Parent; 2277aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek } 2278aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek 2279a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek // If 'Branch' is non-null we have found a match where we have an edge 2280a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek // incident on the condition of a if/for/while statement. 2281a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek if (!Branch) 2282aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek continue; 2283aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek 2284a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek // If the current source of the edge is the if/for/while, then there is 22858841c532f217d938f47f4feaa3707b929cd71181Ted Kremenek // nothing left to be done. 2286a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek if (Src == Branch) 2287aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek continue; 2288aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek 2289aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek // Now look at the previous edge. We want to know if this was in the same 2290aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek // "level" as the for statement. 2291a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek const Stmt *SrcParent = getStmtParent(Src, PM); 2292a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek const Stmt *BranchParent = getStmtParent(Branch, PM); 2293a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek if (SrcParent && SrcParent == BranchParent) { 2294a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek PathDiagnosticLocation L(Branch, SM, LC); 2295aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek bool needsEdge = true; 2296aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek 2297aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek if (Prev != E) { 2298aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek if (PathDiagnosticControlFlowPiece *P = 2299aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek dyn_cast<PathDiagnosticControlFlowPiece>(*Prev)) { 2300aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek const Stmt *PrevSrc = getLocStmt(P->getStartLocation()); 2301aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek if (PrevSrc) { 2302a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek const Stmt *PrevSrcParent = getStmtParent(PrevSrc, PM); 2303a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek if (PrevSrcParent == BranchParent) { 2304aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek P->setEndLocation(L); 2305aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek needsEdge = false; 2306aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek } 2307aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek } 2308aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek } 2309aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek } 2310aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek 2311aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek if (needsEdge) { 2312aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek PathDiagnosticControlFlowPiece *P = 2313aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek new PathDiagnosticControlFlowPiece(PieceI->getStartLocation(), L); 2314aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek pieces.insert(I, P); 2315aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek } 2316aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek 2317aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek PieceI->setStartLocation(L); 2318aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek } 2319aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek } 2320aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek} 2321aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek 23225fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek//===----------------------------------------------------------------------===// 23233106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// Methods for BugType and subclasses. 23243106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 2325404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios KyrtzidisBugType::~BugType() { } 2326404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 23273106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenekvoid BugType::FlushReports(BugReporter &BR) {} 23283106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 232999ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikievoid BuiltinBug::anchor() {} 233099ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie 23313106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 23323106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// Methods for BugReport and subclasses. 23333106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 2334e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 233599ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikievoid BugReport::NodeResolver::anchor() {} 233699ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie 23378e6431adab313e283a992698f6fc7afe62420999Anna Zaksvoid BugReport::addVisitor(BugReporterVisitor* visitor) { 23388e6431adab313e283a992698f6fc7afe62420999Anna Zaks if (!visitor) 23398e6431adab313e283a992698f6fc7afe62420999Anna Zaks return; 23408e6431adab313e283a992698f6fc7afe62420999Anna Zaks 23418e6431adab313e283a992698f6fc7afe62420999Anna Zaks llvm::FoldingSetNodeID ID; 23428e6431adab313e283a992698f6fc7afe62420999Anna Zaks visitor->Profile(ID); 23438e6431adab313e283a992698f6fc7afe62420999Anna Zaks void *InsertPos; 23448e6431adab313e283a992698f6fc7afe62420999Anna Zaks 23458e6431adab313e283a992698f6fc7afe62420999Anna Zaks if (CallbacksSet.FindNodeOrInsertPos(ID, InsertPos)) { 23468e6431adab313e283a992698f6fc7afe62420999Anna Zaks delete visitor; 23478e6431adab313e283a992698f6fc7afe62420999Anna Zaks return; 23488e6431adab313e283a992698f6fc7afe62420999Anna Zaks } 23498e6431adab313e283a992698f6fc7afe62420999Anna Zaks 23508e6431adab313e283a992698f6fc7afe62420999Anna Zaks CallbacksSet.InsertNode(visitor, InsertPos); 23513bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose Callbacks.push_back(visitor); 23523bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ++ConfigurationChangeToken; 23538e6431adab313e283a992698f6fc7afe62420999Anna Zaks} 23548e6431adab313e283a992698f6fc7afe62420999Anna Zaks 23558e6431adab313e283a992698f6fc7afe62420999Anna ZaksBugReport::~BugReport() { 23568e6431adab313e283a992698f6fc7afe62420999Anna Zaks for (visitor_iterator I = visitor_begin(), E = visitor_end(); I != E; ++I) { 2357dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks delete *I; 23588e6431adab313e283a992698f6fc7afe62420999Anna Zaks } 2359c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek while (!interestingSymbols.empty()) { 2360c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek popInterestingSymbolsAndRegions(); 2361c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek } 23628e6431adab313e283a992698f6fc7afe62420999Anna Zaks} 2363e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 236407189521a15d9c088216b943649cb9fe231cbb57Ted Kremenekconst Decl *BugReport::getDeclWithIssue() const { 236507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek if (DeclWithIssue) 236607189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek return DeclWithIssue; 236707189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek 236807189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek const ExplodedNode *N = getErrorNode(); 236907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek if (!N) 237007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek return 0; 237107189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek 237207189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek const LocationContext *LC = N->getLocationContext(); 237307189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek return LC->getCurrentStackFrame()->getDecl(); 237407189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek} 237507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek 2376e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaksvoid BugReport::Profile(llvm::FoldingSetNodeID& hash) const { 2377e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks hash.AddPointer(&BT); 2378e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks hash.AddString(Description); 237997bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks PathDiagnosticLocation UL = getUniqueingLocation(); 238097bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks if (UL.isValid()) { 238197bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks UL.Profile(hash); 2382ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks } else if (Location.isValid()) { 2383590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks Location.Profile(hash); 2384590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks } else { 2385590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks assert(ErrorNode); 2386590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks hash.AddPointer(GetCurrentOrPreviousStmt(ErrorNode)); 2387590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks } 2388e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 2389e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks for (SmallVectorImpl<SourceRange>::const_iterator I = 2390e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks Ranges.begin(), E = Ranges.end(); I != E; ++I) { 2391e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks const SourceRange range = *I; 2392e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks if (!range.isValid()) 2393e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks continue; 2394e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks hash.AddInteger(range.getBegin().getRawEncoding()); 2395e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks hash.AddInteger(range.getEnd().getRawEncoding()); 2396e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks } 2397e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks} 23983106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 239976aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenekvoid BugReport::markInteresting(SymbolRef sym) { 240076aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (!sym) 240176aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return; 24023bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 24033bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose // If the symbol wasn't already in our set, note a configuration change. 2404c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek if (getInterestingSymbols().insert(sym).second) 24053bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ++ConfigurationChangeToken; 24068ec588e2ac57311604cf80608c7d4b3fb3b022f7Jordy Rose 24078ec588e2ac57311604cf80608c7d4b3fb3b022f7Jordy Rose if (const SymbolMetadata *meta = dyn_cast<SymbolMetadata>(sym)) 2408c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek getInterestingRegions().insert(meta->getRegion()); 240976aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 241076aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 241176aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenekvoid BugReport::markInteresting(const MemRegion *R) { 241276aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (!R) 241376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return; 24143bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 24153bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose // If the base region wasn't already in our set, note a configuration change. 241676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek R = R->getBaseRegion(); 2417c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek if (getInterestingRegions().insert(R).second) 24183bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ++ConfigurationChangeToken; 24198ec588e2ac57311604cf80608c7d4b3fb3b022f7Jordy Rose 242076aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(R)) 2421c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek getInterestingSymbols().insert(SR->getSymbol()); 242276aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 242376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 242476aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenekvoid BugReport::markInteresting(SVal V) { 242576aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek markInteresting(V.getAsRegion()); 242676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek markInteresting(V.getAsSymbol()); 242776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 242876aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 242980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaksvoid BugReport::markInteresting(const LocationContext *LC) { 243080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (!LC) 243180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks return; 243280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks InterestingLocationContexts.insert(LC); 243380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks} 243480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 2435c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekbool BugReport::isInteresting(SVal V) { 243676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return isInteresting(V.getAsRegion()) || isInteresting(V.getAsSymbol()); 243776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 243876aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 2439c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekbool BugReport::isInteresting(SymbolRef sym) { 244076aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (!sym) 244176aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return false; 24428ec588e2ac57311604cf80608c7d4b3fb3b022f7Jordy Rose // We don't currently consider metadata symbols to be interesting 24438ec588e2ac57311604cf80608c7d4b3fb3b022f7Jordy Rose // even if we know their region is interesting. Is that correct behavior? 2444c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek return getInterestingSymbols().count(sym); 244576aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 244676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 2447c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekbool BugReport::isInteresting(const MemRegion *R) { 244876aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (!R) 244976aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return false; 245076aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek R = R->getBaseRegion(); 2451c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek bool b = getInterestingRegions().count(R); 245276aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (b) 245376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return true; 245476aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(R)) 2455c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek return getInterestingSymbols().count(SR->getSymbol()); 245676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return false; 245776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 2458c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 245980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaksbool BugReport::isInteresting(const LocationContext *LC) { 246080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (!LC) 246180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks return false; 246280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks return InterestingLocationContexts.count(LC); 246380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks} 246480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 2465c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekvoid BugReport::lazyInitializeInterestingSets() { 2466c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek if (interestingSymbols.empty()) { 2467c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingSymbols.push_back(new Symbols()); 2468c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingRegions.push_back(new Regions()); 2469c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek } 2470c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 2471c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 2472c4bac8e376b98d633bb00ee5f510d5e58449753cTed KremenekBugReport::Symbols &BugReport::getInterestingSymbols() { 2473c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek lazyInitializeInterestingSets(); 2474c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek return *interestingSymbols.back(); 2475c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 2476c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 2477c4bac8e376b98d633bb00ee5f510d5e58449753cTed KremenekBugReport::Regions &BugReport::getInterestingRegions() { 2478c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek lazyInitializeInterestingSets(); 2479c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek return *interestingRegions.back(); 2480c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 2481c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 2482c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekvoid BugReport::pushInterestingSymbolsAndRegions() { 2483c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingSymbols.push_back(new Symbols(getInterestingSymbols())); 2484c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingRegions.push_back(new Regions(getInterestingRegions())); 2485c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 2486c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 2487c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekvoid BugReport::popInterestingSymbolsAndRegions() { 2488c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek delete interestingSymbols.back(); 2489c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingSymbols.pop_back(); 2490c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek delete interestingRegions.back(); 2491c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingRegions.pop_back(); 2492c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 249376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 24949c378f705405d37f49795d5e915989de774fe11fTed Kremenekconst Stmt *BugReport::getStmt() const { 2495e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks if (!ErrorNode) 2496e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks return 0; 2497e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 2498212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care ProgramPoint ProgP = ErrorNode->getLocation(); 24995f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek const Stmt *S = NULL; 25001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 25017a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<BlockEntrance> BE = ProgP.getAs<BlockEntrance>()) { 2502fafd3834754d2093e0ad7a1c005860fd527ecb7fZhongxing Xu CFGBlock &Exit = ProgP.getLocationContext()->getCFG()->getExit(); 250350d5bc4e3b53eb8bb4ebf198f1213348a3fa0f38Zhongxing Xu if (BE->getBlock() == &Exit) 2504212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care S = GetPreviousStmt(ErrorNode); 25053106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 25065f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek if (!S) 25070f8579274a010f360a371b53101859d9d6052314Anna Zaks S = PathDiagnosticLocation::getStmt(ErrorNode); 25081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 25091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return S; 25103106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 25113106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 2512640ccf071076e684713cc3c3276bb51982bff607Argyrios Kyrtzidisstd::pair<BugReport::ranges_iterator, BugReport::ranges_iterator> 2513e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna ZaksBugReport::getRanges() { 2514e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks // If no custom ranges, add the range of the statement corresponding to 2515e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks // the error node. 2516e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks if (Ranges.empty()) { 2517e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks if (const Expr *E = dyn_cast_or_null<Expr>(getStmt())) 2518e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks addRange(E->getSourceRange()); 2519e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks else 2520e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks return std::make_pair(ranges_iterator(), ranges_iterator()); 2521e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks } 2522e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 252314924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks // User-specified absence of range info. 252414924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks if (Ranges.size() == 1 && !Ranges.begin()->isValid()) 252514924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks return std::make_pair(ranges_iterator(), ranges_iterator()); 252614924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks 2527e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks return std::make_pair(Ranges.begin(), Ranges.end()); 25283106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 25293106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 2530590dd8e0959d8df5621827768987c4792b74fc06Anna ZaksPathDiagnosticLocation BugReport::getLocation(const SourceManager &SM) const { 2531b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks if (ErrorNode) { 2532590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks assert(!Location.isValid() && 2533b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks "Either Location or ErrorNode should be specified but not both."); 25340f8579274a010f360a371b53101859d9d6052314Anna Zaks return PathDiagnosticLocation::createEndOfPath(ErrorNode, SM); 2535b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks } else { 2536b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks assert(Location.isValid()); 2537b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks return Location; 2538b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks } 2539b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks 2540590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks return PathDiagnosticLocation(); 25413106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 25423106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 25433106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 25443106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// Methods for BugReporter and subclasses. 25453106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 25463106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 25474a5f724538cbc275370c9504e8169ce92503256cBenjamin KramerBugReportEquivClass::~BugReportEquivClass() { } 2548a2f4ec0df645fc249d2945beef9653f03b175417Zhongxing XuGRBugReporter::~GRBugReporter() { } 25493106198188ac6eb2753f1764d5c28376b0b76351Ted KremenekBugReporterData::~BugReporterData() {} 25503106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 255138b02b912e1a55c912f603c4369431264d36a381Zhongxing XuExplodedGraph &GRBugReporter::getGraph() { return Eng.getGraph(); } 25523106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 255318c66fdc3c4008d335885695fe36fb5353c5f672Ted KremenekProgramStateManager& 25543106198188ac6eb2753f1764d5c28376b0b76351Ted KremenekGRBugReporter::getStateManager() { return Eng.getStateManager(); } 25553106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 25563b030a28cda2b953758507769c1d436bec5ec45eAnna ZaksBugReporter::~BugReporter() { 25573b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks FlushReports(); 25583b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks 25593b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks // Free the bug reports we are tracking. 25603b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks typedef std::vector<BugReportEquivClass *> ContTy; 25613b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks for (ContTy::iterator I = EQClassesVector.begin(), E = EQClassesVector.end(); 25623b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks I != E; ++I) { 25633b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks delete *I; 25643b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks } 25653b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks} 25663106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 25673106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenekvoid BugReporter::FlushReports() { 25683106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (BugTypes.isEmpty()) 25693106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek return; 25703106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 25713106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // First flush the warnings for each BugType. This may end up creating new 2572404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // warnings and new BugTypes. 2573404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // FIXME: Only NSErrorChecker needs BugType's FlushReports. 2574404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // Turn NSErrorChecker into a proper checker and remove this. 25755f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<const BugType*, 16> bugTypes; 25763106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek for (BugTypesTy::iterator I=BugTypes.begin(), E=BugTypes.end(); I!=E; ++I) 2577404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis bugTypes.push_back(*I); 25785f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner for (SmallVector<const BugType*, 16>::iterator 2579404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis I = bugTypes.begin(), E = bugTypes.end(); I != E; ++I) 25803106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek const_cast<BugType*>(*I)->FlushReports(*this); 25813106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 2582d015f4febe85d3e3340172d70042840c51bbd836Anna Zaks // We need to flush reports in deterministic order to ensure the order 2583d015f4febe85d3e3340172d70042840c51bbd836Anna Zaks // of the reports is consistent between runs. 25840eb6c37dd4e4ad8fa2363003dea270f9fd6c2969Anna Zaks typedef std::vector<BugReportEquivClass *> ContVecTy; 25850eb6c37dd4e4ad8fa2363003dea270f9fd6c2969Anna Zaks for (ContVecTy::iterator EI=EQClassesVector.begin(), EE=EQClassesVector.end(); 25860eb6c37dd4e4ad8fa2363003dea270f9fd6c2969Anna Zaks EI != EE; ++EI){ 25870eb6c37dd4e4ad8fa2363003dea270f9fd6c2969Anna Zaks BugReportEquivClass& EQ = **EI; 2588404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis FlushReport(EQ); 25893106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 25903106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 2591404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // BugReporter owns and deletes only BugTypes created implicitly through 2592404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // EmitBasicReport. 2593404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // FIXME: There are leaks from checkers that assume that the BugTypes they 2594404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // create will be destroyed by the BugReporter. 2595404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis for (llvm::StringMap<BugType*>::iterator 2596404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis I = StrBugTypes.begin(), E = StrBugTypes.end(); I != E; ++I) 2597404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis delete I->second; 2598404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 25993106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Remove all references to the BugType objects. 26003baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugTypes = F.getEmptySet(); 26013106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 26023106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 26033106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 26043106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// PathDiagnostics generation. 26053106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 26063106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 26071efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rosenamespace { 26081efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose/// A wrapper around a report graph, which contains only a single path, and its 26091efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose/// node maps. 26101efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Roseclass ReportGraph { 26111efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rosepublic: 26121efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose InterExplodedGraphMap BackMap; 2613228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose OwningPtr<ExplodedGraph> Graph; 2614228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose const ExplodedNode *ErrorNode; 26151efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose size_t Index; 26161efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose}; 26171efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose 26181efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose/// A wrapper around a trimmed graph and its node maps. 26191efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Roseclass TrimmedGraph { 26201efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose InterExplodedGraphMap InverseMap; 26212110350909701fcd6b55c636e24a675f0a905feaJordan Rose 26222110350909701fcd6b55c636e24a675f0a905feaJordan Rose typedef llvm::DenseMap<const ExplodedNode *, unsigned> PriorityMapTy; 26232110350909701fcd6b55c636e24a675f0a905feaJordan Rose PriorityMapTy PriorityMap; 26242110350909701fcd6b55c636e24a675f0a905feaJordan Rose 2625228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose typedef std::pair<const ExplodedNode *, size_t> NodeIndexPair; 2626228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose SmallVector<NodeIndexPair, 32> ReportNodes; 2627228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 26281efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose OwningPtr<ExplodedGraph> G; 2629228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2630228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose /// A helper class for sorting ExplodedNodes by priority. 2631228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose template <bool Descending> 2632228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose class PriorityCompare { 2633228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose const PriorityMapTy &PriorityMap; 2634228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2635228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose public: 2636228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityCompare(const PriorityMapTy &M) : PriorityMap(M) {} 2637228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2638228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose bool operator()(const ExplodedNode *LHS, const ExplodedNode *RHS) const { 2639228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityMapTy::const_iterator LI = PriorityMap.find(LHS); 2640228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityMapTy::const_iterator RI = PriorityMap.find(RHS); 2641228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityMapTy::const_iterator E = PriorityMap.end(); 2642228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2643228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (LI == E) 2644228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return Descending; 2645228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (RI == E) 2646228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return !Descending; 2647228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2648228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return Descending ? LI->second > RI->second 2649228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose : LI->second < RI->second; 2650228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose } 2651228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2652228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose bool operator()(const NodeIndexPair &LHS, const NodeIndexPair &RHS) const { 2653228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return (*this)(LHS.first, RHS.first); 2654228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose } 2655228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose }; 2656228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 26571efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rosepublic: 26581efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose TrimmedGraph(const ExplodedGraph *OriginalGraph, 26592110350909701fcd6b55c636e24a675f0a905feaJordan Rose ArrayRef<const ExplodedNode *> Nodes); 26601efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose 2661228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose bool popNextReportGraph(ReportGraph &GraphWrapper); 26621efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose}; 26631efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose} 26641efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose 26652110350909701fcd6b55c636e24a675f0a905feaJordan RoseTrimmedGraph::TrimmedGraph(const ExplodedGraph *OriginalGraph, 26662110350909701fcd6b55c636e24a675f0a905feaJordan Rose ArrayRef<const ExplodedNode *> Nodes) { 26672110350909701fcd6b55c636e24a675f0a905feaJordan Rose // The trimmed graph is created in the body of the constructor to ensure 26682110350909701fcd6b55c636e24a675f0a905feaJordan Rose // that the DenseMaps have been initialized already. 2669228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose InterExplodedGraphMap ForwardMap; 26700f3a34fb7fea37ebfbcba8b400ccb697b9559b49Jordan Rose G.reset(OriginalGraph->trim(Nodes, &ForwardMap, &InverseMap)); 26711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 26723106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Find the (first) error node in the trimmed graph. We just need to consult 26731efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose // the node map which maps from nodes in the original graph to nodes 26743106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // in the new graph. 2675228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose llvm::SmallPtrSet<const ExplodedNode *, 32> RemainingNodes; 26763106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 26771efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose for (unsigned i = 0, count = Nodes.size(); i < count; ++i) { 2678228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (const ExplodedNode *NewNode = ForwardMap.lookup(Nodes[i])) { 2679228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose ReportNodes.push_back(std::make_pair(NewNode, i)); 2680228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose RemainingNodes.insert(NewNode); 26813106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 268240406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek } 26831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2684228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose assert(!RemainingNodes.empty() && "No error node found in the trimmed graph"); 2685228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2686228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // Perform a forward BFS to find all the shortest paths. 2687228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose std::queue<const ExplodedNode *> WS; 2688228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2689228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose assert(G->num_roots() == 1); 2690228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose WS.push(*G->roots_begin()); 2691228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose unsigned Priority = 0; 26923106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 26933106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek while (!WS.empty()) { 2694228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose const ExplodedNode *Node = WS.front(); 26953106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek WS.pop(); 26961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 26972110350909701fcd6b55c636e24a675f0a905feaJordan Rose PriorityMapTy::iterator PriorityEntry; 26982110350909701fcd6b55c636e24a675f0a905feaJordan Rose bool IsNew; 26992110350909701fcd6b55c636e24a675f0a905feaJordan Rose llvm::tie(PriorityEntry, IsNew) = 27002110350909701fcd6b55c636e24a675f0a905feaJordan Rose PriorityMap.insert(std::make_pair(Node, Priority)); 2701228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose ++Priority; 27021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 27032110350909701fcd6b55c636e24a675f0a905feaJordan Rose if (!IsNew) { 27042110350909701fcd6b55c636e24a675f0a905feaJordan Rose assert(PriorityEntry->second <= Priority); 27052110350909701fcd6b55c636e24a675f0a905feaJordan Rose continue; 27062110350909701fcd6b55c636e24a675f0a905feaJordan Rose } 27071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2708228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (RemainingNodes.erase(Node)) 2709228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (RemainingNodes.empty()) 2710228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose break; 2711a5f80b2ea6d30c5055c067530d63bb0dcaf937d0Jordan Rose 2712228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose for (ExplodedNode::const_pred_iterator I = Node->succ_begin(), 2713228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose E = Node->succ_end(); 27142110350909701fcd6b55c636e24a675f0a905feaJordan Rose I != E; ++I) 2715228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose WS.push(*I); 2716239b6e47d282bd66c8b559ac47b8b42b34da619eJordan Rose } 27172110350909701fcd6b55c636e24a675f0a905feaJordan Rose 2718228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // Sort the error paths from longest to shortest. 2719228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose std::sort(ReportNodes.begin(), ReportNodes.end(), 2720228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityCompare<true>(PriorityMap)); 2721228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose} 27222110350909701fcd6b55c636e24a675f0a905feaJordan Rose 2723228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rosebool TrimmedGraph::popNextReportGraph(ReportGraph &GraphWrapper) { 2724228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (ReportNodes.empty()) 2725228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return false; 27262110350909701fcd6b55c636e24a675f0a905feaJordan Rose 2727228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose const ExplodedNode *OrigN; 2728228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose llvm::tie(OrigN, GraphWrapper.Index) = ReportNodes.pop_back_val(); 2729228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose assert(PriorityMap.find(OrigN) != PriorityMap.end() && 2730228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose "error node not accessible from root"); 27312110350909701fcd6b55c636e24a675f0a905feaJordan Rose 27322110350909701fcd6b55c636e24a675f0a905feaJordan Rose // Create a new graph with a single path. This is the graph 27332110350909701fcd6b55c636e24a675f0a905feaJordan Rose // that will be returned to the caller. 27342110350909701fcd6b55c636e24a675f0a905feaJordan Rose ExplodedGraph *GNew = new ExplodedGraph(); 27352110350909701fcd6b55c636e24a675f0a905feaJordan Rose GraphWrapper.Graph.reset(GNew); 2736228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose GraphWrapper.BackMap.clear(); 27371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2738228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // Now walk from the error node up the BFS path, always taking the 2739228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // predeccessor with the lowest number. 2740228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose ExplodedNode *Succ = 0; 2741228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose while (true) { 27423106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Create the equivalent node in the new graph with the same state 27433106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // and location. 27443e5ebf1a05603e08f2d0b2b2a5fa9406fe4cfb22Jordan Rose ExplodedNode *NewN = GNew->getNode(OrigN->getLocation(), OrigN->getState(), 27453e5ebf1a05603e08f2d0b2b2a5fa9406fe4cfb22Jordan Rose OrigN->isSink()); 27461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 27473106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Store the mapping to the original node. 2748228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose InterExplodedGraphMap::const_iterator IMitr = InverseMap.find(OrigN); 27493106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek assert(IMitr != InverseMap.end() && "No mapping to original node."); 27501efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose GraphWrapper.BackMap[NewN] = IMitr->second; 27511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 27523106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Link up the new node with the previous node. 2753228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (Succ) 2754228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose Succ->addPredecessor(NewN, *GNew); 2755228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose else 2756228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose GraphWrapper.ErrorNode = NewN; 27571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2758228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose Succ = NewN; 27591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 27603106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Are we at the final node? 2761228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (OrigN->pred_empty()) { 2762228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose GNew->addRoot(NewN); 27633106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 27643106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 27651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2766228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // Find the next predeccessor node. We choose the node that is marked 27672110350909701fcd6b55c636e24a675f0a905feaJordan Rose // with the lowest BFS number. 2768228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose OrigN = *std::min_element(OrigN->pred_begin(), OrigN->pred_end(), 2769228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityCompare<false>(PriorityMap)); 27702110350909701fcd6b55c636e24a675f0a905feaJordan Rose } 27712110350909701fcd6b55c636e24a675f0a905feaJordan Rose 2772228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return true; 27732110350909701fcd6b55c636e24a675f0a905feaJordan Rose} 27742110350909701fcd6b55c636e24a675f0a905feaJordan Rose 27752110350909701fcd6b55c636e24a675f0a905feaJordan Rose 27763106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek/// CompactPathDiagnostic - This function postprocesses a PathDiagnostic object 27773106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek/// and collapses PathDiagosticPieces that are expanded by macros. 277877d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenekstatic void CompactPathDiagnostic(PathPieces &path, const SourceManager& SM) { 27792042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek typedef std::vector<std::pair<IntrusiveRefCntPtr<PathDiagnosticMacroPiece>, 27802042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek SourceLocation> > MacroStackTy; 27811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2782c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith typedef std::vector<IntrusiveRefCntPtr<PathDiagnosticPiece> > 27833106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PiecesTy; 27841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 27853106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroStackTy MacroStack; 27863106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PiecesTy Pieces; 27871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2788ed866e73bab7733f5226f84c52edefe23d694b2fTed Kremenek for (PathPieces::const_iterator I = path.begin(), E = path.end(); 27892042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek I!=E; ++I) { 279077d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek 2791ed866e73bab7733f5226f84c52edefe23d694b2fTed Kremenek PathDiagnosticPiece *piece = I->getPtr(); 279277d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek 279377d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek // Recursively compact calls. 279477d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek if (PathDiagnosticCallPiece *call=dyn_cast<PathDiagnosticCallPiece>(piece)){ 279577d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek CompactPathDiagnostic(call->path, SM); 279677d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek } 279777d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek 27983106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Get the location of the PathDiagnosticPiece. 279977d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek const FullSourceLoc Loc = piece->getLocation().asLocation(); 28001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28013106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Determine the instantiation location, which is the location we group 28023106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // related PathDiagnosticPieces. 28031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump SourceLocation InstantiationLoc = Loc.isMacroID() ? 2804402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SM.getExpansionLoc(Loc) : 28053106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek SourceLocation(); 28061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28073106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (Loc.isFileID()) { 28083106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroStack.clear(); 280977d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek Pieces.push_back(piece); 28103106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek continue; 28113106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 2812706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek 28133106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek assert(Loc.isMacroID()); 28141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28153106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Is the PathDiagnosticPiece within the same macro group? 28163106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (!MacroStack.empty() && InstantiationLoc == MacroStack.back().second) { 281777d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek MacroStack.back().first->subPieces.push_back(piece); 28183106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek continue; 28193106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 2820d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek 28213106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // We aren't in the same group. Are we descending into a new macro 28223106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // or are part of an old one? 2823c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<PathDiagnosticMacroPiece> MacroGroup; 2824d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek 28253106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek SourceLocation ParentInstantiationLoc = InstantiationLoc.isMacroID() ? 2826402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SM.getExpansionLoc(Loc) : 28273106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek SourceLocation(); 28281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28293106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Walk the entire macro stack. 28303106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek while (!MacroStack.empty()) { 28313106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (InstantiationLoc == MacroStack.back().second) { 28323106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroGroup = MacroStack.back().first; 28333106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 28343106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 28351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28363106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (ParentInstantiationLoc == MacroStack.back().second) { 28373106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroGroup = MacroStack.back().first; 28383106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 283961f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek } 28401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28413106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroStack.pop_back(); 28426837faa083bebad39aa342f84c2b450fb6410eafTed Kremenek } 28431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28443106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (!MacroGroup || ParentInstantiationLoc == MacroStack.back().second) { 28453106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Create a new macro group and add it to the stack. 2846590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticMacroPiece *NewGroup = 2847590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks new PathDiagnosticMacroPiece( 284877d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek PathDiagnosticLocation::createSingleLocation(piece->getLocation())); 28495a429954aedd8a830a70fcea2cb51561673e4fc3Ted Kremenek 28503106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (MacroGroup) 2851802e02463b880f53a6e645bde78cc412481ce9e0Ted Kremenek MacroGroup->subPieces.push_back(NewGroup); 28523106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek else { 28533106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek assert(InstantiationLoc.isFileID()); 28543106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek Pieces.push_back(NewGroup); 28553106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 28561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28573106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroGroup = NewGroup; 28583106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroStack.push_back(std::make_pair(MacroGroup, InstantiationLoc)); 28597dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek } 28603106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 28613106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Finally, add the PathDiagnosticPiece to the group. 286277d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek MacroGroup->subPieces.push_back(piece); 28633106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 28641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28653106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Now take the pieces and construct a new PathDiagnostic. 286677d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek path.clear(); 28671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 286877d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek for (PiecesTy::iterator I=Pieces.begin(), E=Pieces.end(); I!=E; ++I) 286977d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek path.push_back(*I); 287061f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek} 287161f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 28728347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rosebool GRBugReporter::generatePathDiagnostic(PathDiagnostic& PD, 2873c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticConsumer &PC, 2874c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<BugReport *> &bugReports) { 287540406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek assert(!bugReports.empty()); 28768347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 28779a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose bool HasValid = false; 2878228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose bool HasInvalid = false; 28792f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose SmallVector<const ExplodedNode *, 32> errorNodes; 2880c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek for (ArrayRef<BugReport*>::iterator I = bugReports.begin(), 28819a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose E = bugReports.end(); I != E; ++I) { 28829a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose if ((*I)->isValid()) { 28839a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose HasValid = true; 28849a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose errorNodes.push_back((*I)->getErrorNode()); 28859a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose } else { 2886228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // Keep the errorNodes list in sync with the bugReports list. 2887228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose HasInvalid = true; 28889a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose errorNodes.push_back(0); 28899a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose } 289040406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek } 28911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28929a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose // If all the reports have been marked invalid by a previous path generation, 28939a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose // we're done. 28949a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose if (!HasValid) 28959a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose return false; 28969a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose 28972f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose typedef PathDiagnosticConsumer::PathGenerationScheme PathGenerationScheme; 28982f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose PathGenerationScheme ActiveScheme = PC.getGenerationScheme(); 28992f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 2900af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (ActiveScheme == PathDiagnosticConsumer::Extensive) { 2901d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks AnalyzerOptions &options = getAnalyzerOptions(); 290215676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek if (options.getBooleanOption("path-diagnostics-alternate", false)) { 2903af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek ActiveScheme = PathDiagnosticConsumer::AlternateExtensive; 2904af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 2905af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 2906af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 29071efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose TrimmedGraph TrimG(&getGraph(), errorNodes); 2908228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose ReportGraph ErrorGraph; 29091efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose 2910228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose while (TrimG.popNextReportGraph(ErrorGraph)) { 29112f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Find the BugReport with the original location. 29121efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose assert(ErrorGraph.Index < bugReports.size()); 29131efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose BugReport *R = bugReports[ErrorGraph.Index]; 29142f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose assert(R && "No original report found for sliced graph."); 29152f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose assert(R->isValid() && "Report selected by trimmed graph marked invalid."); 29162f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 29172f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Start building the path diagnostic... 29181efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose PathDiagnosticBuilder PDB(*this, R, ErrorGraph.BackMap, &PC); 29191efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose const ExplodedNode *N = ErrorGraph.ErrorNode; 29202f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 29212f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Register additional node visitors. 29222f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose R->addVisitor(new NilReceiverBRVisitor()); 29232f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose R->addVisitor(new ConditionBRVisitor()); 29242f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose R->addVisitor(new LikelyFalsePositiveSuppressionBRVisitor()); 29252f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 29262f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose BugReport::VisitorList visitors; 29272f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose unsigned origReportConfigToken, finalReportConfigToken; 2928d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek LocationContextMap LCM; 29292f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 29302f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // While generating diagnostics, it's possible the visitors will decide 29312f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // new symbols and regions are interesting, or add other visitors based on 29322f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // the information they find. If they do, we need to regenerate the path 29332f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // based on our new report configuration. 29342f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose do { 29352f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Get a clean copy of all the visitors. 29362f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose for (BugReport::visitor_iterator I = R->visitor_begin(), 29372f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose E = R->visitor_end(); I != E; ++I) 29382f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose visitors.push_back((*I)->clone()); 29392f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 29402f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Clear out the active path from any previous work. 29412f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose PD.resetPath(); 29422f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose origReportConfigToken = R->getConfigurationChangeToken(); 29432f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 29442f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Generate the very last diagnostic piece - the piece is visible before 29452f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // the trace is expanded. 29462f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose PathDiagnosticPiece *LastPiece = 0; 29472f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose for (BugReport::visitor_iterator I = visitors.begin(), E = visitors.end(); 29482f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose I != E; ++I) { 29492f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose if (PathDiagnosticPiece *Piece = (*I)->getEndPath(PDB, N, *R)) { 29502f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose assert (!LastPiece && 29512f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose "There can only be one final piece in a diagnostic."); 29522f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose LastPiece = Piece; 29532f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose } 29543bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose } 295586ff12c8a8a356ca284ca7687749216fbfd74519Anna Zaks 29562f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose if (ActiveScheme != PathDiagnosticConsumer::None) { 29572f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose if (!LastPiece) 29582f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose LastPiece = BugReporterVisitor::getDefaultEndPath(PDB, N, *R); 29592f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose assert(LastPiece); 2960d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose PD.setEndOfPath(LastPiece); 29618347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose } 29622f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 2963d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek // Make sure we get a clean location context map so we don't 2964d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek // hold onto old mappings. 2965d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek LCM.clear(); 2966d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek 29672f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose switch (ActiveScheme) { 2968af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek case PathDiagnosticConsumer::AlternateExtensive: 2969af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek GenerateAlternateExtensivePathDiagnostic(PD, PDB, N, LCM, visitors); 2970af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek break; 29712f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose case PathDiagnosticConsumer::Extensive: 2972d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek GenerateExtensivePathDiagnostic(PD, PDB, N, LCM, visitors); 29732f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose break; 29742f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose case PathDiagnosticConsumer::Minimal: 2975d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek GenerateMinimalPathDiagnostic(PD, PDB, N, LCM, visitors); 29762f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose break; 29772f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose case PathDiagnosticConsumer::None: 29782f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose GenerateVisitorsOnlyPathDiagnostic(PD, PDB, N, visitors); 29792f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose break; 2980d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose } 29813bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 29822f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Clean up the visitors we used. 29832f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose llvm::DeleteContainerPointers(visitors); 29843bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 29852f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Did anything change while generating this path? 29862f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose finalReportConfigToken = R->getConfigurationChangeToken(); 29872f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose } while (finalReportConfigToken != origReportConfigToken); 29883bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 2989228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (!R->isValid()) 29902f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose continue; 2991b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 29922f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Finally, prune the diagnostic path of uninteresting stuff. 29932f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose if (!PD.path.empty()) { 29942f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Remove messages that are basically the same. 29952f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose removeRedundantMsgs(PD.getMutablePieces()); 29962f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 2997d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks if (R->shouldPrunePath() && getAnalyzerOptions().shouldPrunePaths()) { 2998d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek bool stillHasNotes = removeUnneededCalls(PD.getMutablePieces(), R, LCM); 29992f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose assert(stillHasNotes); 30002f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose (void)stillHasNotes; 30012f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose } 30022f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 30032f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose adjustCallLocations(PD.getMutablePieces()); 3004bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 3005bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (ActiveScheme == PathDiagnosticConsumer::AlternateExtensive) { 3006aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek SourceManager &SM = getSourceManager(); 3007aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek 3008aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek // Reduce the number of edges from a very conservative set 3009aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek // to an aesthetically pleasing subset that conveys the 3010aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek // necessary information. 301115676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek OptimizedCallsSet OCS; 3012bb518991ce4298d8662235fc8cb13813f011c18dJordan Rose while (optimizeEdges(PD.getMutablePieces(), SM, OCS, LCM)) {} 3013aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek 3014aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek // Adjust edges into loop conditions to make them more uniform 3015aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek // and aesthetically pleasing. 3016a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek adjustBranchEdges(PD.getMutablePieces(), LCM, SM); 3017bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek } 3018b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek } 3019afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose 30202f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // We found a report and didn't suppress it. 30212f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose return true; 3022ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek } 30238347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 30242f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // We suppressed all the reports in this equivalence class. 3025228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose assert(!HasInvalid && "Inconsistent suppression"); 3026228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose (void)HasInvalid; 30272f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose return false; 30283106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 30291aa44c7c9198796085b77c6bdd7c90030845a688Ted Kremenek 3030cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekvoid BugReporter::Register(BugType *BT) { 30313baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugTypes = F.add(BugTypes, BT); 303276d90c8bf83d071fd1bdbffa6d9f2af87c6bb7b5Ted Kremenek} 303376d90c8bf83d071fd1bdbffa6d9f2af87c6bb7b5Ted Kremenek 3034785950e59424dca7ce0081bebf13c0acd2c4fff6Jordan Rosevoid BugReporter::emitReport(BugReport* R) { 3035cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek // Compute the bug report's hash to determine its equivalence class. 3036cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek llvm::FoldingSetNodeID ID; 3037cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek R->Profile(ID); 30381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 30391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Lookup the equivance class. If there isn't one, create it. 3040cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugType& BT = R->getBugType(); 3041cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek Register(&BT); 3042cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void *InsertPos; 3043404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis BugReportEquivClass* EQ = EQClasses.FindNodeOrInsertPos(ID, InsertPos); 30441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3045cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek if (!EQ) { 3046cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek EQ = new BugReportEquivClass(R); 3047404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis EQClasses.InsertNode(EQ, InsertPos); 30483b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks EQClassesVector.push_back(EQ); 3049cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek } 3050cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek else 3051cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek EQ->AddReport(R); 305261f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek} 305361f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 305406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 305506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek//===----------------------------------------------------------------------===// 305606c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek// Emitting reports in equivalence classes. 305706c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek//===----------------------------------------------------------------------===// 305806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 305906c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremeneknamespace { 3060ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamstruct FRIEC_WLItem { 306106c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek const ExplodedNode *N; 306206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek ExplodedNode::const_succ_iterator I, E; 306306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 306406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek FRIEC_WLItem(const ExplodedNode *n) 306506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek : N(n), I(N->succ_begin()), E(N->succ_end()) {} 306606c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek}; 306706c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek} 306806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 306961f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenekstatic BugReport * 307061f52bd3c524268e25b48a1ed3730aedd6cc8374Ted KremenekFindReportInEquivalenceClass(BugReportEquivClass& EQ, 30715f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVectorImpl<BugReport*> &bugReports) { 307261f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 307306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek BugReportEquivClass::iterator I = EQ.begin(), E = EQ.end(); 307406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek assert(I != E); 30754a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer BugType& BT = I->getBugType(); 307661f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 307740406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek // If we don't need to suppress any of the nodes because they are 307840406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek // post-dominated by a sink, simply add all the nodes in the equivalence class 307940406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek // to 'Nodes'. Any of the reports will serve as a "representative" report. 308061f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek if (!BT.isSuppressOnSink()) { 30814a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer BugReport *R = I; 308261f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek for (BugReportEquivClass::iterator I=EQ.begin(), E=EQ.end(); I!=E; ++I) { 30839c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *N = I->getErrorNode(); 308461f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek if (N) { 30854a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer R = I; 308640406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek bugReports.push_back(R); 308761f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek } 308861f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek } 308906c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek return R; 309061f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek } 309161f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 309206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // For bug reports that should be suppressed when all paths are post-dominated 309306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // by a sink node, iterate through the reports in the equivalence class 309406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // until we find one that isn't post-dominated (if one exists). We use a 309506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // DFS traversal of the ExplodedGraph to find a non-sink node. We could write 309606c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // this as a recursive function, but we don't want to risk blowing out the 309706c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // stack for very long paths. 309840406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek BugReport *exampleReport = 0; 309961f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 310006c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek for (; I != E; ++I) { 31014a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer const ExplodedNode *errorNode = I->getErrorNode(); 310206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 310340406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek if (!errorNode) 310406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek continue; 310540406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek if (errorNode->isSink()) { 3106b219cfc4d75f0a03630b7c4509ef791b7e97b2c8David Blaikie llvm_unreachable( 310706c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek "BugType::isSuppressSink() should not be 'true' for sink end nodes"); 310806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 310961f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // No successors? By definition this nodes isn't post-dominated by a sink. 311040406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek if (errorNode->succ_empty()) { 31114a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer bugReports.push_back(I); 311240406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek if (!exampleReport) 31134a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer exampleReport = I; 311461f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek continue; 311561f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek } 311661f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 311706c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // At this point we know that 'N' is not a sink and it has at least one 311806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // successor. Use a DFS worklist to find a non-sink end-of-path node. 311906c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek typedef FRIEC_WLItem WLItem; 31205f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner typedef SmallVector<WLItem, 10> DFSWorkList; 312106c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek llvm::DenseMap<const ExplodedNode *, unsigned> Visited; 312206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 312306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek DFSWorkList WL; 312440406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek WL.push_back(errorNode); 312540406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek Visited[errorNode] = 1; 312606c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 312706c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek while (!WL.empty()) { 312806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek WLItem &WI = WL.back(); 312906c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek assert(!WI.N->succ_empty()); 313006c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 313106c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek for (; WI.I != WI.E; ++WI.I) { 313206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek const ExplodedNode *Succ = *WI.I; 313306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // End-of-path node? 313406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek if (Succ->succ_empty()) { 313561f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // If we found an end-of-path node that is not a sink. 313661f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek if (!Succ->isSink()) { 31374a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer bugReports.push_back(I); 313840406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek if (!exampleReport) 31394a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer exampleReport = I; 314061f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek WL.clear(); 314161f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek break; 314261f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek } 314306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // Found a sink? Continue on to the next successor. 314406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek continue; 314506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 314606c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // Mark the successor as visited. If it hasn't been explored, 314706c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // enqueue it to the DFS worklist. 314806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek unsigned &mark = Visited[Succ]; 314906c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek if (!mark) { 315006c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek mark = 1; 315106c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek WL.push_back(Succ); 315206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek break; 315306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 315406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 315561f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 315661f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // The worklist may have been cleared at this point. First 315761f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // check if it is empty before checking the last item. 315861f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek if (!WL.empty() && &WL.back() == &WI) 315906c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek WL.pop_back(); 316006c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 316106c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 316206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 316361f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // ExampleReport will be NULL if all the nodes in the equivalence class 316461f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // were post-dominated by sinks. 316540406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek return exampleReport; 316661f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek} 3167e0a58073b76fc016325a35152533b8468df2bf4aTed Kremenek 3168cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekvoid BugReporter::FlushReport(BugReportEquivClass& EQ) { 31695f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<BugReport*, 10> bugReports; 317040406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek BugReport *exampleReport = FindReportInEquivalenceClass(EQ, bugReports); 3171c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek if (exampleReport) { 3172c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek const PathDiagnosticConsumers &C = getPathDiagnosticConsumers(); 3173c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek for (PathDiagnosticConsumers::const_iterator I=C.begin(), 3174c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek E=C.end(); I != E; ++I) { 3175c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek FlushReport(exampleReport, **I, bugReports); 3176c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek } 3177c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek } 3178c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 3179c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 3180c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekvoid BugReporter::FlushReport(BugReport *exampleReport, 3181c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticConsumer &PD, 3182c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<BugReport*> bugReports) { 31831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3184cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek // FIXME: Make sure we use the 'R' for the path that was actually used. 31851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Probably doesn't make a difference in practice. 318640406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek BugType& BT = exampleReport->getBugType(); 31871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 31886f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<PathDiagnostic> 318907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek D(new PathDiagnostic(exampleReport->getDeclWithIssue(), 319007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek exampleReport->getBugType().getName(), 31913a46f5fd1709f6df03bbb8b0abf84052dc0f39ffJordan Rose exampleReport->getDescription(), 31923a46f5fd1709f6df03bbb8b0abf84052dc0f39ffJordan Rose exampleReport->getShortDescription(/*Fallback=*/false), 319397bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks BT.getCategory(), 319497bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks exampleReport->getUniqueingLocation(), 319597bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks exampleReport->getUniqueingDecl())); 3196d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek 3197cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose MaxBugClassSize = std::max(bugReports.size(), 3198cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose static_cast<size_t>(MaxBugClassSize)); 3199cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose 3200c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek // Generate the full path diagnostic, using the generation scheme 3201d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // specified by the PathDiagnosticConsumer. Note that we have to generate 3202d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // path diagnostics even for consumers which do not support paths, because 3203d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // the BugReporterVisitors may mark this bug as a false positive. 3204d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose if (!bugReports.empty()) 3205d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose if (!generatePathDiagnostic(*D.get(), PD, bugReports)) 3206d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose return; 32073148eb4a75f70f2636075c364d03104223f004d3Ted Kremenek 3208cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose MaxValidBugClassSize = std::max(bugReports.size(), 3209cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose static_cast<size_t>(MaxValidBugClassSize)); 3210cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose 3211d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks // Examine the report and see if the last piece is in a header. Reset the 3212d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks // report location to the last piece in the main source file. 3213d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks AnalyzerOptions& Opts = getAnalyzerOptions(); 3214d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks if (Opts.shouldReportIssuesInMainSourceFile() && !Opts.AnalyzeAll) 3215d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks D->resetDiagnosticLocationToMainFile(); 3216d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks 3217c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek // If the path is empty, generate a single step path with the location 3218c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek // of the issue. 3219802e02463b880f53a6e645bde78cc412481ce9e0Ted Kremenek if (D->path.empty()) { 3220c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticLocation L = exampleReport->getLocation(getSourceManager()); 3221c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticPiece *piece = 3222c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek new PathDiagnosticEventPiece(L, exampleReport->getDescription()); 3223c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek BugReport::ranges_iterator Beg, End; 3224c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek llvm::tie(Beg, End) = exampleReport->getRanges(); 322507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek for ( ; Beg != End; ++Beg) 322607189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek piece->addRange(*Beg); 32273a46f5fd1709f6df03bbb8b0abf84052dc0f39ffJordan Rose D->setEndOfPath(piece); 32283148eb4a75f70f2636075c364d03104223f004d3Ted Kremenek } 32291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3230c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek // Get the meta data. 3231c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek const BugReport::ExtraTextList &Meta = exampleReport->getExtraText(); 3232c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek for (BugReport::ExtraTextList::const_iterator i = Meta.begin(), 3233c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek e = Meta.end(); i != e; ++i) { 3234c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek D->addMeta(*i); 3235c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek } 3236c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 3237c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PD.HandlePathDiagnostic(D.take()); 323861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek} 323957202071e477530e9348bc76671ee369b2399b92Ted Kremenek 324007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenekvoid BugReporter::EmitBasicReport(const Decl *DeclWithIssue, 324107189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek StringRef name, 32425f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner StringRef category, 3243590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef str, PathDiagnosticLocation Loc, 32448c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek SourceRange* RBeg, unsigned NumRanges) { 32451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3246404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // 'BT' is owned by BugReporter. 3247404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis BugType *BT = getBugTypeForName(name, category); 3248590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks BugReport *R = new BugReport(*BT, str, Loc); 324907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek R->setDeclWithIssue(DeclWithIssue); 3250cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek for ( ; NumRanges > 0 ; --NumRanges, ++RBeg) R->addRange(*RBeg); 3251785950e59424dca7ce0081bebf13c0acd2c4fff6Jordan Rose emitReport(R); 3252cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek} 3253404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 32545f9e272e632e951b1efe824cd16acb4d96077930Chris LattnerBugType *BugReporter::getBugTypeForName(StringRef name, 32555f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner StringRef category) { 3256f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith SmallString<136> fullDesc; 3257404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::raw_svector_ostream(fullDesc) << name << ":" << category; 3258404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::StringMapEntry<BugType *> & 3259404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis entry = StrBugTypes.GetOrCreateValue(fullDesc); 3260404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis BugType *BT = entry.getValue(); 3261404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis if (!BT) { 3262404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis BT = new BugType(name, category); 3263404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis entry.setValue(BT); 3264404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis } 3265404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis return BT; 3266404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis} 3267