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 159b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/BugReporter/BugReporter.h" 1661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek#include "clang/AST/ASTContext.h" 17c35fb7d67d515659ad2325b4f6ec97c9fe64fb63Benjamin Kramer#include "clang/AST/DeclObjC.h" 1861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek#include "clang/AST/Expr.h" 19cff15128c6c089bd6fae841b80680e6f5afbf0bfReid Kleckner#include "clang/AST/ExprCXX.h" 2000605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek#include "clang/AST/ParentMap.h" 21cff15128c6c089bd6fae841b80680e6f5afbf0bfReid Kleckner#include "clang/AST/StmtCXX.h" 22651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines#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/STLExtras.h" 3255fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "llvm/ADT/SmallString.h" 33cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose#include "llvm/ADT/Statistic.h" 3455fc873017f10f6f566b182b70f6fc22aefa3464Chandler Carruth#include "llvm/Support/raw_ostream.h" 35651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines#include <memory> 3610aa55410bbecbb658ce14a5f801d50cf06d12dfTed Kremenek#include <queue> 3761f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 3861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekusing namespace clang; 399ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremenekusing namespace ento; 4061f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 416bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines#define DEBUG_TYPE "BugReporter" 426bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 43cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan RoseSTATISTIC(MaxBugClassSize, 44cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose "The maximum number of bug reports in the same equivalence class"); 45cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan RoseSTATISTIC(MaxValidBugClassSize, 46cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose "The maximum number of bug reports in the same equivalence class " 47cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose "where at least one report is valid (not suppressed)"); 48cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose 498966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed KremenekBugReporterVisitor::~BugReporterVisitor() {} 501b431023814196f87515a540ebcb9e9f1a9176a1Ted Kremenek 5199ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikievoid BugReporterContext::anchor() {} 5299ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie 53cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 543106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// Helper routines for walking the ExplodedGraph and fetching statements. 55cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 5661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 579c378f705405d37f49795d5e915989de774fe11fTed Kremenekstatic const Stmt *GetPreviousStmt(const ExplodedNode *N) { 580f8579274a010f360a371b53101859d9d6052314Anna Zaks for (N = N->getFirstPred(); N; N = N->getFirstPred()) 590f8579274a010f360a371b53101859d9d6052314Anna Zaks if (const Stmt *S = PathDiagnosticLocation::getStmt(N)) 60b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek return S; 611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 626bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return nullptr; 63b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek} 64b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek 655f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenekstatic inline const Stmt* 669c378f705405d37f49795d5e915989de774fe11fTed KremenekGetCurrentOrPreviousStmt(const ExplodedNode *N) { 670f8579274a010f360a371b53101859d9d6052314Anna Zaks if (const Stmt *S = PathDiagnosticLocation::getStmt(N)) 68b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek return S; 691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 70b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek return GetPreviousStmt(N); 71b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek} 721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 73b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek//===----------------------------------------------------------------------===// 74c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek// Diagnostic cleanup. 75c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek//===----------------------------------------------------------------------===// 76c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek 77b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenekstatic PathDiagnosticEventPiece * 78b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted KremenekeventsDescribeSameCondition(PathDiagnosticEventPiece *X, 79b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek PathDiagnosticEventPiece *Y) { 80b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek // Prefer diagnostics that come from ConditionBRVisitor over 81b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek // those that came from TrackConstraintBRVisitor. 82b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek const void *tagPreferred = ConditionBRVisitor::getTag(); 83b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek const void *tagLesser = TrackConstraintBRVisitor::getTag(); 8487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 85b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek if (X->getLocation() != Y->getLocation()) 866bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return nullptr; 876bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 88b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek if (X->getTag() == tagPreferred && Y->getTag() == tagLesser) 89b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek return X; 9087d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 91b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek if (Y->getTag() == tagPreferred && X->getTag() == tagLesser) 92b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek return Y; 936bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 946bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return nullptr; 95b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek} 96b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 973800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek/// An optimization pass over PathPieces that removes redundant diagnostics 983800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek/// generated by both ConditionBRVisitor and TrackConstraintBRVisitor. Both 993800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek/// BugReporterVisitors use different methods to generate diagnostics, with 1003800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek/// one capable of emitting diagnostics in some cases but not in others. This 1013800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek/// can lead to redundant diagnostic pieces at the same point in a path. 1023800165e56107df7430520aa98afdf7065db2dd2Ted Kremenekstatic void removeRedundantMsgs(PathPieces &path) { 103b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek unsigned N = path.size(); 104b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek if (N < 2) 105b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek return; 1063800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek // NOTE: this loop intentionally is not using an iterator. Instead, we 1073800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek // are streaming the path and modifying it in place. This is done by 1083800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek // grabbing the front, processing it, and if we decide to keep it append 1093800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek // it to the end of the path. The entire path is processed in this way. 110b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek for (unsigned i = 0; i < N; ++i) { 111b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek IntrusiveRefCntPtr<PathDiagnosticPiece> piece(path.front()); 112b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek path.pop_front(); 11387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 114b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek switch (piece->getKind()) { 115b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek case clang::ento::PathDiagnosticPiece::Call: 1163800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek removeRedundantMsgs(cast<PathDiagnosticCallPiece>(piece)->path); 117b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek break; 118b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek case clang::ento::PathDiagnosticPiece::Macro: 1193800165e56107df7430520aa98afdf7065db2dd2Ted Kremenek removeRedundantMsgs(cast<PathDiagnosticMacroPiece>(piece)->subPieces); 120b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek break; 121b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek case clang::ento::PathDiagnosticPiece::ControlFlow: 122b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek break; 123b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek case clang::ento::PathDiagnosticPiece::Event: { 124b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek if (i == N-1) 125b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek break; 12687d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 127b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek if (PathDiagnosticEventPiece *nextEvent = 128c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines dyn_cast<PathDiagnosticEventPiece>(path.front().get())) { 129b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek PathDiagnosticEventPiece *event = 130b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek cast<PathDiagnosticEventPiece>(piece); 131b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek // Check to see if we should keep one of the two pieces. If we 132b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek // come up with a preference, record which piece to keep, and consume 133b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek // another piece from the path. 134b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek if (PathDiagnosticEventPiece *pieceToKeep = 135b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek eventsDescribeSameCondition(event, nextEvent)) { 136b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek piece = pieceToKeep; 137b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek path.pop_front(); 138b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek ++i; 139b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek } 140b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek } 141b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek break; 142b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek } 143b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek } 144b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek path.push_back(piece); 145b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek } 146b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek} 147b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 148d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek/// A map from PathDiagnosticPiece to the LocationContext of the inlined 149d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek/// function call it represents. 150bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenektypedef llvm::DenseMap<const PathPieces *, const LocationContext *> 151d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek LocationContextMap; 152d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek 153c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek/// Recursively scan through a path and prune out calls and macros pieces 154c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek/// that aren't needed. Return true if afterwards the path contains 155afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose/// "interesting stuff" which means it shouldn't be pruned from the parent path. 156d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenekstatic bool removeUnneededCalls(PathPieces &pieces, BugReport *R, 157d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek LocationContextMap &LCM) { 158c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek bool containsSomethingInteresting = false; 159c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek const unsigned N = pieces.size(); 16087d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 161c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek for (unsigned i = 0 ; i < N ; ++i) { 162c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek // Remove the front piece from the path. If it is still something we 163c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek // want to keep once we are done, we will push it back on the end. 164c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek IntrusiveRefCntPtr<PathDiagnosticPiece> piece(pieces.front()); 165c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek pieces.pop_front(); 16687d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 167725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek switch (piece->getKind()) { 168725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek case PathDiagnosticPiece::Call: { 169725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek PathDiagnosticCallPiece *call = cast<PathDiagnosticCallPiece>(piece); 17080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Check if the location context is interesting. 171bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek assert(LCM.count(&call->path)); 172bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (R->isInteresting(LCM[&call->path])) { 17380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks containsSomethingInteresting = true; 17480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 17580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 176368f3b070e8cb657a65bfa443d60256676d269e7Jordan Rose 177d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek if (!removeUnneededCalls(call->path, R, LCM)) 178368f3b070e8cb657a65bfa443d60256676d269e7Jordan Rose continue; 17987d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 180725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek containsSomethingInteresting = true; 181725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek break; 182725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek } 183725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek case PathDiagnosticPiece::Macro: { 184725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek PathDiagnosticMacroPiece *macro = cast<PathDiagnosticMacroPiece>(piece); 185d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek if (!removeUnneededCalls(macro->subPieces, R, LCM)) 186725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek continue; 187c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek containsSomethingInteresting = true; 188725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek break; 189725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek } 190725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek case PathDiagnosticPiece::Event: { 191725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek PathDiagnosticEventPiece *event = cast<PathDiagnosticEventPiece>(piece); 19287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 193725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek // We never throw away an event, but we do throw it away wholesale 194725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek // as part of a path if we throw the entire path away. 19522505ef15e32db31a4f834a387cf73a913bc8f66Ted Kremenek containsSomethingInteresting |= !event->isPrunable(); 196725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek break; 197725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek } 198725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek case PathDiagnosticPiece::ControlFlow: 199725167443808efdc39a99f4eb132a0ae64ac5118Ted Kremenek break; 200c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek } 20187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 202c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek pieces.push_back(piece); 203c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek } 20487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 205c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek return containsSomethingInteresting; 206c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek} 207c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek 208d474da062565596015558856333423199aed5eb1Jordan Rose/// Returns true if the given decl has been implicitly given a body, either by 209d474da062565596015558856333423199aed5eb1Jordan Rose/// the analyzer or by the compiler proper. 210d474da062565596015558856333423199aed5eb1Jordan Rosestatic bool hasImplicitBody(const Decl *D) { 211d474da062565596015558856333423199aed5eb1Jordan Rose assert(D); 212d474da062565596015558856333423199aed5eb1Jordan Rose return D->isImplicit() || !D->hasBody(); 213d474da062565596015558856333423199aed5eb1Jordan Rose} 214d474da062565596015558856333423199aed5eb1Jordan Rose 215afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose/// Recursively scan through a path and make sure that all call pieces have 21687d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar/// valid locations. 2176bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hinesstatic void 2186bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen HinesadjustCallLocations(PathPieces &Pieces, 2196bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines PathDiagnosticLocation *LastCallLocation = nullptr) { 220afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose for (PathPieces::iterator I = Pieces.begin(), E = Pieces.end(); I != E; ++I) { 221ed866e73bab7733f5226f84c52edefe23d694b2fTed Kremenek PathDiagnosticCallPiece *Call = dyn_cast<PathDiagnosticCallPiece>(*I); 222afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose 223afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose if (!Call) { 224ed866e73bab7733f5226f84c52edefe23d694b2fTed Kremenek assert((*I)->getLocation().asLocation().isValid()); 225afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose continue; 226afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose } 227afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose 228afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose if (LastCallLocation) { 229d474da062565596015558856333423199aed5eb1Jordan Rose bool CallerIsImplicit = hasImplicitBody(Call->getCaller()); 230d474da062565596015558856333423199aed5eb1Jordan Rose if (CallerIsImplicit || !Call->callEnter.asLocation().isValid()) 231afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose Call->callEnter = *LastCallLocation; 232d474da062565596015558856333423199aed5eb1Jordan Rose if (CallerIsImplicit || !Call->callReturn.asLocation().isValid()) 233afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose Call->callReturn = *LastCallLocation; 234afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose } 235afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose 236afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose // Recursively clean out the subclass. Keep this call around if 237afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose // it contains any informative diagnostics. 238afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose PathDiagnosticLocation *ThisCallLocation; 239187f8bd88bfc92cf3fea62b7d8db5f92edce410aJordan Rose if (Call->callEnterWithin.asLocation().isValid() && 240d474da062565596015558856333423199aed5eb1Jordan Rose !hasImplicitBody(Call->getCallee())) 241afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose ThisCallLocation = &Call->callEnterWithin; 242afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose else 243afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose ThisCallLocation = &Call->callEnter; 244afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose 245afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose assert(ThisCallLocation && "Outermost call has an invalid location"); 246afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose adjustCallLocations(Call->path, ThisCallLocation); 247afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose } 248afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose} 249afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose 250d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose/// Remove edges in and out of C++ default initializer expressions. These are 251d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose/// for fields that have in-class initializers, as opposed to being initialized 252d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose/// explicitly in a constructor or braced list. 253d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rosestatic void removeEdgesToDefaultInitializers(PathPieces &Pieces) { 254d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose for (PathPieces::iterator I = Pieces.begin(), E = Pieces.end(); I != E;) { 255d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose if (PathDiagnosticCallPiece *C = dyn_cast<PathDiagnosticCallPiece>(*I)) 256d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose removeEdgesToDefaultInitializers(C->path); 257d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose 258d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose if (PathDiagnosticMacroPiece *M = dyn_cast<PathDiagnosticMacroPiece>(*I)) 259d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose removeEdgesToDefaultInitializers(M->subPieces); 260d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose 261d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose if (PathDiagnosticControlFlowPiece *CF = 262d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose dyn_cast<PathDiagnosticControlFlowPiece>(*I)) { 263d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose const Stmt *Start = CF->getStartLocation().asStmt(); 264d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose const Stmt *End = CF->getEndLocation().asStmt(); 265d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose if (Start && isa<CXXDefaultInitExpr>(Start)) { 266d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose I = Pieces.erase(I); 267d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose continue; 268d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose } else if (End && isa<CXXDefaultInitExpr>(End)) { 269651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines PathPieces::iterator Next = std::next(I); 270d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose if (Next != E) { 271d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose if (PathDiagnosticControlFlowPiece *NextCF = 272d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose dyn_cast<PathDiagnosticControlFlowPiece>(*Next)) { 273d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose NextCF->setStartLocation(CF->getStartLocation()); 274d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose } 275d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose } 276d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose I = Pieces.erase(I); 277d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose continue; 278d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose } 279d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose } 280d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose 281d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose I++; 282d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose } 283d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose} 284d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose 2856838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks/// Remove all pieces with invalid locations as these cannot be serialized. 2866838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks/// We might have pieces with invalid locations as a result of inlining Body 2876838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks/// Farm generated functions. 2886838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaksstatic void removePiecesWithInvalidLocations(PathPieces &Pieces) { 28957c8736e7dce5e63b4e1665d2c4fcf6e6ef959d0Anna Zaks for (PathPieces::iterator I = Pieces.begin(), E = Pieces.end(); I != E;) { 2906838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks if (PathDiagnosticCallPiece *C = dyn_cast<PathDiagnosticCallPiece>(*I)) 2916838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks removePiecesWithInvalidLocations(C->path); 2926838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks 2936838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks if (PathDiagnosticMacroPiece *M = dyn_cast<PathDiagnosticMacroPiece>(*I)) 2946838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks removePiecesWithInvalidLocations(M->subPieces); 2956838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks 2966838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks if (!(*I)->getLocation().isValid() || 2976838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks !(*I)->getLocation().asLocation().isValid()) { 29857c8736e7dce5e63b4e1665d2c4fcf6e6ef959d0Anna Zaks I = Pieces.erase(I); 2996838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks continue; 3006838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks } 30157c8736e7dce5e63b4e1665d2c4fcf6e6ef959d0Anna Zaks I++; 3026838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks } 3036838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks} 3046838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks 305c89f4b05721f53cfbaf32fc0c4919a4616e68440Ted Kremenek//===----------------------------------------------------------------------===// 3063106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// PathDiagnosticBuilder and its associated routines and helper objects. 307b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek//===----------------------------------------------------------------------===// 308b479dadea93b93d3f0a335c3518b703f140b3f50Ted Kremenek 309babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremeneknamespace { 310ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass NodeMapClosure : public BugReport::NodeResolver { 311c9963132736782d0c9178c744b3e2307cfb98a08Jordan Rose InterExplodedGraphMap &M; 3127dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenekpublic: 313c9963132736782d0c9178c744b3e2307cfb98a08Jordan Rose NodeMapClosure(InterExplodedGraphMap &m) : M(m) {} 3141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 315651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines const ExplodedNode *getOriginalNode(const ExplodedNode *N) override { 316c9963132736782d0c9178c744b3e2307cfb98a08Jordan Rose return M.lookup(N); 3177dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek } 3187dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek}; 3191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 320ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass PathDiagnosticBuilder : public BugReporterContext { 3217dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek BugReport *R; 322ef3643fbbbf66247c5e205497fae0f46e240c143David Blaikie PathDiagnosticConsumer *PDC; 3237dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek NodeMapClosure NMC; 3241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 32559950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek const LocationContext *LC; 32687d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 3278966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek PathDiagnosticBuilder(GRBugReporter &br, 328c9963132736782d0c9178c744b3e2307cfb98a08Jordan Rose BugReport *r, InterExplodedGraphMap &Backmap, 329ef3643fbbbf66247c5e205497fae0f46e240c143David Blaikie PathDiagnosticConsumer *pdc) 3308966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek : BugReporterContext(br), 33159950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek R(r), PDC(pdc), NMC(Backmap), LC(r->getErrorNode()->getLocationContext()) 33259950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek {} 3331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3349c378f705405d37f49795d5e915989de774fe11fTed Kremenek PathDiagnosticLocation ExecutionContinues(const ExplodedNode *N); 3351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3369c378f705405d37f49795d5e915989de774fe11fTed Kremenek PathDiagnosticLocation ExecutionContinues(llvm::raw_string_ostream &os, 3379c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *N); 3381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3398e6431adab313e283a992698f6fc7afe62420999Anna Zaks BugReport *getBugReport() { return R; } 3408e6431adab313e283a992698f6fc7afe62420999Anna Zaks 341212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care Decl const &getCodeDecl() { return R->getErrorNode()->getCodeDecl(); } 34287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 34359950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek ParentMap& getParentMap() { return LC->getParentMap(); } 3441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 345c3f83ad7adaff2623986aa1c3e57833babd03d50Ted Kremenek const Stmt *getParent(const Stmt *S) { 346c3f83ad7adaff2623986aa1c3e57833babd03d50Ted Kremenek return getParentMap().getParent(S); 347c3f83ad7adaff2623986aa1c3e57833babd03d50Ted Kremenek } 3481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 349651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines NodeMapClosure& getNodeResolver() override { return NMC; } 3507297134f128423fce2e88f92421ed135bded7d4eDouglas Gregor 351d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek PathDiagnosticLocation getEnclosingStmtLocation(const Stmt *S); 3521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 353ef3643fbbbf66247c5e205497fae0f46e240c143David Blaikie PathDiagnosticConsumer::PathGenerationScheme getGenerationScheme() const { 354ef3643fbbbf66247c5e205497fae0f46e240c143David Blaikie return PDC ? PDC->getGenerationScheme() : PathDiagnosticConsumer::Extensive; 3557dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek } 3567dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek 357babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek bool supportsLogicalOpControlFlow() const { 358babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek return PDC ? PDC->supportsLogicalOpControlFlow() : true; 3591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 360babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek}; 361babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek} // end anonymous namespace 362babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek 36300605e0f011ed99225a22026344c5fc1b3212cd7Ted KremenekPathDiagnosticLocation 3649c378f705405d37f49795d5e915989de774fe11fTed KremenekPathDiagnosticBuilder::ExecutionContinues(const ExplodedNode *N) { 3650f8579274a010f360a371b53101859d9d6052314Anna Zaks if (const Stmt *S = PathDiagnosticLocation::getNextStmt(N)) 36659950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek return PathDiagnosticLocation(S, getSourceManager(), LC); 36700605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek 3680cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks return PathDiagnosticLocation::createDeclEnd(N->getLocationContext(), 3690cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks getSourceManager()); 370082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek} 3711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 37200605e0f011ed99225a22026344c5fc1b3212cd7Ted KremenekPathDiagnosticLocation 3739c378f705405d37f49795d5e915989de774fe11fTed KremenekPathDiagnosticBuilder::ExecutionContinues(llvm::raw_string_ostream &os, 3749c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *N) { 375babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek 376143ca222583a4a355fdc89af852deef287499300Ted Kremenek // Slow, but probably doesn't matter. 377b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek if (os.str().empty()) 378b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek os << ' '; 3791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 38000605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek const PathDiagnosticLocation &Loc = ExecutionContinues(N); 3811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 38200605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek if (Loc.asStmt()) 383b697b100f2354ac84b7a0785cab9481e8bfdcf23Ted Kremenek os << "Execution continues on line " 384642116259e8df6286063a17361c20e95b5017a0aChandler Carruth << getSourceManager().getExpansionLineNumber(Loc.asLocation()) 3858966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek << '.'; 3864f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek else { 3874f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek os << "Execution jumps to the end of the "; 3884f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek const Decl *D = N->getLocationContext()->getDecl(); 3894f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek if (isa<ObjCMethodDecl>(D)) 3904f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek os << "method"; 3914f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek else if (isa<FunctionDecl>(D)) 3924f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek os << "function"; 3934f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek else { 3944f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek assert(isa<BlockDecl>(D)); 3954f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek os << "anonymous block"; 3964f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek } 3974f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek os << '.'; 3984f1db537722e8d46146cd95f5962a6dcf6e44e54Ted Kremenek } 3991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 400082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek return Loc; 401143ca222583a4a355fdc89af852deef287499300Ted Kremenek} 402143ca222583a4a355fdc89af852deef287499300Ted Kremenek 40396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rosestatic const Stmt *getEnclosingParent(const Stmt *S, const ParentMap &PM) { 404ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek if (isa<Expr>(S) && PM.isConsumedExpr(cast<Expr>(S))) 40596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose return PM.getParentIgnoreParens(S); 4061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 407ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek const Stmt *Parent = PM.getParentIgnoreParens(S); 40896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!Parent) 4096bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return nullptr; 4101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 41196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose switch (Parent->getStmtClass()) { 41296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose case Stmt::ForStmtClass: 41396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose case Stmt::DoStmtClass: 41496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose case Stmt::WhileStmtClass: 41596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose case Stmt::ObjCForCollectionStmtClass: 41649a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose case Stmt::CXXForRangeStmtClass: 41796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose return Parent; 41896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose default: 41996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 42096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 4211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4226bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return nullptr; 423ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek} 424ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek 42596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rosestatic PathDiagnosticLocation 42696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan RosegetEnclosingStmtLocation(const Stmt *S, SourceManager &SMgr, const ParentMap &P, 4279d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose const LocationContext *LC, bool allowNestedContexts) { 42896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!S) 42996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose return PathDiagnosticLocation(); 4301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 43196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose while (const Stmt *Parent = getEnclosingParent(S, P)) { 432af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek switch (Parent->getStmtClass()) { 4335fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek case Stmt::BinaryOperatorClass: { 4345fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek const BinaryOperator *B = cast<BinaryOperator>(Parent); 4355fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek if (B->isLogicalOp()) 4369d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose return PathDiagnosticLocation(allowNestedContexts ? B : S, SMgr, LC); 4375fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek break; 4381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 439af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::CompoundStmtClass: 440af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::StmtExprClass: 441220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 4421d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek case Stmt::ChooseExprClass: 4431d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek // Similar to '?' if we are referring to condition, just have the edge 4441d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek // point to the entire choose expression. 4459d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose if (allowNestedContexts || cast<ChooseExpr>(Parent)->getCond() == S) 446220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(Parent, SMgr, LC); 4471d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek else 448220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 44956ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall case Stmt::BinaryConditionalOperatorClass: 4501d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek case Stmt::ConditionalOperatorClass: 4511d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek // For '?', if we are referring to condition, just have the edge point 4521d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek // to the entire '?' expression. 4539d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose if (allowNestedContexts || 4549d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose cast<AbstractConditionalOperator>(Parent)->getCond() == S) 455220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(Parent, SMgr, LC); 4561d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek else 457220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 45849a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose case Stmt::CXXForRangeStmtClass: 45949a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose if (cast<CXXForRangeStmt>(Parent)->getBody() == S) 46049a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose return PathDiagnosticLocation(S, SMgr, LC); 46149a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose break; 462af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::DoStmtClass: 463220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 464af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::ForStmtClass: 465af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek if (cast<ForStmt>(Parent)->getBody() == S) 466220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 4671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump break; 468af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::IfStmtClass: 469af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek if (cast<IfStmt>(Parent)->getCond() != S) 470220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 4718bd4d037d837e7922c3661d6158229da58a03887Ted Kremenek break; 472af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::ObjCForCollectionStmtClass: 473af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek if (cast<ObjCForCollectionStmt>(Parent)->getBody() == S) 474220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 475af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek break; 476af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek case Stmt::WhileStmtClass: 477af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek if (cast<WhileStmt>(Parent)->getCond() != S) 478220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 479af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek break; 480af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek default: 481af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek break; 482af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek } 483af3e3d54e990b385e5a653d2994d7d41427a13b8Ted Kremenek 484d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek S = Parent; 485d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek } 4861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 487d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek assert(S && "Cannot have null Stmt for PathDiagnosticLocation"); 488e88a170da9219ef6a62d2182560c4de2ebffbd59Ted Kremenek 489220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks return PathDiagnosticLocation(S, SMgr, LC); 490d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek} 491d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek 49296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan RosePathDiagnosticLocation 49396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan RosePathDiagnosticBuilder::getEnclosingStmtLocation(const Stmt *S) { 49496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose assert(S && "Null Stmt passed to getEnclosingStmtLocation"); 4959d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose return ::getEnclosingStmtLocation(S, getSourceManager(), getParentMap(), LC, 4969d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose /*allowNestedContexts=*/false); 49796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose} 49896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 499cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 500d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose// "Visitors only" path diagnostic generation algorithm. 501d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose//===----------------------------------------------------------------------===// 502176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hinesstatic bool GenerateVisitorsOnlyPathDiagnostic( 503176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines PathDiagnostic &PD, PathDiagnosticBuilder &PDB, const ExplodedNode *N, 504176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines ArrayRef<std::unique_ptr<BugReporterVisitor>> visitors) { 505d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // All path generation skips the very first node (the error node). 506d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // This is because there is special handling for the end-of-path note. 507d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose N = N->getFirstPred(); 508d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose if (!N) 509d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose return true; 510d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose 511d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose BugReport *R = PDB.getBugReport(); 512d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose while (const ExplodedNode *Pred = N->getFirstPred()) { 513176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines for (auto &V : visitors) { 514d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // Visit all the node pairs, but throw the path pieces away. 515176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines PathDiagnosticPiece *Piece = V->VisitNode(N, Pred, PDB, *R); 516d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose delete Piece; 517d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose } 518d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose 519d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose N = Pred; 520d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose } 521d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose 522d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose return R->isValid(); 523d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose} 524d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose 525d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose//===----------------------------------------------------------------------===// 5263106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// "Minimal" path diagnostic generation algorithm. 527cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 52856a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zakstypedef std::pair<PathDiagnosticCallPiece*, const ExplodedNode*> StackDiagPair; 52956a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zakstypedef SmallVector<StackDiagPair, 6> StackDiagVector; 53056a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks 531368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaksstatic void updateStackPiecesWithMessage(PathDiagnosticPiece *P, 53256a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks StackDiagVector &CallStack) { 533368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks // If the piece contains a special message, add it to all the call 534368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks // pieces on the active stack. 535368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks if (PathDiagnosticEventPiece *ep = 536368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks dyn_cast<PathDiagnosticEventPiece>(P)) { 537368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks 53856a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks if (ep->hasCallStackHint()) 53956a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks for (StackDiagVector::iterator I = CallStack.begin(), 54056a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks E = CallStack.end(); I != E; ++I) { 54156a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks PathDiagnosticCallPiece *CP = I->first; 54256a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks const ExplodedNode *N = I->second; 5438fe4525680ce72e90cee3e58b5654e3ae955447fNAKAMURA Takumi std::string stackMsg = ep->getCallStackMessage(N); 54456a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks 545368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks // The last message on the path to final bug is the most important 546368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks // one. Since we traverse the path backwards, do not add the message 547368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks // if one has been previously added. 54856a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks if (!CP->hasCallStackMessage()) 54956a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks CP->setCallStackMessage(stackMsg); 55056a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks } 551368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks } 552368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks} 553cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 55477d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenekstatic void CompactPathDiagnostic(PathPieces &path, const SourceManager& SM); 55514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 556176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hinesstatic bool GenerateMinimalPathDiagnostic( 557176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines PathDiagnostic &PD, PathDiagnosticBuilder &PDB, const ExplodedNode *N, 558176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines LocationContextMap &LCM, 559176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines ArrayRef<std::unique_ptr<BugReporterVisitor>> visitors) { 5608966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek 5613106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek SourceManager& SMgr = PDB.getSourceManager(); 56259950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek const LocationContext *LC = PDB.LC; 5639c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *NextNode = N->pred_empty() 5646bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines ? nullptr : *(N->pred_begin()); 565368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks 56656a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks StackDiagVector CallStack; 567368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks 5683106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek while (NextNode) { 5691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump N = NextNode; 57059950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek PDB.LC = N->getLocationContext(); 5710f8579274a010f360a371b53101859d9d6052314Anna Zaks NextNode = N->getFirstPred(); 5721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 57361f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek ProgramPoint P = N->getLocation(); 57480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 57580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks do { 5767a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<CallExitEnd> CE = P.getAs<CallExitEnd>()) { 57780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticCallPiece *C = 57880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticCallPiece::construct(N, *CE, SMgr); 579d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek // Record the mapping from call piece to LocationContext. 580bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 58180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(C); 58280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.pushActivePath(&C->path); 58380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks CallStack.push_back(StackDiagPair(C, N)); 58480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 5859373937945e1e075dfa08169eaccc1ad0b31f699Anna Zaks } 586183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose 5877a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<CallEnter> CE = P.getAs<CallEnter>()) { 58880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Flush all locations, and pop the active path. 58980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks bool VisitedEntireCall = PD.isWithinCall(); 59080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.popActivePath(); 59180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 59280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Either we just added a bunch of stuff to the top-level path, or 59380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // we have a previous CallExitEnd. If the former, it means that the 59480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // path terminated within a function call. We must then take the 59580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // current contents of the active path and place it within 59680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // a new PathDiagnosticCallPiece. 59780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticCallPiece *C; 59880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (VisitedEntireCall) { 59980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks C = cast<PathDiagnosticCallPiece>(PD.getActivePath().front()); 60080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } else { 60180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const Decl *Caller = CE->getLocationContext()->getDecl(); 60280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks C = PathDiagnosticCallPiece::construct(PD.getActivePath(), Caller); 603d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek // Record the mapping from call piece to LocationContext. 604bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 60580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 60680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 60780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks C->setCallee(*CE, SMgr); 60880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (!CallStack.empty()) { 60980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks assert(CallStack.back().first == C); 61080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks CallStack.pop_back(); 61180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 61280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 613368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks } 6141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6157a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<BlockEdge> BE = P.getAs<BlockEdge>()) { 61680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const CFGBlock *Src = BE->getSrc(); 61780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const CFGBlock *Dst = BE->getDst(); 61880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const Stmt *T = Src->getTerminator(); 6191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 62080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (!T) 62180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 6221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 62380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticLocation Start = 62480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticLocation::createBegin(T, SMgr, 62580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks N->getLocationContext()); 6261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 62780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks switch (T->getStmtClass()) { 62861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek default: 62961f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek break; 6301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 63161f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek case Stmt::GotoStmtClass: 6321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump case Stmt::IndirectGotoStmtClass: { 6330f8579274a010f360a371b53101859d9d6052314Anna Zaks const Stmt *S = PathDiagnosticLocation::getNextStmt(N); 6341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 63561f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek if (!S) 63680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 6371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 638297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek std::string sbuf; 6391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump llvm::raw_string_ostream os(sbuf); 640d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek const PathDiagnosticLocation &End = PDB.getEnclosingStmtLocation(S); 6411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 64200605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek os << "Control jumps to line " 64380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks << End.asLocation().getExpansionLineNumber(); 64480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 64580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 64661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek break; 64761f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek } 6481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump case Stmt::SwitchStmtClass: { 65061f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek // Figure out what case arm we took. 651297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek std::string sbuf; 652297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek llvm::raw_string_ostream os(sbuf); 6531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6549c378f705405d37f49795d5e915989de774fe11fTed Kremenek if (const Stmt *S = Dst->getLabel()) { 655220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation End(S, SMgr, LC); 6561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6575a429954aedd8a830a70fcea2cb51561673e4fc3Ted Kremenek switch (S->getStmtClass()) { 65880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks default: 65980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << "No cases match in the switch statement. " 66080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks "Control jumps to line " 66180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks << End.asLocation().getExpansionLineNumber(); 66280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 66380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks case Stmt::DefaultStmtClass: 66480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << "Control jumps to the 'default' case at line " 66580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks << End.asLocation().getExpansionLineNumber(); 66680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 66780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 66880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks case Stmt::CaseStmtClass: { 66980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << "Control jumps to 'case "; 67080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const CaseStmt *Case = cast<CaseStmt>(S); 67180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const Expr *LHS = Case->getLHS()->IgnoreParenCasts(); 67280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 67380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Determine if it is an enum. 67480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks bool GetRawInt = true; 67580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 67680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (const DeclRefExpr *DR = dyn_cast<DeclRefExpr>(LHS)) { 67780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // FIXME: Maybe this should be an assertion. Are there cases 67880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // were it is not an EnumConstantDecl? 67980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const EnumConstantDecl *D = 68003509aea098772644bf4662dc1c88634818ceeccZhongxing Xu dyn_cast<EnumConstantDecl>(DR->getDecl()); 6811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 68280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (D) { 68380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks GetRawInt = false; 68480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << *D; 6855a429954aedd8a830a70fcea2cb51561673e4fc3Ted Kremenek } 68680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 6879ec64d6e2fe575b297e1eaa5051efc2983373e25Eli Friedman 68880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (GetRawInt) 68980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << LHS->EvaluateKnownConstInt(PDB.getASTContext()); 6909ec64d6e2fe575b297e1eaa5051efc2983373e25Eli Friedman 69180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks os << ":' at line " 69280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks << End.asLocation().getExpansionLineNumber(); 69380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks break; 69461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek } 69580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 69680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 69780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 69861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek } 699567839273dfc395a459cbe77d5f8d128b9ae85bfTed Kremenek else { 700c3517ebb48a51e146badc08bc3684520c41da6c8Ted Kremenek os << "'Default' branch taken. "; 7011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const PathDiagnosticLocation &End = PDB.ExecutionContinues(os, N); 70280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 70380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 704567839273dfc395a459cbe77d5f8d128b9ae85bfTed Kremenek } 7051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 70661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek break; 70761f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek } 7081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7092673c9ff76ebdb72b7f846e2ff1e0f4256372e19Ted Kremenek case Stmt::BreakStmtClass: 7102673c9ff76ebdb72b7f846e2ff1e0f4256372e19Ted Kremenek case Stmt::ContinueStmtClass: { 711297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek std::string sbuf; 712297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek llvm::raw_string_ostream os(sbuf); 71300605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(os, N); 71480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 71580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 7162673c9ff76ebdb72b7f846e2ff1e0f4256372e19Ted Kremenek break; 7172673c9ff76ebdb72b7f846e2ff1e0f4256372e19Ted Kremenek } 7181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 71980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Determine control-flow for ternary '?'. 72056ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall case Stmt::BinaryConditionalOperatorClass: 721706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek case Stmt::ConditionalOperatorClass: { 722297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek std::string sbuf; 723297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek llvm::raw_string_ostream os(sbuf); 7241d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek os << "'?' condition is "; 7251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 726706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek if (*(Src->succ_begin()+1) == Dst) 727082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek os << "false"; 728706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek else 729082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek os << "true"; 7301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 73100605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 7321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7331d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek if (const Stmt *S = End.asStmt()) 7341d9a23ac34fee297e28361653a72c519cb04a854Ted Kremenek End = PDB.getEnclosingStmtLocation(S); 7351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 73680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 73780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 738babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek break; 739babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek } 7401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 74180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks // Determine control-flow for short-circuited '&&' and '||'. 742babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek case Stmt::BinaryOperatorClass: { 743babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek if (!PDB.supportsLogicalOpControlFlow()) 744babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek break; 7451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 74603509aea098772644bf4662dc1c88634818ceeccZhongxing Xu const BinaryOperator *B = cast<BinaryOperator>(T); 747babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek std::string sbuf; 748babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek llvm::raw_string_ostream os(sbuf); 749babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek os << "Left side of '"; 7501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7512de56d1d0c3a504ad1529de2677628bdfbb95cd4John McCall if (B->getOpcode() == BO_LAnd) { 752f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "&&" << "' is "; 7531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 754f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek if (*(Src->succ_begin()+1) == Dst) { 755f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "false"; 756220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation End(B->getLHS(), SMgr, LC); 7570cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PathDiagnosticLocation Start = 75880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticLocation::createOperatorLoc(B, SMgr); 75980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 76080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 7611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 762f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek else { 763f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "true"; 764220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Start(B->getLHS(), SMgr, LC); 765f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 76680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 76780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 7681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 769babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek } 770babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek else { 7712de56d1d0c3a504ad1529de2677628bdfbb95cd4John McCall assert(B->getOpcode() == BO_LOr); 772f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "||" << "' is "; 7731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 774f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek if (*(Src->succ_begin()+1) == Dst) { 775f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "false"; 776220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation Start(B->getLHS(), SMgr, LC); 777f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 77880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 77980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 780f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek } 781f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek else { 782f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek os << "true"; 783220ac8c175cb1bf9b18d82eefe036995d7a2164dAnna Zaks PathDiagnosticLocation End(B->getLHS(), SMgr, LC); 7840cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PathDiagnosticLocation Start = 78580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PathDiagnosticLocation::createOperatorLoc(B, SMgr); 78680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 78780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 788f5ab8e6eb4b1c14cb3a0f69aad526192794c95ceTed Kremenek } 789babdd7b56d02e2b6924a2c93b061d6a48bb5f0caTed Kremenek } 7901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 791706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek break; 792706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek } 7931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump case Stmt::DoStmtClass: { 795706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek if (*(Src->succ_begin()) == Dst) { 796297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek std::string sbuf; 797297308eda369de400e6ea7057dffeadd9f92e385Ted Kremenek llvm::raw_string_ostream os(sbuf); 7981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 799c3517ebb48a51e146badc08bc3684520c41da6c8Ted Kremenek os << "Loop condition is true. "; 800d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(os, N); 8011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 802d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek if (const Stmt *S = End.asStmt()) 803d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek End = PDB.getEnclosingStmtLocation(S); 8041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 80580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 80680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 807082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek } 808082cb8d7bd9bdb3fe58e8e1a2897c79c4ebcc3a7Ted Kremenek else { 80900605e0f011ed99225a22026344c5fc1b3212cd7Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 8101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 811d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek if (const Stmt *S = End.asStmt()) 812d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek End = PDB.getEnclosingStmtLocation(S); 8131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 81480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 81580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, "Loop condition is false. Exiting loop")); 8163106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 8171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8183106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 8193106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 8201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8213106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek case Stmt::WhileStmtClass: 8221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump case Stmt::ForStmtClass: { 8233106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (*(Src->succ_begin()+1) == Dst) { 8243106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek std::string sbuf; 8253106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek llvm::raw_string_ostream os(sbuf); 8261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8273106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek os << "Loop condition is false. "; 8283106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(os, N); 8293106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (const Stmt *S = End.asStmt()) 8303106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek End = PDB.getEnclosingStmtLocation(S); 8311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 83280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 83380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, os.str())); 8343106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 8353106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek else { 8363106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 8373106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (const Stmt *S = End.asStmt()) 8383106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek End = PDB.getEnclosingStmtLocation(S); 8391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 84080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 84180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, "Loop condition is true. Entering loop body")); 8423106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 8431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8443106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 8453106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 8461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8473106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek case Stmt::IfStmtClass: { 8483106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PathDiagnosticLocation End = PDB.ExecutionContinues(N); 8491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8503106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (const Stmt *S = End.asStmt()) 8513106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek End = PDB.getEnclosingStmtLocation(S); 8521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8533106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (*(Src->succ_begin()+1) == Dst) 85480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 85580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, "Taking false branch")); 8561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump else 85780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 85880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks Start, End, "Taking true branch")); 8591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8603106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 8613106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 86280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 8633106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 86480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } while(0); 8651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 866dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek if (NextNode) { 8678e6431adab313e283a992698f6fc7afe62420999Anna Zaks // Add diagnostic pieces from custom visitors. 8688e6431adab313e283a992698f6fc7afe62420999Anna Zaks BugReport *R = PDB.getBugReport(); 869176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines for (auto &V : visitors) { 870176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines if (PathDiagnosticPiece *p = V->VisitNode(N, NextNode, PDB, *R)) { 8712042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek PD.getActivePath().push_front(p); 872368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks updateStackPiecesWithMessage(p, CallStack); 873368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks } 874dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 8758966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 8763106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 8771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8788347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose if (!PDB.getBugReport()->isValid()) 8798347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose return false; 8808347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 88114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // After constructing the full PathDiagnostic, do a pass over it to compact 88214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // PathDiagnosticPieces that occur within a macro. 88377d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek CompactPathDiagnostic(PD.getMutablePieces(), PDB.getSourceManager()); 8848347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose return true; 8853106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 8863106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 8873106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 8885fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek// "Extensive" PathDiagnostic generation. 8895fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek//===----------------------------------------------------------------------===// 8905fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek 8915fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenekstatic bool IsControlFlowExpr(const Stmt *S) { 8925fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek const Expr *E = dyn_cast<Expr>(S); 8931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8945fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek if (!E) 8955fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek return false; 8961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump E = E->IgnoreParenCasts(); 8981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 89956ca35d396d8692c384c785f9aeebcf22563fe1eJohn McCall if (isa<AbstractConditionalOperator>(E)) 9005fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek return true; 9011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9025fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek if (const BinaryOperator *B = dyn_cast<BinaryOperator>(E)) 9035fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek if (B->isLogicalOp()) 9045fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek return true; 9051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return false; 9075fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek} 9085fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek 90914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremeneknamespace { 910ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass ContextLocation : public PathDiagnosticLocation { 9118f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek bool IsDead; 9128f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenekpublic: 9138f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek ContextLocation(const PathDiagnosticLocation &L, bool isdead = false) 9148f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek : PathDiagnosticLocation(L), IsDead(isdead) {} 9151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump void markDead() { IsDead = true; } 9178f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek bool isDead() const { return IsDead; } 9188f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek}; 9191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 920e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenekstatic PathDiagnosticLocation cleanUpLocation(PathDiagnosticLocation L, 921e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek const LocationContext *LC, 922e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek bool firstCharOnly = false) { 923e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek if (const Stmt *S = L.asStmt()) { 924e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek const Stmt *Original = S; 925e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek while (1) { 926e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek // Adjust the location for some expressions that are best referenced 927e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek // by one of their subexpressions. 928e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek switch (S->getStmtClass()) { 929e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek default: 930e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek break; 931e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::ParenExprClass: 932e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::GenericSelectionExprClass: 933e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek S = cast<Expr>(S)->IgnoreParens(); 934e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek firstCharOnly = true; 935e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek continue; 936e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::BinaryConditionalOperatorClass: 937e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::ConditionalOperatorClass: 938e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek S = cast<AbstractConditionalOperator>(S)->getCond(); 939e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek firstCharOnly = true; 940e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek continue; 941e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::ChooseExprClass: 942e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek S = cast<ChooseExpr>(S)->getCond(); 943e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek firstCharOnly = true; 944e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek continue; 945e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek case Stmt::BinaryOperatorClass: 946e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek S = cast<BinaryOperator>(S)->getLHS(); 947e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek firstCharOnly = true; 948e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek continue; 949e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek } 950e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek 951e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek break; 952e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek } 953e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek 954e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek if (S != Original) 955e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek L = PathDiagnosticLocation(S, L.getManager(), LC); 956e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek } 957e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek 958e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek if (firstCharOnly) 959e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek L = PathDiagnosticLocation::createSingleLocation(L); 96087d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 961e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek return L; 962e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek} 963e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek 964ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamclass EdgeBuilder { 9658f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek std::vector<ContextLocation> CLocs; 9668f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek typedef std::vector<ContextLocation>::iterator iterator; 96714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PathDiagnostic &PD; 96814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PathDiagnosticBuilder &PDB; 96914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PathDiagnosticLocation PrevLoc; 9701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9718f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek bool IsConsumedExpr(const PathDiagnosticLocation &L); 9721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 97314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek bool containsLocation(const PathDiagnosticLocation &Container, 97414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek const PathDiagnosticLocation &Containee); 9751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 97614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PathDiagnosticLocation getContextLocation(const PathDiagnosticLocation &L); 9771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 98014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek void popLocation() { 9818f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek if (!CLocs.back().isDead() && CLocs.back().asLocation().isFileID()) { 9825c7168cbe8a0eabd05e0e12e469090d2cabd27c0Ted Kremenek // For contexts, we only one the first character as the range. 983e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek rawAddEdge(cleanUpLocation(CLocs.back(), PDB.LC, true)); 9845c7168cbe8a0eabd05e0e12e469090d2cabd27c0Ted Kremenek } 98514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek CLocs.pop_back(); 98614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 9871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 98814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenekpublic: 98914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek EdgeBuilder(PathDiagnostic &pd, PathDiagnosticBuilder &pdb) 99014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek : PD(pd), PDB(pdb) { 9911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 992a301a6773db085575ac51e3c966858180390c25bTed Kremenek // If the PathDiagnostic already has pieces, add the enclosing statement 993a301a6773db085575ac51e3c966858180390c25bTed Kremenek // of the first piece as a context as well. 994802e02463b880f53a6e645bde78cc412481ce9e0Ted Kremenek if (!PD.path.empty()) { 995ed866e73bab7733f5226f84c52edefe23d694b2fTed Kremenek PrevLoc = (*PD.path.begin())->getLocation(); 9961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 99714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (const Stmt *S = PrevLoc.asStmt()) 998e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek addExtendedContext(PDB.getEnclosingStmtLocation(S).asStmt()); 99914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 100014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 100114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 100214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek ~EdgeBuilder() { 100314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek while (!CLocs.empty()) popLocation(); 100487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 1005a301a6773db085575ac51e3c966858180390c25bTed Kremenek // Finally, add an initial edge from the start location of the first 1006a301a6773db085575ac51e3c966858180390c25bTed Kremenek // statement (if it doesn't already exist). 10070cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PathDiagnosticLocation L = PathDiagnosticLocation::createDeclBegin( 100859950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek PDB.LC, 10090cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PDB.getSourceManager()); 10100cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks if (L.isValid()) 10110cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks rawAddEdge(L); 101214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 101314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 10145de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek void flushLocations() { 10155de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek while (!CLocs.empty()) 10165de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek popLocation(); 10175de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek PrevLoc = PathDiagnosticLocation(); 10185de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek } 101987d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 10203ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose void addEdge(PathDiagnosticLocation NewLoc, bool alwaysAdd = false, 10213ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose bool IsPostJump = false); 10221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10238bd4d037d837e7922c3661d6158229da58a03887Ted Kremenek void rawAddEdge(PathDiagnosticLocation NewLoc); 10241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 102514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek void addContext(const Stmt *S); 1026183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose void addContext(const PathDiagnosticLocation &L); 1027e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek void addExtendedContext(const Stmt *S); 10281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump}; 102914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} // end anonymous namespace 103014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 103114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 103214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted KremenekPathDiagnosticLocation 103314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted KremenekEdgeBuilder::getContextLocation(const PathDiagnosticLocation &L) { 103414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (const Stmt *S = L.asStmt()) { 103514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (IsControlFlowExpr(S)) 103614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return L; 10371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return PDB.getEnclosingStmtLocation(S); 103914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 10401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 104114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return L; 104214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 104314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 104414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenekbool EdgeBuilder::containsLocation(const PathDiagnosticLocation &Container, 104514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek const PathDiagnosticLocation &Containee) { 104614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 104714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (Container == Containee) 104814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return true; 10491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 105014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (Container.asDecl()) 105114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return true; 10521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 105314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (const Stmt *S = Containee.asStmt()) 105414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (const Stmt *ContainerS = Container.asStmt()) { 105514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek while (S) { 105614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (S == ContainerS) 105714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return true; 105814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek S = PDB.getParent(S); 105914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 106014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return false; 106114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 106214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 106314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // Less accurate: compare using source ranges. 106414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek SourceRange ContainerR = Container.asRange(); 106514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek SourceRange ContaineeR = Containee.asRange(); 10661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 106714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek SourceManager &SM = PDB.getSourceManager(); 1068402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SourceLocation ContainerRBeg = SM.getExpansionLoc(ContainerR.getBegin()); 1069402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SourceLocation ContainerREnd = SM.getExpansionLoc(ContainerR.getEnd()); 1070402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SourceLocation ContaineeRBeg = SM.getExpansionLoc(ContaineeR.getBegin()); 1071402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SourceLocation ContaineeREnd = SM.getExpansionLoc(ContaineeR.getEnd()); 10721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1073642116259e8df6286063a17361c20e95b5017a0aChandler Carruth unsigned ContainerBegLine = SM.getExpansionLineNumber(ContainerRBeg); 1074642116259e8df6286063a17361c20e95b5017a0aChandler Carruth unsigned ContainerEndLine = SM.getExpansionLineNumber(ContainerREnd); 1075642116259e8df6286063a17361c20e95b5017a0aChandler Carruth unsigned ContaineeBegLine = SM.getExpansionLineNumber(ContaineeRBeg); 1076642116259e8df6286063a17361c20e95b5017a0aChandler Carruth unsigned ContaineeEndLine = SM.getExpansionLineNumber(ContaineeREnd); 10771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 107814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek assert(ContainerBegLine <= ContainerEndLine); 10791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert(ContaineeBegLine <= ContaineeEndLine); 10801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 108114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return (ContainerBegLine <= ContaineeBegLine && 108214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek ContainerEndLine >= ContaineeEndLine && 108314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek (ContainerBegLine != ContaineeBegLine || 1084a77c031cb66f75d22672070052cc6e0205289ff8Chandler Carruth SM.getExpansionColumnNumber(ContainerRBeg) <= 1085a77c031cb66f75d22672070052cc6e0205289ff8Chandler Carruth SM.getExpansionColumnNumber(ContaineeRBeg)) && 108614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek (ContainerEndLine != ContaineeEndLine || 1087a77c031cb66f75d22672070052cc6e0205289ff8Chandler Carruth SM.getExpansionColumnNumber(ContainerREnd) >= 10886488dc31153be6f98b404c7860be6c66bb4ec917Ted Kremenek SM.getExpansionColumnNumber(ContaineeREnd))); 108914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 109014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 109114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenekvoid EdgeBuilder::rawAddEdge(PathDiagnosticLocation NewLoc) { 109214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (!PrevLoc.isValid()) { 109314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek PrevLoc = NewLoc; 109414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 109514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 10961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1097e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek const PathDiagnosticLocation &NewLocClean = cleanUpLocation(NewLoc, PDB.LC); 1098e19229be18725bd856410b478c0e63d81ab8e4f5Ted Kremenek const PathDiagnosticLocation &PrevLocClean = cleanUpLocation(PrevLoc, PDB.LC); 10991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1100a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek if (PrevLocClean.asLocation().isInvalid()) { 1101a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek PrevLoc = NewLoc; 1102a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek return; 1103a43df9539644bf1c258e12710cd69d79b0b078cdTed Kremenek } 110487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 11058c8b0ad9601d6ccf3d7b2a3f77a896ef4fb4e6e9Ted Kremenek if (NewLocClean.asLocation() == PrevLocClean.asLocation()) 110614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 11071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 110814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // FIXME: Ignore intra-macro edges for now. 1109402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth if (NewLocClean.asLocation().getExpansionLoc() == 1110402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth PrevLocClean.asLocation().getExpansionLoc()) 111114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 111214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 11132042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece(NewLocClean, PrevLocClean)); 11148c8b0ad9601d6ccf3d7b2a3f77a896ef4fb4e6e9Ted Kremenek PrevLoc = NewLoc; 111514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 111614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 11173ea09a802f973c2726b2a489ae08a4bded93410bJordan Rosevoid EdgeBuilder::addEdge(PathDiagnosticLocation NewLoc, bool alwaysAdd, 11183ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose bool IsPostJump) { 11191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1120a301a6773db085575ac51e3c966858180390c25bTed Kremenek if (!alwaysAdd && NewLoc.asLocation().isMacroID()) 1121a301a6773db085575ac51e3c966858180390c25bTed Kremenek return; 11221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 112314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek const PathDiagnosticLocation &CLoc = getContextLocation(NewLoc); 112414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 112514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek while (!CLocs.empty()) { 11268f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek ContextLocation &TopContextLoc = CLocs.back(); 11271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 112814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // Is the top location context the same as the one for the new location? 112914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (TopContextLoc == CLoc) { 11308f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek if (alwaysAdd) { 11313ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose if (IsConsumedExpr(TopContextLoc)) 11323ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose TopContextLoc.markDead(); 11338f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek 113414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek rawAddEdge(NewLoc); 11358f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek } 113614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 11373ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose if (IsPostJump) 11383ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose TopContextLoc.markDead(); 113914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 114014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 114114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 114214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (containsLocation(TopContextLoc, CLoc)) { 11438f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek if (alwaysAdd) { 114414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek rawAddEdge(NewLoc); 11451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11463ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose if (IsConsumedExpr(CLoc)) { 11473ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose CLocs.push_back(ContextLocation(CLoc, /*IsDead=*/true)); 11488f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek return; 11498f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek } 11508f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek } 11511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11523ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose CLocs.push_back(ContextLocation(CLoc, /*IsDead=*/IsPostJump)); 11531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return; 115414856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 115514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 115614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // Context does not contain the location. Flush it. 115714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek popLocation(); 115814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 11591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11605c7168cbe8a0eabd05e0e12e469090d2cabd27c0Ted Kremenek // If we reach here, there is no enclosing context. Just add the edge. 11615c7168cbe8a0eabd05e0e12e469090d2cabd27c0Ted Kremenek rawAddEdge(NewLoc); 116214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 116314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 11648f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenekbool EdgeBuilder::IsConsumedExpr(const PathDiagnosticLocation &L) { 11658f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek if (const Expr *X = dyn_cast_or_null<Expr>(L.asStmt())) 11668f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek return PDB.getParentMap().isConsumedExpr(X) && !IsControlFlowExpr(X); 11671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11688f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek return false; 11698f9b1b3865cd5814a8c4c768a34d56df6d6c93beTed Kremenek} 11701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1171e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenekvoid EdgeBuilder::addExtendedContext(const Stmt *S) { 1172e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek if (!S) 1173e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek return; 11741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const Stmt *Parent = PDB.getParent(S); 1176e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek while (Parent) { 1177e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek if (isa<CompoundStmt>(Parent)) 1178e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek Parent = PDB.getParent(Parent); 1179e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek else 1180e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek break; 1181e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek } 1182e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek 1183e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek if (Parent) { 1184e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek switch (Parent->getStmtClass()) { 1185e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek case Stmt::DoStmtClass: 1186e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek case Stmt::ObjCAtSynchronizedStmtClass: 1187e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek addContext(Parent); 1188e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek default: 1189e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek break; 1190e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek } 1191e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek } 11921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1193e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek addContext(S); 1194e1baed38437e08fee7ab372ba2579ce22da354c2Ted Kremenek} 11951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 119614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenekvoid EdgeBuilder::addContext(const Stmt *S) { 119714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (!S) 119814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 119914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 120059950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek PathDiagnosticLocation L(S, PDB.getSourceManager(), PDB.LC); 1201183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose addContext(L); 1202183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose} 12031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1204183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rosevoid EdgeBuilder::addContext(const PathDiagnosticLocation &L) { 120514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek while (!CLocs.empty()) { 120614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek const PathDiagnosticLocation &TopContextLoc = CLocs.back(); 120714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 120814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // Is the top location context the same as the one for the new location? 120914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (TopContextLoc == L) 121014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek return; 121114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 121214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek if (containsLocation(TopContextLoc, L)) { 121314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek CLocs.push_back(L); 12141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return; 121514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 121614856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 121714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek // Context does not contain the location. Flush it. 121814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek popLocation(); 121914856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 122014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 122114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek CLocs.push_back(L); 122214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 122314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 122411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// Cone-of-influence: support the reverse propagation of "interesting" symbols 122511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// and values by tracing interesting calculations backwards through evaluated 122611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// expressions along a path. This is probably overly complicated, but the idea 122711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// is that if an expression computed an "interesting" value, the child 122811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// expressions are are also likely to be "interesting" as well (which then 122911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// propagates to the values they in turn compute). This reverse propagation 123011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// is needed to track interesting correlations across function call boundaries, 123111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// where formal arguments bind to actual arguments, etc. This is also needed 123211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// because the constraint solver sometimes simplifies certain symbolic values 123311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// into constants when appropriate, and this complicates reasoning about 123411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek// interesting values. 123511abcecc8c919673237cf37384290a1ef1943976Ted Kremenektypedef llvm::DenseSet<const Expr *> InterestingExprs; 123611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek 123711abcecc8c919673237cf37384290a1ef1943976Ted Kremenekstatic void reversePropagateIntererstingSymbols(BugReport &R, 123811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek InterestingExprs &IE, 123911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const ProgramState *State, 124011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const Expr *Ex, 124111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const LocationContext *LCtx) { 124211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek SVal V = State->getSVal(Ex, LCtx); 124311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (!(R.isInteresting(V) || IE.count(Ex))) 124411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek return; 124587d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 124611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek switch (Ex->getStmtClass()) { 124711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek default: 124811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (!isa<CastExpr>(Ex)) 124911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek break; 125011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek // Fall through. 125111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek case Stmt::BinaryOperatorClass: 125211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek case Stmt::UnaryOperatorClass: { 125387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar for (const Stmt *SubStmt : Ex->children()) { 125487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar if (const Expr *child = dyn_cast_or_null<Expr>(SubStmt)) { 125511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek IE.insert(child); 125611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek SVal ChildV = State->getSVal(child, LCtx); 125711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek R.markInteresting(ChildV); 125811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 125911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 1260651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines break; 126111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 126211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 126387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 126411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek R.markInteresting(V); 126511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek} 126611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek 126711abcecc8c919673237cf37384290a1ef1943976Ted Kremenekstatic void reversePropagateInterestingSymbols(BugReport &R, 126811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek InterestingExprs &IE, 126911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const ProgramState *State, 127011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const LocationContext *CalleeCtx, 127111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const LocationContext *CallerCtx) 127211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek{ 1273852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose // FIXME: Handle non-CallExpr-based CallEvents. 127411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const StackFrameContext *Callee = CalleeCtx->getCurrentStackFrame(); 127511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const Stmt *CallSite = Callee->getCallSite(); 1276852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose if (const CallExpr *CE = dyn_cast_or_null<CallExpr>(CallSite)) { 127711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(CalleeCtx->getDecl())) { 127887d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar FunctionDecl::param_const_iterator PI = FD->param_begin(), 127911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek PE = FD->param_end(); 128011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek CallExpr::const_arg_iterator AI = CE->arg_begin(), AE = CE->arg_end(); 128111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek for (; AI != AE && PI != PE; ++AI, ++PI) { 128211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (const Expr *ArgE = *AI) { 128311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (const ParmVarDecl *PD = *PI) { 128411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek Loc LV = State->getLValue(PD, CalleeCtx); 128511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (R.isInteresting(LV) || R.isInteresting(State->getRawSVal(LV))) 128611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek IE.insert(ArgE); 128711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 128811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 128911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 129011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 129111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 129211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek} 12938185674528423e2504a1fae35c28c24104846510Ted Kremenek 1294b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek//===----------------------------------------------------------------------===// 1295b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek// Functions for determining if a loop was executed 0 times. 1296b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek//===----------------------------------------------------------------------===// 1297b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 1298b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenekstatic bool isLoop(const Stmt *Term) { 12998185674528423e2504a1fae35c28c24104846510Ted Kremenek switch (Term->getStmtClass()) { 13008185674528423e2504a1fae35c28c24104846510Ted Kremenek case Stmt::ForStmtClass: 13018185674528423e2504a1fae35c28c24104846510Ted Kremenek case Stmt::WhileStmtClass: 1302c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek case Stmt::ObjCForCollectionStmtClass: 130349a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose case Stmt::CXXForRangeStmtClass: 1304b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek return true; 13058185674528423e2504a1fae35c28c24104846510Ted Kremenek default: 13068185674528423e2504a1fae35c28c24104846510Ted Kremenek // Note that we intentionally do not include do..while here. 13078185674528423e2504a1fae35c28c24104846510Ted Kremenek return false; 13088185674528423e2504a1fae35c28c24104846510Ted Kremenek } 1309b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek} 13108185674528423e2504a1fae35c28c24104846510Ted Kremenek 1311b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenekstatic bool isJumpToFalseBranch(const BlockEdge *BE) { 13128185674528423e2504a1fae35c28c24104846510Ted Kremenek const CFGBlock *Src = BE->getSrc(); 13138185674528423e2504a1fae35c28c24104846510Ted Kremenek assert(Src->succ_size() == 2); 13148185674528423e2504a1fae35c28c24104846510Ted Kremenek return (*(Src->succ_begin()+1) == BE->getDst()); 13158185674528423e2504a1fae35c28c24104846510Ted Kremenek} 13168185674528423e2504a1fae35c28c24104846510Ted Kremenek 1317b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek/// Return true if the terminator is a loop and the destination is the 1318b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek/// false branch. 1319b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenekstatic bool isLoopJumpPastBody(const Stmt *Term, const BlockEdge *BE) { 1320b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek if (!isLoop(Term)) 1321b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek return false; 1322b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1323b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek // Did we take the false branch? 1324b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek return isJumpToFalseBranch(BE); 1325b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek} 1326b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1327b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenekstatic bool isContainedByStmt(ParentMap &PM, const Stmt *S, const Stmt *SubS) { 1328b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek while (SubS) { 1329b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek if (SubS == S) 1330b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return true; 1331b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek SubS = PM.getParent(SubS); 1332b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek } 1333b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return false; 1334b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek} 1335b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 1336b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenekstatic const Stmt *getStmtBeforeCond(ParentMap &PM, const Stmt *Term, 1337b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek const ExplodedNode *N) { 1338b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek while (N) { 1339b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek Optional<StmtPoint> SP = N->getLocation().getAs<StmtPoint>(); 1340b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek if (SP) { 1341b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek const Stmt *S = SP->getStmt(); 1342b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek if (!isContainedByStmt(PM, Term, S)) 1343b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return S; 1344b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek } 13450f8579274a010f360a371b53101859d9d6052314Anna Zaks N = N->getFirstPred(); 1346b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek } 13476bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return nullptr; 1348b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek} 1349b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 1350b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenekstatic bool isInLoopBody(ParentMap &PM, const Stmt *S, const Stmt *Term) { 13516bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const Stmt *LoopBody = nullptr; 1352b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek switch (Term->getStmtClass()) { 135349a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose case Stmt::CXXForRangeStmtClass: { 135449a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose const CXXForRangeStmt *FR = cast<CXXForRangeStmt>(Term); 135549a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose if (isContainedByStmt(PM, FR->getInc(), S)) 135649a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose return true; 135749a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose if (isContainedByStmt(PM, FR->getLoopVarStmt(), S)) 135849a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose return true; 135949a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose LoopBody = FR->getBody(); 136049a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose break; 136149a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose } 1362b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek case Stmt::ForStmtClass: { 1363b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek const ForStmt *FS = cast<ForStmt>(Term); 1364b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek if (isContainedByStmt(PM, FS->getInc(), S)) 1365b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return true; 1366b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek LoopBody = FS->getBody(); 1367b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek break; 1368b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek } 1369c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek case Stmt::ObjCForCollectionStmtClass: { 1370c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek const ObjCForCollectionStmt *FC = cast<ObjCForCollectionStmt>(Term); 1371c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek LoopBody = FC->getBody(); 1372c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek break; 1373c5b9c8bc6d77175f6d41d898511b1e7b1e2f86f8Ted Kremenek } 1374b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek case Stmt::WhileStmtClass: 1375b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek LoopBody = cast<WhileStmt>(Term)->getBody(); 1376b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek break; 1377b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek default: 1378b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return false; 1379b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek } 1380b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek return isContainedByStmt(PM, LoopBody, S); 1381b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek} 1382b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 1383b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek//===----------------------------------------------------------------------===// 1384b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek// Top-level logic for generating extensive path diagnostics. 1385b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek//===----------------------------------------------------------------------===// 1386b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 1387176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hinesstatic bool GenerateExtensivePathDiagnostic( 1388176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines PathDiagnostic &PD, PathDiagnosticBuilder &PDB, const ExplodedNode *N, 1389176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines LocationContextMap &LCM, 1390176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines ArrayRef<std::unique_ptr<BugReporterVisitor>> visitors) { 139114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek EdgeBuilder EB(PD, PDB); 13920cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks const SourceManager& SM = PDB.getSourceManager(); 139356a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks StackDiagVector CallStack; 139411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek InterestingExprs IE; 139514856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 13966bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const ExplodedNode *NextNode = N->pred_empty() ? nullptr : *(N->pred_begin()); 139714856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek while (NextNode) { 139814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek N = NextNode; 13990f8579274a010f360a371b53101859d9d6052314Anna Zaks NextNode = N->getFirstPred(); 140014856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek ProgramPoint P = N->getLocation(); 140114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 1402dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek do { 14037a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<PostStmt> PS = P.getAs<PostStmt>()) { 140411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (const Expr *Ex = PS->getStmtAs<Expr>()) 140511abcecc8c919673237cf37384290a1ef1943976Ted Kremenek reversePropagateIntererstingSymbols(*PDB.getBugReport(), IE, 1406c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines N->getState().get(), Ex, 140711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek N->getLocationContext()); 140811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 140987d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 14107a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<CallExitEnd> CE = P.getAs<CallExitEnd>()) { 1411183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose const Stmt *S = CE->getCalleeContext()->getCallSite(); 1412183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose if (const Expr *Ex = dyn_cast_or_null<Expr>(S)) { 1413852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose reversePropagateIntererstingSymbols(*PDB.getBugReport(), IE, 1414c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines N->getState().get(), Ex, 1415852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose N->getLocationContext()); 1416852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose } 141787d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 1418183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose PathDiagnosticCallPiece *C = 1419183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose PathDiagnosticCallPiece::construct(N, *CE, SM); 1420bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 1421183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose 14223ea09a802f973c2726b2a489ae08a4bded93410bJordan Rose EB.addEdge(C->callReturn, /*AlwaysAdd=*/true, /*IsPostJump=*/true); 1423183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose EB.flushLocations(); 1424183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose 1425183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose PD.getActivePath().push_front(C); 1426183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose PD.pushActivePath(&C->path); 1427183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose CallStack.push_back(StackDiagPair(C, N)); 14285de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek break; 14295de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek } 143087d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 14312042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek // Pop the call hierarchy if we are done walking the contents 14322042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek // of a function call. 14337a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<CallEnter> CE = P.getAs<CallEnter>()) { 1434097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek // Add an edge to the start of the function. 1435097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek const Decl *D = CE->getCalleeContext()->getDecl(); 1436097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek PathDiagnosticLocation pos = 1437097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek PathDiagnosticLocation::createBegin(D, SM); 1438097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek EB.addEdge(pos); 143987d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 1440097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek // Flush all locations, and pop the active path. 1441183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose bool VisitedEntireCall = PD.isWithinCall(); 14424ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek EB.flushLocations(); 14432042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek PD.popActivePath(); 14444ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek PDB.LC = N->getLocationContext(); 1445097ebb3d8ce55d1f78a3f1e7a0978dbde5ee2898Ted Kremenek 1446183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose // Either we just added a bunch of stuff to the top-level path, or 1447183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose // we have a previous CallExitEnd. If the former, it means that the 14482042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek // path terminated within a function call. We must then take the 14492042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek // current contents of the active path and place it within 14502042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek // a new PathDiagnosticCallPiece. 1451183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose PathDiagnosticCallPiece *C; 1452183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose if (VisitedEntireCall) { 1453183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose C = cast<PathDiagnosticCallPiece>(PD.getActivePath().front()); 1454183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose } else { 1455183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose const Decl *Caller = CE->getLocationContext()->getDecl(); 14569373937945e1e075dfa08169eaccc1ad0b31f699Anna Zaks C = PathDiagnosticCallPiece::construct(PD.getActivePath(), Caller); 1457bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 14589373937945e1e075dfa08169eaccc1ad0b31f699Anna Zaks } 1459852aa0d2c5d2d1faf2d77b5aa3c0848068a342c5Jordan Rose 1460183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose C->setCallee(*CE, SM); 1461183ba8e19d49ab1ae25d3cdd0a19591369c5ab9fJordan Rose EB.addContext(C->getLocation()); 1462368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks 1463368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks if (!CallStack.empty()) { 146456a938ff85a444eb3d30d2634d92ce5b1f6fae56Anna Zaks assert(CallStack.back().first == C); 1465368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks CallStack.pop_back(); 1466368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks } 14672042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek break; 14682042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek } 146987d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 14704ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek // Note that is important that we update the LocationContext 14714ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek // after looking at CallExits. CallExit basically adds an 14724ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek // edge in the *caller*, so we don't want to update the LocationContext 14734ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek // too soon. 14744ba86bc53bb280ba46a08459eda7d283d513b61fTed Kremenek PDB.LC = N->getLocationContext(); 14755de4fdb8de700f95b0b863a9e5a4a508de17a034Ted Kremenek 1476dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek // Block edges. 14777a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<BlockEdge> BE = P.getAs<BlockEdge>()) { 147811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek // Does this represent entering a call? If so, look at propagating 147911abcecc8c919673237cf37384290a1ef1943976Ted Kremenek // interesting symbols across call boundaries. 148011abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (NextNode) { 148111abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const LocationContext *CallerCtx = NextNode->getLocationContext(); 148211abcecc8c919673237cf37384290a1ef1943976Ted Kremenek const LocationContext *CalleeCtx = PDB.LC; 148311abcecc8c919673237cf37384290a1ef1943976Ted Kremenek if (CallerCtx != CalleeCtx) { 148411abcecc8c919673237cf37384290a1ef1943976Ted Kremenek reversePropagateInterestingSymbols(*PDB.getBugReport(), IE, 1485c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines N->getState().get(), 148611abcecc8c919673237cf37384290a1ef1943976Ted Kremenek CalleeCtx, CallerCtx); 148711abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 148811abcecc8c919673237cf37384290a1ef1943976Ted Kremenek } 148987d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 1490dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek // Are we jumping to the head of a loop? Add a special diagnostic. 1491f57a2aa02c0578c5bd834fec0d44c16ad9908620Ted Kremenek if (const Stmt *Loop = BE->getSrc()->getLoopTarget()) { 149259950d3aa54ca5066b1fb08a8c79ebfe10e0919bTed Kremenek PathDiagnosticLocation L(Loop, SM, PDB.LC); 14936bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const CompoundStmt *CS = nullptr; 14941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1495f57a2aa02c0578c5bd834fec0d44c16ad9908620Ted Kremenek if (const ForStmt *FS = dyn_cast<ForStmt>(Loop)) 1496f57a2aa02c0578c5bd834fec0d44c16ad9908620Ted Kremenek CS = dyn_cast<CompoundStmt>(FS->getBody()); 1497f57a2aa02c0578c5bd834fec0d44c16ad9908620Ted Kremenek else if (const WhileStmt *WS = dyn_cast<WhileStmt>(Loop)) 1498f57a2aa02c0578c5bd834fec0d44c16ad9908620Ted Kremenek CS = dyn_cast<CompoundStmt>(WS->getBody()); 14991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1500dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek PathDiagnosticEventPiece *p = 1501dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek new PathDiagnosticEventPiece(L, 150207c015cbcee31f72e2d320ba2c713c046bed42faTed Kremenek "Looping back to the head of the loop"); 15032dd17abf11ae64339fa6bfaa57d76e13a5fbe5b8Ted Kremenek p->setPrunable(true); 15041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1505dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek EB.addEdge(p->getLocation(), true); 15062042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek PD.getActivePath().push_front(p); 15071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1508ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek if (CS) { 15090cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PathDiagnosticLocation BL = 15100cd59482abd8aec9ed1eaad11f5fe9c1e42639f6Anna Zaks PathDiagnosticLocation::createEndBrace(CS, SM); 151107c015cbcee31f72e2d320ba2c713c046bed42faTed Kremenek EB.addEdge(BL); 1512dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 15138bd4d037d837e7922c3661d6158229da58a03887Ted Kremenek } 15148185674528423e2504a1fae35c28c24104846510Ted Kremenek 1515b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek const CFGBlock *BSrc = BE->getSrc(); 1516b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek ParentMap &PM = PDB.getParentMap(); 1517b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek 1518b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek if (const Stmt *Term = BSrc->getTerminator()) { 15198185674528423e2504a1fae35c28c24104846510Ted Kremenek // Are we jumping past the loop body without ever executing the 15208185674528423e2504a1fae35c28c24104846510Ted Kremenek // loop (because the condition was false)? 15217a95de68c093991047ed8d339479ccad51b88663David Blaikie if (isLoopJumpPastBody(Term, &*BE) && 1522b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek !isInLoopBody(PM, 1523b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek getStmtBeforeCond(PM, 1524b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek BSrc->getTerminatorCondition(), 1525b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek N), 1526b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek Term)) { 15278185674528423e2504a1fae35c28c24104846510Ted Kremenek PathDiagnosticLocation L(Term, SM, PDB.LC); 15288185674528423e2504a1fae35c28c24104846510Ted Kremenek PathDiagnosticEventPiece *PE = 1529b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek new PathDiagnosticEventPiece(L, "Loop body executed 0 times"); 15308185674528423e2504a1fae35c28c24104846510Ted Kremenek PE->setPrunable(true); 15318185674528423e2504a1fae35c28c24104846510Ted Kremenek 15328185674528423e2504a1fae35c28c24104846510Ted Kremenek EB.addEdge(PE->getLocation(), true); 15338185674528423e2504a1fae35c28c24104846510Ted Kremenek PD.getActivePath().push_front(PE); 15348185674528423e2504a1fae35c28c24104846510Ted Kremenek } 15358185674528423e2504a1fae35c28c24104846510Ted Kremenek 1536b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek // In any case, add the terminator as the current statement 1537b04a2387ac23adfa063de03844cb16c0d77fb405Ted Kremenek // context for control edges. 1538ddb7babf448822e0f8da07fdf9446cf515d04ad5Ted Kremenek EB.addContext(Term); 15398185674528423e2504a1fae35c28c24104846510Ted Kremenek } 15401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1541dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek break; 15428bd4d037d837e7922c3661d6158229da58a03887Ted Kremenek } 154314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 15447a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<BlockEntrance> BE = P.getAs<BlockEntrance>()) { 1545b07805485c603be3d8011f72611465324c9e664bDavid Blaikie Optional<CFGElement> First = BE->getFirstElement(); 1546b07805485c603be3d8011f72611465324c9e664bDavid Blaikie if (Optional<CFGStmt> S = First ? First->getAs<CFGStmt>() : None) { 1547b07805485c603be3d8011f72611465324c9e664bDavid Blaikie const Stmt *stmt = S->getStmt(); 15483c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek if (IsControlFlowExpr(stmt)) { 1549b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu // Add the proper context for '&&', '||', and '?'. 15503c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek EB.addContext(stmt); 1551b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu } 1552b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu else 15533c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek EB.addExtendedContext(PDB.getEnclosingStmtLocation(stmt).asStmt()); 1554dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 155587d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 1556dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek break; 1557dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 155887d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 155987d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 1560dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } while (0); 15611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1562dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek if (!NextNode) 156314856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek continue; 15641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15658e6431adab313e283a992698f6fc7afe62420999Anna Zaks // Add pieces from custom visitors. 15668e6431adab313e283a992698f6fc7afe62420999Anna Zaks BugReport *R = PDB.getBugReport(); 1567176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines for (auto &V : visitors) { 1568176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines if (PathDiagnosticPiece *p = V->VisitNode(N, NextNode, PDB, *R)) { 15698966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek const PathDiagnosticLocation &Loc = p->getLocation(); 15708966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek EB.addEdge(Loc, true); 15712042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek PD.getActivePath().push_front(p); 1572368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks updateStackPiecesWithMessage(p, CallStack); 1573368a0d565f078666ca5bfb7fe08d04648688e4bcAnna Zaks 15748966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek if (const Stmt *S = Loc.asStmt()) 15751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump EB.addExtendedContext(PDB.getEnclosingStmtLocation(S).asStmt()); 15768966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 15771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 157814856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek } 15798347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 15808347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose return PDB.getBugReport()->isValid(); 158114856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek} 158214856d7b7a2be05ae9a0fd5b2073631994c2ba43Ted Kremenek 1583af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek/// \brief Adds a sanitized control-flow diagnostic edge to a path. 1584af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenekstatic void addEdgeToPath(PathPieces &path, 1585af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticLocation &PrevLoc, 1586af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticLocation NewLoc, 1587af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const LocationContext *LC) { 1588bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (!NewLoc.isValid()) 1589af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek return; 1590af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1591bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek SourceLocation NewLocL = NewLoc.asLocation(); 1592a3f5a5afefca7653349a88472d5ce01ba7226e27Anna Zaks if (NewLocL.isInvalid()) 1593af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek return; 1594af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1595904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose if (!PrevLoc.isValid() || !PrevLoc.asLocation().isValid()) { 1596af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PrevLoc = NewLoc; 1597af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek return; 1598af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1599af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1600574c7cf6d0c8e8f8ecda360ae271d5391c404534Jordan Rose // Ignore self-edges, which occur when there are multiple nodes at the same 1601574c7cf6d0c8e8f8ecda360ae271d5391c404534Jordan Rose // statement. 1602574c7cf6d0c8e8f8ecda360ae271d5391c404534Jordan Rose if (NewLoc.asStmt() && NewLoc.asStmt() == PrevLoc.asStmt()) 1603af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek return; 1604af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1605bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek path.push_front(new PathDiagnosticControlFlowPiece(NewLoc, 1606bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek PrevLoc)); 1607af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PrevLoc = NewLoc; 1608af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek} 1609af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1610e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek/// A customized wrapper for CFGBlock::getTerminatorCondition() 1611e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek/// which returns the element for ObjCForCollectionStmts. 1612e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenekstatic const Stmt *getTerminatorCondition(const CFGBlock *B) { 1613e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek const Stmt *S = B->getTerminatorCondition(); 1614e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek if (const ObjCForCollectionStmt *FS = 1615e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek dyn_cast_or_null<ObjCForCollectionStmt>(S)) 1616e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek return FS->getElement(); 1617e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek return S; 1618e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek} 1619e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek 16200a9350f2411926f4faaeb2ce7d7a9bc1f27751e9Craig Topperstatic const char StrEnteringLoop[] = "Entering loop body"; 16210a9350f2411926f4faaeb2ce7d7a9bc1f27751e9Craig Topperstatic const char StrLoopBodyZero[] = "Loop body executed 0 times"; 162264cc0c37f78719f905029a9099445c214cb40ce3Jordan Rosestatic const char StrLoopRangeEmpty[] = 162364cc0c37f78719f905029a9099445c214cb40ce3Jordan Rose "Loop body skipped when range is empty"; 162464cc0c37f78719f905029a9099445c214cb40ce3Jordan Rosestatic const char StrLoopCollectionEmpty[] = 162564cc0c37f78719f905029a9099445c214cb40ce3Jordan Rose "Loop body skipped when collection is empty"; 1626f94cb007d03031bcf3d1b02f6a683a189e934953Ted Kremenek 1627176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hinesstatic bool GenerateAlternateExtensivePathDiagnostic( 1628176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines PathDiagnostic &PD, PathDiagnosticBuilder &PDB, const ExplodedNode *N, 1629176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines LocationContextMap &LCM, 1630176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines ArrayRef<std::unique_ptr<BugReporterVisitor>> visitors) { 1631af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1632af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek BugReport *report = PDB.getBugReport(); 1633af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const SourceManager& SM = PDB.getSourceManager(); 1634af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek StackDiagVector CallStack; 1635af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek InterestingExprs IE; 1636af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 16375a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose PathDiagnosticLocation PrevLoc = PD.getLocation(); 1638af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1639af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const ExplodedNode *NextNode = N->getFirstPred(); 1640af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek while (NextNode) { 1641af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek N = NextNode; 1642af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek NextNode = N->getFirstPred(); 1643af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek ProgramPoint P = N->getLocation(); 1644af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1645af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek do { 1646be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Have we encountered an entrance to a call? It may be 1647be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // the case that we have not encountered a matching 1648be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // call exit before this point. This means that the path 1649be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // terminated within the call itself. 1650be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek if (Optional<CallEnter> CE = P.getAs<CallEnter>()) { 1651904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose // Add an edge to the start of the function. 1652904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose const StackFrameContext *CalleeLC = CE->getCalleeContext(); 1653904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose const Decl *D = CalleeLC->getDecl(); 1654904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose addEdgeToPath(PD.getActivePath(), PrevLoc, 1655904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose PathDiagnosticLocation::createBegin(D, SM), 1656904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose CalleeLC); 1657904fd08edbedeb18b16875dd54b3f1edb049e9b9Jordan Rose 1658be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Did we visit an entire call? 1659be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek bool VisitedEntireCall = PD.isWithinCall(); 1660be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PD.popActivePath(); 1661be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1662be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PathDiagnosticCallPiece *C; 1663be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek if (VisitedEntireCall) { 1664c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines PathDiagnosticPiece *P = PD.getActivePath().front().get(); 1665be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek C = cast<PathDiagnosticCallPiece>(P); 1666be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek } else { 1667be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek const Decl *Caller = CE->getLocationContext()->getDecl(); 1668be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek C = PathDiagnosticCallPiece::construct(PD.getActivePath(), Caller); 1669be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1670be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Since we just transferred the path over to the call piece, 1671be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // reset the mapping from active to location context. 1672be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek assert(PD.getActivePath().size() == 1 && 1673be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PD.getActivePath().front() == C); 16746bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines LCM[&PD.getActivePath()] = nullptr; 1675be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1676be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Record the location context mapping for the path within 1677be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // the call. 16786bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines assert(LCM[&C->path] == nullptr || 1679be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek LCM[&C->path] == CE->getCalleeContext()); 1680be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 1681be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1682be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // If this is the first item in the active path, record 1683be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // the new mapping from active path to location context. 1684be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek const LocationContext *&NewLC = LCM[&PD.getActivePath()]; 16855a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose if (!NewLC) 1686be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek NewLC = N->getLocationContext(); 1687be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 16885a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose PDB.LC = NewLC; 1689be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek } 1690be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek C->setCallee(*CE, SM); 1691be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 16925a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose // Update the previous location in the active path. 16935a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose PrevLoc = C->getLocation(); 16945a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose 1695be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek if (!CallStack.empty()) { 1696be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek assert(CallStack.back().first == C); 1697be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek CallStack.pop_back(); 1698be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek } 1699af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek break; 1700af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1701af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1702be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Query the location context here and the previous location 1703be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // as processing CallEnter may change the active path. 1704be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PDB.LC = N->getLocationContext(); 1705be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1706be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // Record the mapping from the active path to the location 1707be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // context. 1708be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek assert(!LCM[&PD.getActivePath()] || 1709be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek LCM[&PD.getActivePath()] == PDB.LC); 1710be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek LCM[&PD.getActivePath()] = PDB.LC; 1711be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek 1712af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Have we encountered an exit from a function call? 1713af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (Optional<CallExitEnd> CE = P.getAs<CallExitEnd>()) { 1714af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const Stmt *S = CE->getCalleeContext()->getCallSite(); 1715af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Propagate the interesting symbols accordingly. 1716af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (const Expr *Ex = dyn_cast_or_null<Expr>(S)) { 1717af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek reversePropagateIntererstingSymbols(*PDB.getBugReport(), IE, 1718c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines N->getState().get(), Ex, 1719af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek N->getLocationContext()); 1720af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1721af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1722af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // We are descending into a call (backwards). Construct 1723af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // a new call piece to contain the path pieces for that call. 1724af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticCallPiece *C = 1725af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticCallPiece::construct(N, *CE, SM); 1726af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1727af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Record the location context for this call piece. 1728bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek LCM[&C->path] = CE->getCalleeContext(); 1729af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1730af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Add the edge to the return site. 1731be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, C->callReturn, PDB.LC); 1732be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PD.getActivePath().push_front(C); 17335a6fb20841220488f8be7254fbea8ba7233ebcd3Jordan Rose PrevLoc.invalidate(); 1734af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1735af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Make the contents of the call the active path for now. 1736af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PD.pushActivePath(&C->path); 1737af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek CallStack.push_back(StackDiagPair(C, N)); 1738af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek break; 1739af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1740af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1741be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek if (Optional<PostStmt> PS = P.getAs<PostStmt>()) { 1742be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // For expressions, make sure we propagate the 1743be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek // interesting symbols correctly. 1744be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek if (const Expr *Ex = PS->getStmtAs<Expr>()) 1745be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek reversePropagateIntererstingSymbols(*PDB.getBugReport(), IE, 1746c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines N->getState().get(), Ex, 1747be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek N->getLocationContext()); 1748af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1749e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // Add an edge. If this is an ObjCForCollectionStmt do 1750e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // not add an edge here as it appears in the CFG both 1751e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // as a terminator and as a terminator condition. 1752e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek if (!isa<ObjCForCollectionStmt>(PS->getStmt())) { 1753e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek PathDiagnosticLocation L = 1754e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek PathDiagnosticLocation(PS->getStmt(), SM, PDB.LC); 1755e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, L, PDB.LC); 1756e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek } 1757af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek break; 1758af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1759af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1760af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Block edges. 1761af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (Optional<BlockEdge> BE = P.getAs<BlockEdge>()) { 1762af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Does this represent entering a call? If so, look at propagating 1763af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // interesting symbols across call boundaries. 1764af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (NextNode) { 1765af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const LocationContext *CallerCtx = NextNode->getLocationContext(); 1766af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const LocationContext *CalleeCtx = PDB.LC; 1767af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (CallerCtx != CalleeCtx) { 1768af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek reversePropagateInterestingSymbols(*PDB.getBugReport(), IE, 1769c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines N->getState().get(), 1770af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek CalleeCtx, CallerCtx); 1771af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1772af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1773af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1774af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Are we jumping to the head of a loop? Add a special diagnostic. 1775af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (const Stmt *Loop = BE->getSrc()->getLoopTarget()) { 1776af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticLocation L(Loop, SM, PDB.LC); 17776bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const Stmt *Body = nullptr; 1778afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek 1779afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek if (const ForStmt *FS = dyn_cast<ForStmt>(Loop)) 178049a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose Body = FS->getBody(); 1781afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek else if (const WhileStmt *WS = dyn_cast<WhileStmt>(Loop)) 178249a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose Body = WS->getBody(); 1783e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek else if (const ObjCForCollectionStmt *OFS = 178449a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose dyn_cast<ObjCForCollectionStmt>(Loop)) { 178549a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose Body = OFS->getBody(); 178649a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose } else if (const CXXForRangeStmt *FRS = 178749a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose dyn_cast<CXXForRangeStmt>(Loop)) { 178849a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose Body = FRS->getBody(); 1789e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek } 179049a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose // do-while statements are explicitly excluded here 1791af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1792af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek PathDiagnosticEventPiece *p = 1793af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek new PathDiagnosticEventPiece(L, "Looping back to the head " 1794af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek "of the loop"); 1795af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek p->setPrunable(true); 1796af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1797be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, p->getLocation(), PDB.LC); 1798cd389d8cc9abeffb1416b70dd58148e66e5d822bTed Kremenek PD.getActivePath().push_front(p); 1799afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek 180049a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose if (const CompoundStmt *CS = dyn_cast_or_null<CompoundStmt>(Body)) { 1801afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, 1802afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek PathDiagnosticLocation::createEndBrace(CS, SM), 1803afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek PDB.LC); 1804afde200cdae9731aa5826c6178eae9e7fef74475Ted Kremenek } 1805af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1806b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1807af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek const CFGBlock *BSrc = BE->getSrc(); 1808af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek ParentMap &PM = PDB.getParentMap(); 1809af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1810af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (const Stmt *Term = BSrc->getTerminator()) { 1811af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Are we jumping past the loop body without ever executing the 1812af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // loop (because the condition was false)? 1813b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek if (isLoop(Term)) { 1814e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek const Stmt *TermCond = getTerminatorCondition(BSrc); 1815b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek bool IsInLoopBody = 1816b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek isInLoopBody(PM, getStmtBeforeCond(PM, TermCond, N), Term); 1817b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 18186bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const char *str = nullptr; 1819b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1820b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek if (isJumpToFalseBranch(&*BE)) { 1821b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek if (!IsInLoopBody) { 182264cc0c37f78719f905029a9099445c214cb40ce3Jordan Rose if (isa<ObjCForCollectionStmt>(Term)) { 182364cc0c37f78719f905029a9099445c214cb40ce3Jordan Rose str = StrLoopCollectionEmpty; 182464cc0c37f78719f905029a9099445c214cb40ce3Jordan Rose } else if (isa<CXXForRangeStmt>(Term)) { 182564cc0c37f78719f905029a9099445c214cb40ce3Jordan Rose str = StrLoopRangeEmpty; 182664cc0c37f78719f905029a9099445c214cb40ce3Jordan Rose } else { 182764cc0c37f78719f905029a9099445c214cb40ce3Jordan Rose str = StrLoopBodyZero; 182864cc0c37f78719f905029a9099445c214cb40ce3Jordan Rose } 1829b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek } 18300a9350f2411926f4faaeb2ce7d7a9bc1f27751e9Craig Topper } else { 1831f94cb007d03031bcf3d1b02f6a683a189e934953Ted Kremenek str = StrEnteringLoop; 1832b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek } 1833b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek 1834b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek if (str) { 18353e8a85fcfc3d264e4c5b21fbdd741bbc0c24a266Jordan Rose PathDiagnosticLocation L(TermCond ? TermCond : Term, SM, PDB.LC); 1836b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek PathDiagnosticEventPiece *PE = 1837b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek new PathDiagnosticEventPiece(L, str); 1838b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek PE->setPrunable(true); 1839b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, 1840be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek PE->getLocation(), PDB.LC); 1841b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek PD.getActivePath().push_front(PE); 1842b097a57f58672a825c99fdfb668b04e921e363b9Ted Kremenek } 18430a9350f2411926f4faaeb2ce7d7a9bc1f27751e9Craig Topper } else if (isa<BreakStmt>(Term) || isa<ContinueStmt>(Term) || 18440a9350f2411926f4faaeb2ce7d7a9bc1f27751e9Craig Topper isa<GotoStmt>(Term)) { 1845bc0fd8129626ff4e485388311b081e76d0f96795Ted Kremenek PathDiagnosticLocation L(Term, SM, PDB.LC); 1846be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, L, PDB.LC); 1847bc0fd8129626ff4e485388311b081e76d0f96795Ted Kremenek } 1848af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1849af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek break; 1850af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1851af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } while (0); 1852af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1853af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (!NextNode) 1854af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek continue; 1855af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1856af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek // Add pieces from custom visitors. 1857176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines for (auto &V : visitors) { 1858176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines if (PathDiagnosticPiece *p = V->VisitNode(N, NextNode, PDB, *report)) { 1859be0b207c4916f823497d31cbf5083efb4e374163Ted Kremenek addEdgeToPath(PD.getActivePath(), PrevLoc, p->getLocation(), PDB.LC); 1860cd389d8cc9abeffb1416b70dd58148e66e5d822bTed Kremenek PD.getActivePath().push_front(p); 1861af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek updateStackPiecesWithMessage(p, CallStack); 1862af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1863af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1864af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 1865af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 186601f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose // Add an edge to the start of the function. 186701f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose // We'll prune it out later, but it helps make diagnostics more uniform. 186801f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose const StackFrameContext *CalleeLC = PDB.LC->getCurrentStackFrame(); 186901f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose const Decl *D = CalleeLC->getDecl(); 187001f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose addEdgeToPath(PD.getActivePath(), PrevLoc, 187101f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose PathDiagnosticLocation::createBegin(D, SM), 187201f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose CalleeLC); 187301f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose 1874af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek return report->isValid(); 1875af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek} 1876af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 1877b1a4d37c0549501fe12907bc6ffa81bc5d04b98aBenjamin Kramerstatic const Stmt *getLocStmt(PathDiagnosticLocation L) { 1878bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (!L.isValid()) 18796bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return nullptr; 1880f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek return L.asStmt(); 1881f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek} 1882f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek 188396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rosestatic const Stmt *getStmtParent(const Stmt *S, const ParentMap &PM) { 1884bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (!S) 18856bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return nullptr; 1886a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek 1887a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek while (true) { 1888a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek S = PM.getParentIgnoreParens(S); 1889a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek 1890a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek if (!S) 1891a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek break; 1892a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek 1893a327bb12b1cd0c142eb06e30b4f6018b96d5babfTed Kremenek if (isa<ExprWithCleanups>(S) || 1894a327bb12b1cd0c142eb06e30b4f6018b96d5babfTed Kremenek isa<CXXBindTemporaryExpr>(S) || 1895a327bb12b1cd0c142eb06e30b4f6018b96d5babfTed Kremenek isa<SubstNonTypeTemplateParmExpr>(S)) 1896a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek continue; 1897a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek 1898a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek break; 1899a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek } 1900a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek 1901a40983460cc3f8f583cd968ac2e4647dc30c83f5Ted Kremenek return S; 1902bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek} 1903bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 190415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenekstatic bool isConditionForTerminator(const Stmt *S, const Stmt *Cond) { 190515676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek switch (S->getStmtClass()) { 190603194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek case Stmt::BinaryOperatorClass: { 190703194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek const BinaryOperator *BO = cast<BinaryOperator>(S); 190803194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek if (!BO->isLogicalOp()) 190903194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek return false; 191003194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek return BO->getLHS() == Cond || BO->getRHS() == Cond; 191103194fb1bbf2b2d17ff7e3d61ddb9d73e9297fdcTed Kremenek } 1912a399f776ee29e099da33eaf7f9d585b4edc4b61dTed Kremenek case Stmt::IfStmtClass: 1913a399f776ee29e099da33eaf7f9d585b4edc4b61dTed Kremenek return cast<IfStmt>(S)->getCond() == Cond; 191415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::ForStmtClass: 191515676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<ForStmt>(S)->getCond() == Cond; 191615676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::WhileStmtClass: 191715676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<WhileStmt>(S)->getCond() == Cond; 191815676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::DoStmtClass: 191915676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<DoStmt>(S)->getCond() == Cond; 192015676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::ChooseExprClass: 192115676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<ChooseExpr>(S)->getCond() == Cond; 192215676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::IndirectGotoStmtClass: 192315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<IndirectGotoStmt>(S)->getTarget() == Cond; 192415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::SwitchStmtClass: 192515676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<SwitchStmt>(S)->getCond() == Cond; 192615676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::BinaryConditionalOperatorClass: 192715676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<BinaryConditionalOperator>(S)->getCond() == Cond; 19288484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek case Stmt::ConditionalOperatorClass: { 19298484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek const ConditionalOperator *CO = cast<ConditionalOperator>(S); 19308484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek return CO->getCond() == Cond || 19318484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek CO->getLHS() == Cond || 19328484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek CO->getRHS() == Cond; 19338484b37a2b7720c016d27a672343b1c67bd2e731Ted Kremenek } 193415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek case Stmt::ObjCForCollectionStmtClass: 193515676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return cast<ObjCForCollectionStmt>(S)->getElement() == Cond; 193649a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose case Stmt::CXXForRangeStmtClass: { 193749a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose const CXXForRangeStmt *FRS = cast<CXXForRangeStmt>(S); 193849a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose return FRS->getCond() == Cond || FRS->getRangeInit() == Cond; 193949a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose } 194015676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek default: 194115676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek return false; 194215676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek } 194315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek} 194415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek 194596b8134337883908fcc45484486fe200d6b3e32fTed Kremenekstatic bool isIncrementOrInitInForLoop(const Stmt *S, const Stmt *FL) { 194649a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose if (const ForStmt *FS = dyn_cast<ForStmt>(FL)) 194749a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose return FS->getInc() == S || FS->getInit() == S; 194849a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose if (const CXXForRangeStmt *FRS = dyn_cast<CXXForRangeStmt>(FL)) 194949a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose return FRS->getInc() == S || FRS->getRangeStmt() == S || 195049a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose FRS->getLoopVarStmt() || FRS->getRangeInit() == S; 195149a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose return false; 1952e2f7337958f21802e98777f441fe20ef7ba2adffTed Kremenek} 1953e2f7337958f21802e98777f441fe20ef7ba2adffTed Kremenek 195415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenektypedef llvm::DenseSet<const PathDiagnosticCallPiece *> 195515676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek OptimizedCallsSet; 195615676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek 195796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// Adds synthetic edges from top-level statements to their subexpressions. 195896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// 195996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// This avoids a "swoosh" effect, where an edge from a top-level statement A 196096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// points to a sub-expression B.1 that's not at the start of B. In these cases, 196196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// we'd like to see an edge from A to B, then another one from B to B.1. 196296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rosestatic void addContextEdges(PathPieces &pieces, SourceManager &SM, 196396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const ParentMap &PM, const LocationContext *LCtx) { 196496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathPieces::iterator Prev = pieces.end(); 196596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose for (PathPieces::iterator I = pieces.begin(), E = Prev; I != E; 196696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose Prev = I, ++I) { 196796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathDiagnosticControlFlowPiece *Piece = 196896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose dyn_cast<PathDiagnosticControlFlowPiece>(*I); 196996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 197096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!Piece) 197196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 197296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 197396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathDiagnosticLocation SrcLoc = Piece->getStartLocation(); 19749d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose SmallVector<PathDiagnosticLocation, 4> SrcContexts; 19759d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose 197649a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose PathDiagnosticLocation NextSrcContext = SrcLoc; 19776bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const Stmt *InnerStmt = nullptr; 19789d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose while (NextSrcContext.isValid() && NextSrcContext.asStmt() != InnerStmt) { 19799d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose SrcContexts.push_back(NextSrcContext); 19809d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose InnerStmt = NextSrcContext.asStmt(); 198149a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose NextSrcContext = getEnclosingStmtLocation(InnerStmt, SM, PM, LCtx, 198249a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose /*allowNested=*/true); 19839d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose } 198496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 198596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Repeatedly split the edge as necessary. 198696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // This is important for nested logical expressions (||, &&, ?:) where we 198796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // want to show all the levels of context. 198896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose while (true) { 198996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const Stmt *Dst = getLocStmt(Piece->getEndLocation()); 199096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 199196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // We are looking at an edge. Is the destination within a larger 199296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // expression? 199396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathDiagnosticLocation DstContext = 19949d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose getEnclosingStmtLocation(Dst, SM, PM, LCtx, /*allowNested=*/true); 199596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!DstContext.isValid() || DstContext.asStmt() == Dst) 199696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 199796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 199896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // If the source is in the same context, we're already good. 19999d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose if (std::find(SrcContexts.begin(), SrcContexts.end(), DstContext) != 20009d9b494aa36ceeb823c48acf04d2d7677174be88Jordan Rose SrcContexts.end()) 200196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 200296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 200396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Update the subexpression node to point to the context edge. 200496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose Piece->setStartLocation(DstContext); 200596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 200696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Try to extend the previous edge if it's at the same level as the source 200796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // context. 200896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (Prev != E) { 200996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathDiagnosticControlFlowPiece *PrevPiece = 201096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose dyn_cast<PathDiagnosticControlFlowPiece>(*Prev); 201196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 201296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (PrevPiece) { 201396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (const Stmt *PrevSrc = getLocStmt(PrevPiece->getStartLocation())) { 201496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const Stmt *PrevSrcParent = getStmtParent(PrevSrc, PM); 201596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (PrevSrcParent == getStmtParent(getLocStmt(DstContext), PM)) { 201696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PrevPiece->setEndLocation(DstContext); 201796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 201896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 201996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 202096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 202196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 202296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 202396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Otherwise, split the current edge into a context edge and a 202496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // subexpression edge. Note that the context statement may itself have 202596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // context. 202696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose Piece = new PathDiagnosticControlFlowPiece(SrcLoc, DstContext); 202796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose I = pieces.insert(I, Piece); 202896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 202996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 203096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose} 203196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 203296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// \brief Move edges from a branch condition to a branch target 203396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// when the condition is simple. 203496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// 203596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// This restructures some of the work of addContextEdges. That function 203696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// creates edges this may destroy, but they work together to create a more 203796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// aesthetically set of edges around branches. After the call to 203896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// addContextEdges, we may have (1) an edge to the branch, (2) an edge from 203996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// the branch to the branch condition, and (3) an edge from the branch 204096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// condition to the branch target. We keep (1), but may wish to remove (2) 204196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// and move the source of (3) to the branch if the branch condition is simple. 204296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose/// 204396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rosestatic void simplifySimpleBranches(PathPieces &pieces) { 204496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose for (PathPieces::iterator I = pieces.begin(), E = pieces.end(); I != E; ++I) { 204596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 204696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathDiagnosticControlFlowPiece *PieceI = 204796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose dyn_cast<PathDiagnosticControlFlowPiece>(*I); 204896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 204996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!PieceI) 205096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 205196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 205296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const Stmt *s1Start = getLocStmt(PieceI->getStartLocation()); 205396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const Stmt *s1End = getLocStmt(PieceI->getEndLocation()); 205496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 205596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!s1Start || !s1End) 205696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 205796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 205896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathPieces::iterator NextI = I; ++NextI; 205996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (NextI == E) 206096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 206196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 20626bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines PathDiagnosticControlFlowPiece *PieceNextI = nullptr; 206396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 206496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose while (true) { 206596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (NextI == E) 206696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 206796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 206896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PathDiagnosticEventPiece *EV = dyn_cast<PathDiagnosticEventPiece>(*NextI); 206996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (EV) { 207096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose StringRef S = EV->getString(); 207164cc0c37f78719f905029a9099445c214cb40ce3Jordan Rose if (S == StrEnteringLoop || S == StrLoopBodyZero || 207264cc0c37f78719f905029a9099445c214cb40ce3Jordan Rose S == StrLoopCollectionEmpty || S == StrLoopRangeEmpty) { 207396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose ++NextI; 207496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 207596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 207696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 207796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 207896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 207996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PieceNextI = dyn_cast<PathDiagnosticControlFlowPiece>(*NextI); 208096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose break; 208196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 208296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 208396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!PieceNextI) 208496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 208596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 208696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const Stmt *s2Start = getLocStmt(PieceNextI->getStartLocation()); 208796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose const Stmt *s2End = getLocStmt(PieceNextI->getEndLocation()); 208896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 208996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!s2Start || !s2End || s1End != s2Start) 209096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 209196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 209296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // We only perform this transformation for specific branch kinds. 209396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // We don't want to do this for do..while, for example. 209496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!(isa<ForStmt>(s1Start) || isa<WhileStmt>(s1Start) || 209549a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose isa<IfStmt>(s1Start) || isa<ObjCForCollectionStmt>(s1Start) || 209649a246f4fad959888bb0164c624c3c2b03078e91Jordan Rose isa<CXXForRangeStmt>(s1Start))) 209796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 209896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 209996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Is s1End the branch condition? 210096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose if (!isConditionForTerminator(s1Start, s1End)) 210196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose continue; 210296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 210396f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Perform the hoisting by eliminating (2) and changing the start 210496f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // location of (3). 210596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose PieceNextI->setStartLocation(PieceI->getStartLocation()); 210696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose I = pieces.erase(I); 210796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose } 210896f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose} 210996f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose 2110e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose/// Returns the number of bytes in the given (character-based) SourceRange. 211122b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// 211222b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// If the locations in the range are not on the same line, returns None. 211322b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// 211422b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// Note that this does not do a precise user-visible character or column count. 211522b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rosestatic Optional<size_t> getLengthOnSingleLine(SourceManager &SM, 211622b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose SourceRange Range) { 211722b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose SourceRange ExpansionRange(SM.getExpansionLoc(Range.getBegin()), 211822b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose SM.getExpansionRange(Range.getEnd()).second); 211922b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose 212022b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose FileID FID = SM.getFileID(ExpansionRange.getBegin()); 212122b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose if (FID != SM.getFileID(ExpansionRange.getEnd())) 212222b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose return None; 212322b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose 212422b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose bool Invalid; 212522b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose const llvm::MemoryBuffer *Buffer = SM.getBuffer(FID, &Invalid); 212622b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose if (Invalid) 212722b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose return None; 212822b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose 212922b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose unsigned BeginOffset = SM.getFileOffset(ExpansionRange.getBegin()); 213022b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose unsigned EndOffset = SM.getFileOffset(ExpansionRange.getEnd()); 213122b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose StringRef Snippet = Buffer->getBuffer().slice(BeginOffset, EndOffset); 213222b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose 213322b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose // We're searching the raw bytes of the buffer here, which might include 213422b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose // escaped newlines and such. That's okay; we're trying to decide whether the 213522b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose // SourceRange is covering a large or small amount of space in the user's 213622b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose // editor. 213722b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose if (Snippet.find_first_of("\r\n") != StringRef::npos) 213822b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose return None; 213922b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose 214022b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose // This isn't Unicode-aware, but it doesn't need to be. 214122b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose return Snippet.size(); 214222b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose} 214322b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose 214422b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// \sa getLengthOnSingleLine(SourceManager, SourceRange) 214522b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rosestatic Optional<size_t> getLengthOnSingleLine(SourceManager &SM, 214622b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose const Stmt *S) { 214722b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose return getLengthOnSingleLine(SM, S->getSourceRange()); 214822b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose} 214922b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose 215022b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// Eliminate two-edge cycles created by addContextEdges(). 215122b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// 215222b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// Once all the context edges are in place, there are plenty of cases where 215322b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// there's a single edge from a top-level statement to a subexpression, 215422b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// followed by a single path note, and then a reverse edge to get back out to 215522b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// the top level. If the statement is simple enough, the subexpression edges 215622b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// just add noise and make it harder to understand what's going on. 215722b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// 215822b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// This function only removes edges in pairs, because removing only one edge 215922b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// might leave other edges dangling. 216022b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// 216122b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// This will not remove edges in more complicated situations: 216222b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// - if there is more than one "hop" leading to or from a subexpression. 216322b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// - if there is an inlined call between the edges instead of a single event. 216422b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// - if the whole statement is large enough that having subexpression arrows 216522b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose/// might be helpful. 216622b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rosestatic void removeContextCycles(PathPieces &Path, SourceManager &SM, 216722b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose ParentMap &PM) { 21683b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose for (PathPieces::iterator I = Path.begin(), E = Path.end(); I != E; ) { 21693b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose // Pattern match the current piece and its successor. 21703b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose PathDiagnosticControlFlowPiece *PieceI = 21713b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose dyn_cast<PathDiagnosticControlFlowPiece>(*I); 21723b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose 21733b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose if (!PieceI) { 21743b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose ++I; 21753b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose continue; 21763b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose } 21773b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose 21783b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose const Stmt *s1Start = getLocStmt(PieceI->getStartLocation()); 21793b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose const Stmt *s1End = getLocStmt(PieceI->getEndLocation()); 21803b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose 21813b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose PathPieces::iterator NextI = I; ++NextI; 21823b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose if (NextI == E) 21833b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose break; 21843b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose 21853b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose PathDiagnosticControlFlowPiece *PieceNextI = 21863b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose dyn_cast<PathDiagnosticControlFlowPiece>(*NextI); 21873b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose 21883b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose if (!PieceNextI) { 21893b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose if (isa<PathDiagnosticEventPiece>(*NextI)) { 21903b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose ++NextI; 21913b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose if (NextI == E) 21923b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose break; 21933b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose PieceNextI = dyn_cast<PathDiagnosticControlFlowPiece>(*NextI); 21943b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose } 21953b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose 21963b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose if (!PieceNextI) { 21973b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose ++I; 21983b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose continue; 21993b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose } 22003b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose } 22013b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose 22023b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose const Stmt *s2Start = getLocStmt(PieceNextI->getStartLocation()); 22033b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose const Stmt *s2End = getLocStmt(PieceNextI->getEndLocation()); 22043b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose 22053b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose if (s1Start && s2Start && s1Start == s2End && s2Start == s1End) { 220622b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose const size_t MAX_SHORT_LINE_LENGTH = 80; 220722b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose Optional<size_t> s1Length = getLengthOnSingleLine(SM, s1Start); 220822b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose if (s1Length && *s1Length <= MAX_SHORT_LINE_LENGTH) { 220922b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose Optional<size_t> s2Length = getLengthOnSingleLine(SM, s2Start); 221022b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose if (s2Length && *s2Length <= MAX_SHORT_LINE_LENGTH) { 221122b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose Path.erase(I); 221222b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose I = Path.erase(NextI); 221322b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose continue; 221422b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose } 221522b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose } 22163b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose } 22173b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose 22183b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose ++I; 22193b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose } 22203b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose} 22213b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose 222252f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek/// \brief Return true if X is contained by Y. 222352f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenekstatic bool lexicalContains(ParentMap &PM, 222452f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek const Stmt *X, 222552f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek const Stmt *Y) { 222652f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek while (X) { 222752f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek if (X == Y) 222852f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek return true; 222952f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek X = PM.getParent(X); 223052f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek } 223152f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek return false; 223252f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek} 223352f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek 2234de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek// Remove short edges on the same line less than 3 columns in difference. 2235de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenekstatic void removePunyEdges(PathPieces &path, 2236de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek SourceManager &SM, 2237de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek ParentMap &PM) { 2238de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2239de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek bool erased = false; 2240de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2241de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek for (PathPieces::iterator I = path.begin(), E = path.end(); I != E; 2242de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek erased ? I : ++I) { 2243de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2244de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek erased = false; 2245de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2246de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek PathDiagnosticControlFlowPiece *PieceI = 2247de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek dyn_cast<PathDiagnosticControlFlowPiece>(*I); 2248de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2249de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (!PieceI) 2250de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2251de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2252de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek const Stmt *start = getLocStmt(PieceI->getStartLocation()); 2253de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek const Stmt *end = getLocStmt(PieceI->getEndLocation()); 2254de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2255de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (!start || !end) 2256de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2257de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2258de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek const Stmt *endParent = PM.getParent(end); 2259de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (!endParent) 2260de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2261de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2262de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (isConditionForTerminator(end, endParent)) 2263de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2264de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 226522b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose SourceLocation FirstLoc = start->getLocStart(); 226622b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose SourceLocation SecondLoc = end->getLocStart(); 2267de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 226824146975f1af8c1b4b14e8545f218129d0e7dfebEli Friedman if (!SM.isWrittenInSameFile(FirstLoc, SecondLoc)) 2269de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 227022b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose if (SM.isBeforeInTranslationUnit(SecondLoc, FirstLoc)) 227122b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose std::swap(SecondLoc, FirstLoc); 2272de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 227322b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose SourceRange EdgeRange(FirstLoc, SecondLoc); 227422b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose Optional<size_t> ByteWidth = getLengthOnSingleLine(SM, EdgeRange); 2275de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 227622b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose // If the statements are on different lines, continue. 227722b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose if (!ByteWidth) 2278de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2279de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 228022b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose const size_t MAX_PUNY_EDGE_LENGTH = 2; 228122b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose if (*ByteWidth <= MAX_PUNY_EDGE_LENGTH) { 228222b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose // FIXME: There are enough /bytes/ between the endpoints of the edge, but 228322b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose // there might not be enough /columns/. A proper user-visible column count 228422b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose // is probably too expensive, though. 2285a705980a7c3315b7c72d99ce675342ad91b50642Ted Kremenek I = path.erase(I); 2286de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek erased = true; 2287de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek continue; 2288de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek } 2289de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek } 2290de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek} 2291de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 22921d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenekstatic void removeIdenticalEvents(PathPieces &path) { 22931d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek for (PathPieces::iterator I = path.begin(), E = path.end(); I != E; ++I) { 22941d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek PathDiagnosticEventPiece *PieceI = 22951d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek dyn_cast<PathDiagnosticEventPiece>(*I); 22961d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 22971d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek if (!PieceI) 22981d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek continue; 22991d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 23001d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek PathPieces::iterator NextI = I; ++NextI; 23011d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek if (NextI == E) 23021d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek return; 23031d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 23041d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek PathDiagnosticEventPiece *PieceNextI = 23050fa3504acfc7c20a87973c58ad3474adc94dd97dTed Kremenek dyn_cast<PathDiagnosticEventPiece>(*NextI); 23061d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 23071d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek if (!PieceNextI) 23081d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek continue; 23091d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 23101d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek // Erase the second piece if it has the same exact message text. 23111d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek if (PieceI->getString() == PieceNextI->getString()) { 23121d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek path.erase(NextI); 23131d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek } 23141d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek } 23151d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek} 23161d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek 231715676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenekstatic bool optimizeEdges(PathPieces &path, SourceManager &SM, 231815676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek OptimizedCallsSet &OCS, 2319bb518991ce4298d8662235fc8cb13813f011c18dJordan Rose LocationContextMap &LCM) { 2320bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek bool hasChanges = false; 2321bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek const LocationContext *LC = LCM[&path]; 2322bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek assert(LC); 2323de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek ParentMap &PM = LC->getParentMap(); 2324bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2325481da5554d03271b0d87b695449963f7728c5895Ted Kremenek for (PathPieces::iterator I = path.begin(), E = path.end(); I != E; ) { 2326bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // Optimize subpaths. 2327bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (PathDiagnosticCallPiece *CallI = dyn_cast<PathDiagnosticCallPiece>(*I)){ 2328481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // Record the fact that a call has been optimized so we only do the 2329481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // effort once. 233015676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek if (!OCS.count(CallI)) { 2331bb518991ce4298d8662235fc8cb13813f011c18dJordan Rose while (optimizeEdges(CallI->path, SM, OCS, LCM)) {} 233215676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek OCS.insert(CallI); 233315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek } 2334481da5554d03271b0d87b695449963f7728c5895Ted Kremenek ++I; 2335bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek continue; 2336bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek } 2337bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2338bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // Pattern match the current piece and its successor. 2339bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek PathDiagnosticControlFlowPiece *PieceI = 2340bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek dyn_cast<PathDiagnosticControlFlowPiece>(*I); 2341bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2342481da5554d03271b0d87b695449963f7728c5895Ted Kremenek if (!PieceI) { 2343481da5554d03271b0d87b695449963f7728c5895Ted Kremenek ++I; 2344bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek continue; 2345481da5554d03271b0d87b695449963f7728c5895Ted Kremenek } 2346bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2347f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *s1Start = getLocStmt(PieceI->getStartLocation()); 2348f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *s1End = getLocStmt(PieceI->getEndLocation()); 2349f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *level1 = getStmtParent(s1Start, PM); 2350f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *level2 = getStmtParent(s1End, PM); 2351f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek 235215676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek PathPieces::iterator NextI = I; ++NextI; 235315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek if (NextI == E) 235415676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek break; 235515676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek 2356bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek PathDiagnosticControlFlowPiece *PieceNextI = 2357bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek dyn_cast<PathDiagnosticControlFlowPiece>(*NextI); 2358bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2359481da5554d03271b0d87b695449963f7728c5895Ted Kremenek if (!PieceNextI) { 2360481da5554d03271b0d87b695449963f7728c5895Ted Kremenek ++I; 2361bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek continue; 2362481da5554d03271b0d87b695449963f7728c5895Ted Kremenek } 2363bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2364f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *s2Start = getLocStmt(PieceNextI->getStartLocation()); 2365f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *s2End = getLocStmt(PieceNextI->getEndLocation()); 2366f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *level3 = getStmtParent(s2Start, PM); 2367f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek const Stmt *level4 = getStmtParent(s2End, PM); 2368bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2369bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // Rule I. 2370bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // 2371bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // If we have two consecutive control edges whose end/begin locations 2372481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // are at the same level (e.g. statements or top-level expressions within 2373481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // a compound statement, or siblings share a single ancestor expression), 2374481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // then merge them if they have no interesting intermediate event. 2375bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // 2376bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // For example: 2377bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // 2378bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // (1.1 -> 1.2) -> (1.2 -> 1.3) becomes (1.1 -> 1.3) because the common 2379481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // parent is '1'. Here 'x.y.z' represents the hierarchy of statements. 2380bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // 2381bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // NOTE: this will be limited later in cases where we add barriers 2382bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek // to prevent this optimization. 2383f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // 2384481da5554d03271b0d87b695449963f7728c5895Ted Kremenek if (level1 && level1 == level2 && level1 == level3 && level1 == level4) { 2385bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek PieceI->setEndLocation(PieceNextI->getEndLocation()); 2386bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek path.erase(NextI); 2387bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek hasChanges = true; 2388bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek continue; 2389bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek } 2390b9e13d555fc9f3e5515e2b1fa6f720e6f10bb076Ted Kremenek 2391b9e13d555fc9f3e5515e2b1fa6f720e6f10bb076Ted Kremenek // Rule II. 2392b9e13d555fc9f3e5515e2b1fa6f720e6f10bb076Ted Kremenek // 2393a399f776ee29e099da33eaf7f9d585b4edc4b61dTed Kremenek // Eliminate edges between subexpressions and parent expressions 2394a399f776ee29e099da33eaf7f9d585b4edc4b61dTed Kremenek // when the subexpression is consumed. 2395f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // 2396f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // NOTE: this will be limited later in cases where we add barriers 2397f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // to prevent this optimization. 2398f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek // 239996b8134337883908fcc45484486fe200d6b3e32fTed Kremenek if (s1End && s1End == s2Start && level2) { 240052f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek bool removeEdge = false; 240152f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // Remove edges into the increment or initialization of a 240252f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // loop that have no interleaving event. This means that 240352f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // they aren't interesting. 240452f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek if (isIncrementOrInitInForLoop(s1End, level2)) 240552f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek removeEdge = true; 240652f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // Next only consider edges that are not anchored on 240752f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // the condition of a terminator. This are intermediate edges 240852f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // that we might want to trim. 240952f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek else if (!isConditionForTerminator(level2, s1End)) { 241052f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // Trim edges on expressions that are consumed by 241152f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // the parent expression. 241252f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek if (isa<Expr>(s1End) && PM.isConsumedExpr(cast<Expr>(s1End))) { 241387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar removeEdge = true; 241452f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek } 241552f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // Trim edges where a lexical containment doesn't exist. 241652f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // For example: 241752f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // 241852f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // X -> Y -> Z 241952f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // 242052f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // If 'Z' lexically contains Y (it is an ancestor) and 242152f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // 'X' does not lexically contain Y (it is a descendant OR 242252f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // it has no lexical relationship at all) then trim. 242352f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // 242452f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // This can eliminate edges where we dive into a subexpression 242552f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek // and then pop back out, etc. 242652f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek else if (s1Start && s2End && 242752f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek lexicalContains(PM, s2Start, s2End) && 242852f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek !lexicalContains(PM, s1End, s1Start)) { 242952f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek removeEdge = true; 243052f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek } 2431e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose // Trim edges from a subexpression back to the top level if the 2432e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose // subexpression is on a different line. 2433e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose // 2434e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose // A.1 -> A -> B 2435e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose // becomes 2436e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose // A.1 -> B 2437e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose // 2438e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose // These edges just look ugly and don't usually add anything. 2439e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose else if (s1Start && s2End && 2440e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose lexicalContains(PM, s1Start, s1End)) { 2441e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose SourceRange EdgeRange(PieceI->getEndLocation().asLocation(), 2442e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose PieceI->getStartLocation().asLocation()); 2443e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose if (!getLengthOnSingleLine(SM, EdgeRange).hasValue()) 2444e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose removeEdge = true; 2445e624524705ab660eb8d1feb9870ef2989fb2bdf4Jordan Rose } 244652f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek } 244752f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek 244852f926cc32e4f4969f767e98d98f0137358d5f12Ted Kremenek if (removeEdge) { 244996b8134337883908fcc45484486fe200d6b3e32fTed Kremenek PieceI->setEndLocation(PieceNextI->getEndLocation()); 245096b8134337883908fcc45484486fe200d6b3e32fTed Kremenek path.erase(NextI); 245196b8134337883908fcc45484486fe200d6b3e32fTed Kremenek hasChanges = true; 245296b8134337883908fcc45484486fe200d6b3e32fTed Kremenek continue; 245396b8134337883908fcc45484486fe200d6b3e32fTed Kremenek } 2454f468fa16e37fc8fa6a915fe36aee8f0434709789Ted Kremenek } 2455481da5554d03271b0d87b695449963f7728c5895Ted Kremenek 2456e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // Optimize edges for ObjC fast-enumeration loops. 2457e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // 2458e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // (X -> collection) -> (collection -> element) 2459e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // 2460e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // becomes: 2461e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // 2462e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek // (X -> element) 2463e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek if (s1End == s2Start) { 2464e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek const ObjCForCollectionStmt *FS = 2465e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek dyn_cast_or_null<ObjCForCollectionStmt>(level3); 2466e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek if (FS && FS->getCollection()->IgnoreParens() == s2Start && 2467e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek s2End == FS->getElement()) { 2468e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek PieceI->setEndLocation(PieceNextI->getEndLocation()); 2469e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek path.erase(NextI); 2470e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek hasChanges = true; 2471e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek continue; 2472e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek } 2473e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek } 2474e86ee1a213d244bb66b7eef3e9ab2266908cf4afTed Kremenek 2475481da5554d03271b0d87b695449963f7728c5895Ted Kremenek // No changes at this index? Move to the next one. 2476481da5554d03271b0d87b695449963f7728c5895Ted Kremenek ++I; 2477bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek } 2478bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 2479de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek if (!hasChanges) { 248096f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Adjust edges into subexpressions to make them more uniform 248196f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // and aesthetically pleasing. 248296f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose addContextEdges(path, SM, PM, LC); 24833b5977e690b3d4476938a548bbd6f66c4a4a6dcdJordan Rose // Remove "cyclical" edges that include one or more context edges. 248422b0ad2d2a9c723bcdc94525a091fdbfbaa480faJordan Rose removeContextCycles(path, SM, PM); 248596f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // Hoist edges originating from branch conditions to branches 248696f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose // for simple branches. 248796f1061fbe59faff5b266a3a04061cefcfe03e2fJordan Rose simplifySimpleBranches(path); 2488de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek // Remove any puny edges left over after primary optimization pass. 2489de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek removePunyEdges(path, SM, PM); 24901d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek // Remove identical events. 24911d85a9e8fb4e6ac513467b5fa825bd53e6fcba56Ted Kremenek removeIdenticalEvents(path); 2492de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek } 2493de7bc0d997cc69bd5c337ab82665c2f7ed989138Ted Kremenek 2494bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek return hasChanges; 2495bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek} 2496bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek 249701f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose/// Drop the very first edge in a path, which should be a function entry edge. 24981089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose/// 24991089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose/// If the first edge is not a function entry edge (say, because the first 25001089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose/// statement had an invalid source location), this function does nothing. 25011089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose// FIXME: We should just generate invalid edges anyway and have the optimizer 25021089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose// deal with them. 250301f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rosestatic void dropFunctionEntryEdge(PathPieces &Path, 250401f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose LocationContextMap &LCM, 250501f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose SourceManager &SM) { 250601f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose const PathDiagnosticControlFlowPiece *FirstEdge = 25071089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose dyn_cast<PathDiagnosticControlFlowPiece>(Path.front()); 25081089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose if (!FirstEdge) 25091089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose return; 25101089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose 25111089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose const Decl *D = LCM[&Path]->getDecl(); 25121089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose PathDiagnosticLocation EntryLoc = PathDiagnosticLocation::createBegin(D, SM); 25131089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose if (FirstEdge->getStartLocation() != EntryLoc) 25141089a57a88051f84aca66f3d8c92bda32a3a5c49Jordan Rose return; 251501f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose 251601f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose Path.pop_front(); 251701f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose} 251801f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose 251901f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose 25205fb5dfb6646464db3cd6d54a6332375c8fe36b75Ted Kremenek//===----------------------------------------------------------------------===// 25213106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// Methods for BugType and subclasses. 25223106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 2523edcc199f5861dd8ad1ec3ad1b83512d2a92e515aJordan Rosevoid BugType::anchor() { } 2524404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 25253106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenekvoid BugType::FlushReports(BugReporter &BR) {} 25263106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 252799ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikievoid BuiltinBug::anchor() {} 252899ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie 25293106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 25303106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// Methods for BugReport and subclasses. 25313106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 2532e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 253399ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikievoid BugReport::NodeResolver::anchor() {} 253499ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie 2535176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hinesvoid BugReport::addVisitor(std::unique_ptr<BugReporterVisitor> visitor) { 25368e6431adab313e283a992698f6fc7afe62420999Anna Zaks if (!visitor) 25378e6431adab313e283a992698f6fc7afe62420999Anna Zaks return; 25388e6431adab313e283a992698f6fc7afe62420999Anna Zaks 25398e6431adab313e283a992698f6fc7afe62420999Anna Zaks llvm::FoldingSetNodeID ID; 25408e6431adab313e283a992698f6fc7afe62420999Anna Zaks visitor->Profile(ID); 25418e6431adab313e283a992698f6fc7afe62420999Anna Zaks void *InsertPos; 25428e6431adab313e283a992698f6fc7afe62420999Anna Zaks 2543176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines if (CallbacksSet.FindNodeOrInsertPos(ID, InsertPos)) 25448e6431adab313e283a992698f6fc7afe62420999Anna Zaks return; 25458e6431adab313e283a992698f6fc7afe62420999Anna Zaks 2546176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines CallbacksSet.InsertNode(visitor.get(), InsertPos); 2547176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines Callbacks.push_back(std::move(visitor)); 25483bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ++ConfigurationChangeToken; 25498e6431adab313e283a992698f6fc7afe62420999Anna Zaks} 25508e6431adab313e283a992698f6fc7afe62420999Anna Zaks 25518e6431adab313e283a992698f6fc7afe62420999Anna ZaksBugReport::~BugReport() { 2552c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek while (!interestingSymbols.empty()) { 2553c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek popInterestingSymbolsAndRegions(); 2554c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek } 25558e6431adab313e283a992698f6fc7afe62420999Anna Zaks} 2556e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 255707189521a15d9c088216b943649cb9fe231cbb57Ted Kremenekconst Decl *BugReport::getDeclWithIssue() const { 255807189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek if (DeclWithIssue) 255907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek return DeclWithIssue; 256087d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 256107189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek const ExplodedNode *N = getErrorNode(); 256207189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek if (!N) 25636bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return nullptr; 25646bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 256507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek const LocationContext *LC = N->getLocationContext(); 256607189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek return LC->getCurrentStackFrame()->getDecl(); 256707189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek} 256807189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek 2569e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaksvoid BugReport::Profile(llvm::FoldingSetNodeID& hash) const { 2570e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks hash.AddPointer(&BT); 2571e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks hash.AddString(Description); 257297bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks PathDiagnosticLocation UL = getUniqueingLocation(); 257397bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks if (UL.isValid()) { 257497bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks UL.Profile(hash); 2575ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks } else if (Location.isValid()) { 2576590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks Location.Profile(hash); 2577590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks } else { 2578590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks assert(ErrorNode); 2579590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks hash.AddPointer(GetCurrentOrPreviousStmt(ErrorNode)); 2580590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks } 2581e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 258287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar for (SourceRange range : Ranges) { 2583e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks if (!range.isValid()) 2584e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks continue; 2585e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks hash.AddInteger(range.getBegin().getRawEncoding()); 2586e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks hash.AddInteger(range.getEnd().getRawEncoding()); 2587e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks } 2588e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks} 25893106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 259076aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenekvoid BugReport::markInteresting(SymbolRef sym) { 259176aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (!sym) 259276aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return; 25933bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 25943bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose // If the symbol wasn't already in our set, note a configuration change. 2595c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek if (getInterestingSymbols().insert(sym).second) 25963bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ++ConfigurationChangeToken; 25978ec588e2ac57311604cf80608c7d4b3fb3b022f7Jordy Rose 25988ec588e2ac57311604cf80608c7d4b3fb3b022f7Jordy Rose if (const SymbolMetadata *meta = dyn_cast<SymbolMetadata>(sym)) 2599c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek getInterestingRegions().insert(meta->getRegion()); 260076aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 260176aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 260276aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenekvoid BugReport::markInteresting(const MemRegion *R) { 260376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (!R) 260476aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return; 26053bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 26063bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose // If the base region wasn't already in our set, note a configuration change. 260776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek R = R->getBaseRegion(); 2608c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek if (getInterestingRegions().insert(R).second) 26093bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ++ConfigurationChangeToken; 26108ec588e2ac57311604cf80608c7d4b3fb3b022f7Jordy Rose 261176aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(R)) 2612c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek getInterestingSymbols().insert(SR->getSymbol()); 261376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 261476aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 261576aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenekvoid BugReport::markInteresting(SVal V) { 261676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek markInteresting(V.getAsRegion()); 261776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek markInteresting(V.getAsSymbol()); 261876aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 261976aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 262080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaksvoid BugReport::markInteresting(const LocationContext *LC) { 262180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (!LC) 262280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks return; 262380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks InterestingLocationContexts.insert(LC); 262480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks} 262580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 2626c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekbool BugReport::isInteresting(SVal V) { 262776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return isInteresting(V.getAsRegion()) || isInteresting(V.getAsSymbol()); 262876aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 262976aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 2630c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekbool BugReport::isInteresting(SymbolRef sym) { 263176aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (!sym) 263276aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return false; 26338ec588e2ac57311604cf80608c7d4b3fb3b022f7Jordy Rose // We don't currently consider metadata symbols to be interesting 26348ec588e2ac57311604cf80608c7d4b3fb3b022f7Jordy Rose // even if we know their region is interesting. Is that correct behavior? 2635c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek return getInterestingSymbols().count(sym); 263676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 263776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 2638c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekbool BugReport::isInteresting(const MemRegion *R) { 263976aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (!R) 264076aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return false; 264176aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek R = R->getBaseRegion(); 2642c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek bool b = getInterestingRegions().count(R); 264376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (b) 264476aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return true; 264576aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(R)) 2646c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek return getInterestingSymbols().count(SR->getSymbol()); 264776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek return false; 264876aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek} 2649c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 265080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaksbool BugReport::isInteresting(const LocationContext *LC) { 265180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks if (!LC) 265280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks return false; 265380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks return InterestingLocationContexts.count(LC); 265480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks} 265580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 2656c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekvoid BugReport::lazyInitializeInterestingSets() { 2657c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek if (interestingSymbols.empty()) { 2658c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingSymbols.push_back(new Symbols()); 2659c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingRegions.push_back(new Regions()); 2660c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek } 2661c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 2662c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 2663c4bac8e376b98d633bb00ee5f510d5e58449753cTed KremenekBugReport::Symbols &BugReport::getInterestingSymbols() { 2664c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek lazyInitializeInterestingSets(); 2665c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek return *interestingSymbols.back(); 2666c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 2667c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 2668c4bac8e376b98d633bb00ee5f510d5e58449753cTed KremenekBugReport::Regions &BugReport::getInterestingRegions() { 2669c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek lazyInitializeInterestingSets(); 2670c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek return *interestingRegions.back(); 2671c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 2672c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 2673c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekvoid BugReport::pushInterestingSymbolsAndRegions() { 2674c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingSymbols.push_back(new Symbols(getInterestingSymbols())); 2675c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek interestingRegions.push_back(new Regions(getInterestingRegions())); 2676c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 2677c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 2678c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekvoid BugReport::popInterestingSymbolsAndRegions() { 2679344472ebeded2fca2ed5013b9e87f81d09bfa908Robert Wilhelm delete interestingSymbols.pop_back_val(); 2680344472ebeded2fca2ed5013b9e87f81d09bfa908Robert Wilhelm delete interestingRegions.pop_back_val(); 2681c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 268276aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 26839c378f705405d37f49795d5e915989de774fe11fTed Kremenekconst Stmt *BugReport::getStmt() const { 2684e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks if (!ErrorNode) 26856bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return nullptr; 2686e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 2687212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care ProgramPoint ProgP = ErrorNode->getLocation(); 26886bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const Stmt *S = nullptr; 26891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 26907a95de68c093991047ed8d339479ccad51b88663David Blaikie if (Optional<BlockEntrance> BE = ProgP.getAs<BlockEntrance>()) { 2691fafd3834754d2093e0ad7a1c005860fd527ecb7fZhongxing Xu CFGBlock &Exit = ProgP.getLocationContext()->getCFG()->getExit(); 269250d5bc4e3b53eb8bb4ebf198f1213348a3fa0f38Zhongxing Xu if (BE->getBlock() == &Exit) 2693212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care S = GetPreviousStmt(ErrorNode); 26943106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 26955f85e17df3f5b0a8021443f2b590daecfb2cbd17Ted Kremenek if (!S) 26960f8579274a010f360a371b53101859d9d6052314Anna Zaks S = PathDiagnosticLocation::getStmt(ErrorNode); 26971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 26981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return S; 26993106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 27003106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 27010e2c34f92f00628d48968dfea096d36381f494cbStephen Hinesllvm::iterator_range<BugReport::ranges_iterator> BugReport::getRanges() { 27020e2c34f92f00628d48968dfea096d36381f494cbStephen Hines // If no custom ranges, add the range of the statement corresponding to 27030e2c34f92f00628d48968dfea096d36381f494cbStephen Hines // the error node. 27040e2c34f92f00628d48968dfea096d36381f494cbStephen Hines if (Ranges.empty()) { 27050e2c34f92f00628d48968dfea096d36381f494cbStephen Hines if (const Expr *E = dyn_cast_or_null<Expr>(getStmt())) 27060e2c34f92f00628d48968dfea096d36381f494cbStephen Hines addRange(E->getSourceRange()); 27070e2c34f92f00628d48968dfea096d36381f494cbStephen Hines else 27080e2c34f92f00628d48968dfea096d36381f494cbStephen Hines return llvm::make_range(ranges_iterator(), ranges_iterator()); 27090e2c34f92f00628d48968dfea096d36381f494cbStephen Hines } 2710e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 27110e2c34f92f00628d48968dfea096d36381f494cbStephen Hines // User-specified absence of range info. 27120e2c34f92f00628d48968dfea096d36381f494cbStephen Hines if (Ranges.size() == 1 && !Ranges.begin()->isValid()) 27130e2c34f92f00628d48968dfea096d36381f494cbStephen Hines return llvm::make_range(ranges_iterator(), ranges_iterator()); 271414924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks 271587d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar return llvm::make_range(Ranges.begin(), Ranges.end()); 27163106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 27173106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 2718590dd8e0959d8df5621827768987c4792b74fc06Anna ZaksPathDiagnosticLocation BugReport::getLocation(const SourceManager &SM) const { 2719b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks if (ErrorNode) { 2720590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks assert(!Location.isValid() && 2721b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks "Either Location or ErrorNode should be specified but not both."); 27220f8579274a010f360a371b53101859d9d6052314Anna Zaks return PathDiagnosticLocation::createEndOfPath(ErrorNode, SM); 2723b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks } 2724b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks 2725651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines assert(Location.isValid()); 2726651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines return Location; 27273106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 27283106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 27293106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 27303106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// Methods for BugReporter and subclasses. 27313106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 27323106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 27334a5f724538cbc275370c9504e8169ce92503256cBenjamin KramerBugReportEquivClass::~BugReportEquivClass() { } 2734a2f4ec0df645fc249d2945beef9653f03b175417Zhongxing XuGRBugReporter::~GRBugReporter() { } 27353106198188ac6eb2753f1764d5c28376b0b76351Ted KremenekBugReporterData::~BugReporterData() {} 27363106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 273738b02b912e1a55c912f603c4369431264d36a381Zhongxing XuExplodedGraph &GRBugReporter::getGraph() { return Eng.getGraph(); } 27383106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 273918c66fdc3c4008d335885695fe36fb5353c5f672Ted KremenekProgramStateManager& 27403106198188ac6eb2753f1764d5c28376b0b76351Ted KremenekGRBugReporter::getStateManager() { return Eng.getStateManager(); } 27413106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 27423b030a28cda2b953758507769c1d436bec5ec45eAnna ZaksBugReporter::~BugReporter() { 27433b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks FlushReports(); 27443b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks 27453b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks // Free the bug reports we are tracking. 27463b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks typedef std::vector<BugReportEquivClass *> ContTy; 27473b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks for (ContTy::iterator I = EQClassesVector.begin(), E = EQClassesVector.end(); 27483b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks I != E; ++I) { 27493b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks delete *I; 27503b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks } 27513b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks} 27523106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 27533106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenekvoid BugReporter::FlushReports() { 27543106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (BugTypes.isEmpty()) 27553106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek return; 27563106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 27573106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // First flush the warnings for each BugType. This may end up creating new 2758404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // warnings and new BugTypes. 2759404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // FIXME: Only NSErrorChecker needs BugType's FlushReports. 2760404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // Turn NSErrorChecker into a proper checker and remove this. 27610e2c34f92f00628d48968dfea096d36381f494cbStephen Hines SmallVector<const BugType *, 16> bugTypes(BugTypes.begin(), BugTypes.end()); 276209d19efaa147762f84aed55efa7930bb3616a4e5Craig Topper for (SmallVectorImpl<const BugType *>::iterator 2763404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis I = bugTypes.begin(), E = bugTypes.end(); I != E; ++I) 27643106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek const_cast<BugType*>(*I)->FlushReports(*this); 27653106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 2766d015f4febe85d3e3340172d70042840c51bbd836Anna Zaks // We need to flush reports in deterministic order to ensure the order 2767d015f4febe85d3e3340172d70042840c51bbd836Anna Zaks // of the reports is consistent between runs. 27680eb6c37dd4e4ad8fa2363003dea270f9fd6c2969Anna Zaks typedef std::vector<BugReportEquivClass *> ContVecTy; 27690eb6c37dd4e4ad8fa2363003dea270f9fd6c2969Anna Zaks for (ContVecTy::iterator EI=EQClassesVector.begin(), EE=EQClassesVector.end(); 27700eb6c37dd4e4ad8fa2363003dea270f9fd6c2969Anna Zaks EI != EE; ++EI){ 27710eb6c37dd4e4ad8fa2363003dea270f9fd6c2969Anna Zaks BugReportEquivClass& EQ = **EI; 2772404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis FlushReport(EQ); 27733106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 27743106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 2775404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // BugReporter owns and deletes only BugTypes created implicitly through 2776404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // EmitBasicReport. 2777404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // FIXME: There are leaks from checkers that assume that the BugTypes they 2778404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // create will be destroyed by the BugReporter. 2779651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines llvm::DeleteContainerSeconds(StrBugTypes); 2780404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 27813106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Remove all references to the BugType objects. 27823baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugTypes = F.getEmptySet(); 27833106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 27843106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 27853106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 27863106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek// PathDiagnostics generation. 27873106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek//===----------------------------------------------------------------------===// 27883106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 27891efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rosenamespace { 27901efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose/// A wrapper around a report graph, which contains only a single path, and its 27911efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose/// node maps. 27921efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Roseclass ReportGraph { 27931efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rosepublic: 27941efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose InterExplodedGraphMap BackMap; 2795651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines std::unique_ptr<ExplodedGraph> Graph; 2796228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose const ExplodedNode *ErrorNode; 27971efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose size_t Index; 27981efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose}; 27991efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose 28001efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose/// A wrapper around a trimmed graph and its node maps. 28011efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Roseclass TrimmedGraph { 28021efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose InterExplodedGraphMap InverseMap; 28032110350909701fcd6b55c636e24a675f0a905feaJordan Rose 28042110350909701fcd6b55c636e24a675f0a905feaJordan Rose typedef llvm::DenseMap<const ExplodedNode *, unsigned> PriorityMapTy; 28052110350909701fcd6b55c636e24a675f0a905feaJordan Rose PriorityMapTy PriorityMap; 28062110350909701fcd6b55c636e24a675f0a905feaJordan Rose 2807228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose typedef std::pair<const ExplodedNode *, size_t> NodeIndexPair; 2808228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose SmallVector<NodeIndexPair, 32> ReportNodes; 2809228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2810651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines std::unique_ptr<ExplodedGraph> G; 2811228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2812228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose /// A helper class for sorting ExplodedNodes by priority. 2813228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose template <bool Descending> 2814228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose class PriorityCompare { 2815228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose const PriorityMapTy &PriorityMap; 2816228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2817228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose public: 2818228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityCompare(const PriorityMapTy &M) : PriorityMap(M) {} 2819228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2820228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose bool operator()(const ExplodedNode *LHS, const ExplodedNode *RHS) const { 2821228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityMapTy::const_iterator LI = PriorityMap.find(LHS); 2822228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityMapTy::const_iterator RI = PriorityMap.find(RHS); 2823228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityMapTy::const_iterator E = PriorityMap.end(); 2824228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2825228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (LI == E) 2826228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return Descending; 2827228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (RI == E) 2828228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return !Descending; 2829228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2830228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return Descending ? LI->second > RI->second 2831228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose : LI->second < RI->second; 2832228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose } 2833228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2834228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose bool operator()(const NodeIndexPair &LHS, const NodeIndexPair &RHS) const { 2835228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return (*this)(LHS.first, RHS.first); 2836228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose } 2837228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose }; 2838228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 28391efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rosepublic: 28401efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose TrimmedGraph(const ExplodedGraph *OriginalGraph, 28412110350909701fcd6b55c636e24a675f0a905feaJordan Rose ArrayRef<const ExplodedNode *> Nodes); 28421efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose 2843228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose bool popNextReportGraph(ReportGraph &GraphWrapper); 28441efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose}; 28451efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose} 28461efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose 28472110350909701fcd6b55c636e24a675f0a905feaJordan RoseTrimmedGraph::TrimmedGraph(const ExplodedGraph *OriginalGraph, 28482110350909701fcd6b55c636e24a675f0a905feaJordan Rose ArrayRef<const ExplodedNode *> Nodes) { 28492110350909701fcd6b55c636e24a675f0a905feaJordan Rose // The trimmed graph is created in the body of the constructor to ensure 28502110350909701fcd6b55c636e24a675f0a905feaJordan Rose // that the DenseMaps have been initialized already. 2851228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose InterExplodedGraphMap ForwardMap; 2852176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines G = OriginalGraph->trim(Nodes, &ForwardMap, &InverseMap); 28531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28543106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Find the (first) error node in the trimmed graph. We just need to consult 28551efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose // the node map which maps from nodes in the original graph to nodes 28563106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // in the new graph. 2857228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose llvm::SmallPtrSet<const ExplodedNode *, 32> RemainingNodes; 28583106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 28591efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose for (unsigned i = 0, count = Nodes.size(); i < count; ++i) { 2860228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (const ExplodedNode *NewNode = ForwardMap.lookup(Nodes[i])) { 2861228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose ReportNodes.push_back(std::make_pair(NewNode, i)); 2862228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose RemainingNodes.insert(NewNode); 28633106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 286440406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek } 28651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2866228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose assert(!RemainingNodes.empty() && "No error node found in the trimmed graph"); 2867228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2868228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // Perform a forward BFS to find all the shortest paths. 2869228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose std::queue<const ExplodedNode *> WS; 2870228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose 2871228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose assert(G->num_roots() == 1); 2872228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose WS.push(*G->roots_begin()); 2873228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose unsigned Priority = 0; 28743106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 28753106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek while (!WS.empty()) { 2876228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose const ExplodedNode *Node = WS.front(); 28773106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek WS.pop(); 28781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28792110350909701fcd6b55c636e24a675f0a905feaJordan Rose PriorityMapTy::iterator PriorityEntry; 28802110350909701fcd6b55c636e24a675f0a905feaJordan Rose bool IsNew; 2881651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines std::tie(PriorityEntry, IsNew) = 28822110350909701fcd6b55c636e24a675f0a905feaJordan Rose PriorityMap.insert(std::make_pair(Node, Priority)); 2883228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose ++Priority; 28841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28852110350909701fcd6b55c636e24a675f0a905feaJordan Rose if (!IsNew) { 28862110350909701fcd6b55c636e24a675f0a905feaJordan Rose assert(PriorityEntry->second <= Priority); 28872110350909701fcd6b55c636e24a675f0a905feaJordan Rose continue; 28882110350909701fcd6b55c636e24a675f0a905feaJordan Rose } 28891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2890228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (RemainingNodes.erase(Node)) 2891228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (RemainingNodes.empty()) 2892228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose break; 2893a5f80b2ea6d30c5055c067530d63bb0dcaf937d0Jordan Rose 2894228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose for (ExplodedNode::const_pred_iterator I = Node->succ_begin(), 2895228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose E = Node->succ_end(); 28962110350909701fcd6b55c636e24a675f0a905feaJordan Rose I != E; ++I) 2897228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose WS.push(*I); 2898239b6e47d282bd66c8b559ac47b8b42b34da619eJordan Rose } 28992110350909701fcd6b55c636e24a675f0a905feaJordan Rose 2900228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // Sort the error paths from longest to shortest. 2901228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose std::sort(ReportNodes.begin(), ReportNodes.end(), 2902228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityCompare<true>(PriorityMap)); 2903228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose} 29042110350909701fcd6b55c636e24a675f0a905feaJordan Rose 2905228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rosebool TrimmedGraph::popNextReportGraph(ReportGraph &GraphWrapper) { 2906228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (ReportNodes.empty()) 2907228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return false; 29082110350909701fcd6b55c636e24a675f0a905feaJordan Rose 2909228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose const ExplodedNode *OrigN; 2910651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines std::tie(OrigN, GraphWrapper.Index) = ReportNodes.pop_back_val(); 2911228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose assert(PriorityMap.find(OrigN) != PriorityMap.end() && 2912228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose "error node not accessible from root"); 29132110350909701fcd6b55c636e24a675f0a905feaJordan Rose 29142110350909701fcd6b55c636e24a675f0a905feaJordan Rose // Create a new graph with a single path. This is the graph 29152110350909701fcd6b55c636e24a675f0a905feaJordan Rose // that will be returned to the caller. 2916176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines auto GNew = llvm::make_unique<ExplodedGraph>(); 2917228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose GraphWrapper.BackMap.clear(); 29181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2919228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // Now walk from the error node up the BFS path, always taking the 2920228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // predeccessor with the lowest number. 29216bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines ExplodedNode *Succ = nullptr; 2922228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose while (true) { 29233106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Create the equivalent node in the new graph with the same state 29243106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // and location. 29254967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar ExplodedNode *NewN = GNew->createUncachedNode(OrigN->getLocation(), OrigN->getState(), 29263e5ebf1a05603e08f2d0b2b2a5fa9406fe4cfb22Jordan Rose OrigN->isSink()); 29271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29283106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Store the mapping to the original node. 2929228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose InterExplodedGraphMap::const_iterator IMitr = InverseMap.find(OrigN); 29303106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek assert(IMitr != InverseMap.end() && "No mapping to original node."); 29311efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose GraphWrapper.BackMap[NewN] = IMitr->second; 29321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29333106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Link up the new node with the previous node. 2934228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (Succ) 2935228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose Succ->addPredecessor(NewN, *GNew); 2936228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose else 2937228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose GraphWrapper.ErrorNode = NewN; 29381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2939228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose Succ = NewN; 29401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29413106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Are we at the final node? 2942228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (OrigN->pred_empty()) { 2943228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose GNew->addRoot(NewN); 29443106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 29453106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 29461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2947228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // Find the next predeccessor node. We choose the node that is marked 29482110350909701fcd6b55c636e24a675f0a905feaJordan Rose // with the lowest BFS number. 2949228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose OrigN = *std::min_element(OrigN->pred_begin(), OrigN->pred_end(), 2950228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose PriorityCompare<false>(PriorityMap)); 29512110350909701fcd6b55c636e24a675f0a905feaJordan Rose } 29522110350909701fcd6b55c636e24a675f0a905feaJordan Rose 2953176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines GraphWrapper.Graph = std::move(GNew); 2954176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines 2955228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose return true; 29562110350909701fcd6b55c636e24a675f0a905feaJordan Rose} 29572110350909701fcd6b55c636e24a675f0a905feaJordan Rose 29582110350909701fcd6b55c636e24a675f0a905feaJordan Rose 29593106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek/// CompactPathDiagnostic - This function postprocesses a PathDiagnostic object 29603106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek/// and collapses PathDiagosticPieces that are expanded by macros. 296177d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenekstatic void CompactPathDiagnostic(PathPieces &path, const SourceManager& SM) { 29622042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek typedef std::vector<std::pair<IntrusiveRefCntPtr<PathDiagnosticMacroPiece>, 29632042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek SourceLocation> > MacroStackTy; 29641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2965c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith typedef std::vector<IntrusiveRefCntPtr<PathDiagnosticPiece> > 29663106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PiecesTy; 29671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29683106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroStackTy MacroStack; 29693106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek PiecesTy Pieces; 29701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2971ed866e73bab7733f5226f84c52edefe23d694b2fTed Kremenek for (PathPieces::const_iterator I = path.begin(), E = path.end(); 29722042fc1f36d471f437023e8899f0c4fadded2341Ted Kremenek I!=E; ++I) { 297387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 2974c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines PathDiagnosticPiece *piece = I->get(); 297577d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek 297677d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek // Recursively compact calls. 297777d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek if (PathDiagnosticCallPiece *call=dyn_cast<PathDiagnosticCallPiece>(piece)){ 297877d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek CompactPathDiagnostic(call->path, SM); 297977d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek } 298087d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 29813106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Get the location of the PathDiagnosticPiece. 298277d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek const FullSourceLoc Loc = piece->getLocation().asLocation(); 29831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29843106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Determine the instantiation location, which is the location we group 29853106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // related PathDiagnosticPieces. 29861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump SourceLocation InstantiationLoc = Loc.isMacroID() ? 2987402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SM.getExpansionLoc(Loc) : 29883106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek SourceLocation(); 29891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29903106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (Loc.isFileID()) { 29913106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroStack.clear(); 299277d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek Pieces.push_back(piece); 29933106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek continue; 29943106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 2995706e3cf2fa7523b5497c52c11a2b6dad2a1ce2acTed Kremenek 29963106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek assert(Loc.isMacroID()); 29971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29983106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Is the PathDiagnosticPiece within the same macro group? 29993106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (!MacroStack.empty() && InstantiationLoc == MacroStack.back().second) { 300077d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek MacroStack.back().first->subPieces.push_back(piece); 30013106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek continue; 30023106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 3003d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek 30043106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // We aren't in the same group. Are we descending into a new macro 30053106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // or are part of an old one? 3006c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmith IntrusiveRefCntPtr<PathDiagnosticMacroPiece> MacroGroup; 3007d8c938b0f6b7a7156181be575239e4c6e15a2adbTed Kremenek 30083106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek SourceLocation ParentInstantiationLoc = InstantiationLoc.isMacroID() ? 3009402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SM.getExpansionLoc(Loc) : 30103106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek SourceLocation(); 30111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 30123106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Walk the entire macro stack. 30133106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek while (!MacroStack.empty()) { 30143106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (InstantiationLoc == MacroStack.back().second) { 30153106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroGroup = MacroStack.back().first; 30163106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 30173106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 30181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 30193106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (ParentInstantiationLoc == MacroStack.back().second) { 30203106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroGroup = MacroStack.back().first; 30213106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek break; 302261f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek } 30231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 30243106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroStack.pop_back(); 30256837faa083bebad39aa342f84c2b450fb6410eafTed Kremenek } 30261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 30273106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (!MacroGroup || ParentInstantiationLoc == MacroStack.back().second) { 30283106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Create a new macro group and add it to the stack. 3029590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticMacroPiece *NewGroup = 3030590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks new PathDiagnosticMacroPiece( 303177d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek PathDiagnosticLocation::createSingleLocation(piece->getLocation())); 30325a429954aedd8a830a70fcea2cb51561673e4fc3Ted Kremenek 30333106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek if (MacroGroup) 3034802e02463b880f53a6e645bde78cc412481ce9e0Ted Kremenek MacroGroup->subPieces.push_back(NewGroup); 30353106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek else { 30363106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek assert(InstantiationLoc.isFileID()); 30373106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek Pieces.push_back(NewGroup); 30383106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 30391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 30403106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroGroup = NewGroup; 30413106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek MacroStack.push_back(std::make_pair(MacroGroup, InstantiationLoc)); 30427dc8664a54f4ede40a5f4adee3f5081a59d7ee1cTed Kremenek } 30433106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek 30443106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Finally, add the PathDiagnosticPiece to the group. 304577d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek MacroGroup->subPieces.push_back(piece); 30463106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek } 30471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 30483106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek // Now take the pieces and construct a new PathDiagnostic. 304977d09441e59d3bced6c3d55505eb3a67a784fe02Ted Kremenek path.clear(); 30501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 30510e2c34f92f00628d48968dfea096d36381f494cbStephen Hines path.insert(path.end(), Pieces.begin(), Pieces.end()); 305261f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek} 305361f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 30548347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rosebool GRBugReporter::generatePathDiagnostic(PathDiagnostic& PD, 3055c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticConsumer &PC, 3056c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<BugReport *> &bugReports) { 305740406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek assert(!bugReports.empty()); 30588347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 30599a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose bool HasValid = false; 3060228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose bool HasInvalid = false; 30612f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose SmallVector<const ExplodedNode *, 32> errorNodes; 3062c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek for (ArrayRef<BugReport*>::iterator I = bugReports.begin(), 30639a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose E = bugReports.end(); I != E; ++I) { 30649a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose if ((*I)->isValid()) { 30659a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose HasValid = true; 30669a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose errorNodes.push_back((*I)->getErrorNode()); 30679a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose } else { 3068228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose // Keep the errorNodes list in sync with the bugReports list. 3069228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose HasInvalid = true; 30706bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines errorNodes.push_back(nullptr); 30719a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose } 307240406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek } 30731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 30749a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose // If all the reports have been marked invalid by a previous path generation, 30759a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose // we're done. 30769a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose if (!HasValid) 30779a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose return false; 30789a9fe4068eed2fc72ec985e5ae393fb79a8fb9adJordan Rose 30792f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose typedef PathDiagnosticConsumer::PathGenerationScheme PathGenerationScheme; 30802f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose PathGenerationScheme ActiveScheme = PC.getGenerationScheme(); 30812f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 3082af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek if (ActiveScheme == PathDiagnosticConsumer::Extensive) { 3083d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks AnalyzerOptions &options = getAnalyzerOptions(); 3084048eeea6852043990c87e52938b53b5337bd098eJordan Rose if (options.getBooleanOption("path-diagnostics-alternate", true)) { 3085af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek ActiveScheme = PathDiagnosticConsumer::AlternateExtensive; 3086af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 3087af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek } 3088af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek 30891efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose TrimmedGraph TrimG(&getGraph(), errorNodes); 3090228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose ReportGraph ErrorGraph; 30911efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose 3092228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose while (TrimG.popNextReportGraph(ErrorGraph)) { 30932f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Find the BugReport with the original location. 30941efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose assert(ErrorGraph.Index < bugReports.size()); 30951efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose BugReport *R = bugReports[ErrorGraph.Index]; 30962f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose assert(R && "No original report found for sliced graph."); 30972f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose assert(R->isValid() && "Report selected by trimmed graph marked invalid."); 30982f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 30992f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Start building the path diagnostic... 31001efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose PathDiagnosticBuilder PDB(*this, R, ErrorGraph.BackMap, &PC); 31011efffab67364f5afcc25f5f5f77e0f7ba5d41055Jordan Rose const ExplodedNode *N = ErrorGraph.ErrorNode; 31022f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 31032f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Register additional node visitors. 3104176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines R->addVisitor(llvm::make_unique<NilReceiverBRVisitor>()); 3105176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines R->addVisitor(llvm::make_unique<ConditionBRVisitor>()); 3106176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines R->addVisitor(llvm::make_unique<LikelyFalsePositiveSuppressionBRVisitor>()); 31072f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 31082f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose BugReport::VisitorList visitors; 31092f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose unsigned origReportConfigToken, finalReportConfigToken; 3110d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek LocationContextMap LCM; 31112f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 31122f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // While generating diagnostics, it's possible the visitors will decide 31132f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // new symbols and regions are interesting, or add other visitors based on 31142f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // the information they find. If they do, we need to regenerate the path 31152f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // based on our new report configuration. 31162f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose do { 31172f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Get a clean copy of all the visitors. 31182f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose for (BugReport::visitor_iterator I = R->visitor_begin(), 31192f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose E = R->visitor_end(); I != E; ++I) 31202f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose visitors.push_back((*I)->clone()); 31212f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 31222f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Clear out the active path from any previous work. 31232f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose PD.resetPath(); 31242f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose origReportConfigToken = R->getConfigurationChangeToken(); 31252f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 312687d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar // Generate the very last diagnostic piece - the piece is visible before 31272f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // the trace is expanded. 31286bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines std::unique_ptr<PathDiagnosticPiece> LastPiece; 31292f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose for (BugReport::visitor_iterator I = visitors.begin(), E = visitors.end(); 31302f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose I != E; ++I) { 3131176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines if (std::unique_ptr<PathDiagnosticPiece> Piece = 3132176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines (*I)->getEndPath(PDB, N, *R)) { 31332f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose assert (!LastPiece && 31342f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose "There can only be one final piece in a diagnostic."); 3135176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines LastPiece = std::move(Piece); 31362f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose } 31373bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose } 313886ff12c8a8a356ca284ca7687749216fbfd74519Anna Zaks 31392f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose if (ActiveScheme != PathDiagnosticConsumer::None) { 31402f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose if (!LastPiece) 3141176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines LastPiece = BugReporterVisitor::getDefaultEndPath(PDB, N, *R); 31422f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose assert(LastPiece); 3143176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines PD.setEndOfPath(std::move(LastPiece)); 31448347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose } 31452f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 3146d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek // Make sure we get a clean location context map so we don't 3147d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek // hold onto old mappings. 3148d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek LCM.clear(); 3149d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek 31502f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose switch (ActiveScheme) { 3151af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek case PathDiagnosticConsumer::AlternateExtensive: 3152af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek GenerateAlternateExtensivePathDiagnostic(PD, PDB, N, LCM, visitors); 3153af2836593979d4973bec5bd21f10eb6cc0d0f3e3Ted Kremenek break; 31542f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose case PathDiagnosticConsumer::Extensive: 3155d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek GenerateExtensivePathDiagnostic(PD, PDB, N, LCM, visitors); 31562f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose break; 31572f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose case PathDiagnosticConsumer::Minimal: 3158d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek GenerateMinimalPathDiagnostic(PD, PDB, N, LCM, visitors); 31592f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose break; 31602f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose case PathDiagnosticConsumer::None: 31612f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose GenerateVisitorsOnlyPathDiagnostic(PD, PDB, N, visitors); 31622f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose break; 3163d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose } 31643bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 31652f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Clean up the visitors we used. 3166176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines visitors.clear(); 31673bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 31682f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Did anything change while generating this path? 31692f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose finalReportConfigToken = R->getConfigurationChangeToken(); 31702f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose } while (finalReportConfigToken != origReportConfigToken); 31713bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 3172228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose if (!R->isValid()) 31732f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose continue; 3174b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek 31752f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // Finally, prune the diagnostic path of uninteresting stuff. 31762f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose if (!PD.path.empty()) { 3177d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks if (R->shouldPrunePath() && getAnalyzerOptions().shouldPrunePaths()) { 3178d306a530fca74e40916121f5583e0545e470b3c4Ted Kremenek bool stillHasNotes = removeUnneededCalls(PD.getMutablePieces(), R, LCM); 31792f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose assert(stillHasNotes); 31802f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose (void)stillHasNotes; 31812f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose } 31822f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose 31836838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks // Redirect all call pieces to have valid locations. 31842f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose adjustCallLocations(PD.getMutablePieces()); 31856838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks removePiecesWithInvalidLocations(PD.getMutablePieces()); 31866838710779a23ea5dfdb5764ad7b7a7451b00bf8Anna Zaks 3187bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek if (ActiveScheme == PathDiagnosticConsumer::AlternateExtensive) { 3188aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek SourceManager &SM = getSourceManager(); 3189aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek 3190aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek // Reduce the number of edges from a very conservative set 3191aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek // to an aesthetically pleasing subset that conveys the 3192aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek // necessary information. 319315676bec6fa9ad9466d93c163f2d1b8a3f559b3aTed Kremenek OptimizedCallsSet OCS; 3194bb518991ce4298d8662235fc8cb13813f011c18dJordan Rose while (optimizeEdges(PD.getMutablePieces(), SM, OCS, LCM)) {} 3195aecda966174516c0ac7c05ceb40e88fc99bcf27cTed Kremenek 319601f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose // Drop the very first function-entry edge. It's not really necessary 319701f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose // for top-level functions. 319801f1ff79f70b3e042995a43b29ccbf0fffc77d5fJordan Rose dropFunctionEntryEdge(PD.getMutablePieces(), LCM, SM); 3199bb521b8f14ca29ee4e17ae1f9877586ef0bf8378Ted Kremenek } 3200574c7cf6d0c8e8f8ecda360ae271d5391c404534Jordan Rose 3201d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose // Remove messages that are basically the same, and edges that may not 3202d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose // make sense. 3203574c7cf6d0c8e8f8ecda360ae271d5391c404534Jordan Rose // We have to do this after edge optimization in the Extensive mode. 3204574c7cf6d0c8e8f8ecda360ae271d5391c404534Jordan Rose removeRedundantMsgs(PD.getMutablePieces()); 3205d3d0dcfbf784c828c2f07384fd6a3401b0cd4e9eJordan Rose removeEdgesToDefaultInitializers(PD.getMutablePieces()); 3206b85cce094887ab5cf1c47acfe306e2fb1d3cfbb1Ted Kremenek } 3207afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose 32082f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // We found a report and didn't suppress it. 32092f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose return true; 3210ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek } 32118347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 32122f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose // We suppressed all the reports in this equivalence class. 3213228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose assert(!HasInvalid && "Inconsistent suppression"); 3214228094a28f81ddba94427239dea5c6e59ff6aabcJordan Rose (void)HasInvalid; 32152f13eb116e62161c5e4d198f7831f226e5cea9daJordan Rose return false; 32163106198188ac6eb2753f1764d5c28376b0b76351Ted Kremenek} 32171aa44c7c9198796085b77c6bdd7c90030845a688Ted Kremenek 3218cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekvoid BugReporter::Register(BugType *BT) { 32193baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugTypes = F.add(BugTypes, BT); 322076d90c8bf83d071fd1bdbffa6d9f2af87c6bb7b5Ted Kremenek} 322176d90c8bf83d071fd1bdbffa6d9f2af87c6bb7b5Ted Kremenek 322287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainarvoid BugReporter::emitReport(std::unique_ptr<BugReport> R) { 3223cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose if (const ExplodedNode *E = R->getErrorNode()) { 322487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar // An error node must either be a sink or have a tag, otherwise 322587d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar // it could get reclaimed before the path diagnostic is created. 322687d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar assert((E->isSink() || E->getLocation().getTag()) && 322787d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar "Error node must either be a sink or have a tag"); 322887d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 3229176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines const AnalysisDeclContext *DeclCtx = 3230176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines E->getLocationContext()->getAnalysisDeclContext(); 3231176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines // The source of autosynthesized body can be handcrafted AST or a model 3232176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines // file. The locations from handcrafted ASTs have no valid source locations 3233176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines // and have to be discarded. Locations from model files should be preserved 3234176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines // for processing and reporting. 3235176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines if (DeclCtx->isBodyAutosynthesized() && 3236176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines !DeclCtx->isBodyAutosynthesizedFromModelFile()) 3237cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose return; 3238cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose } 323987d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 3240cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose bool ValidSourceLoc = R->getLocation(getSourceManager()).isValid(); 3241cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose assert(ValidSourceLoc); 3242cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose // If we mess up in a release build, we'd still prefer to just drop the bug 3243cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose // instead of trying to go on. 3244cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose if (!ValidSourceLoc) 3245cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose return; 3246cd007b18ba218925923a82ad4462fecf903f4a93Jordan Rose 3247cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek // Compute the bug report's hash to determine its equivalence class. 3248cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek llvm::FoldingSetNodeID ID; 3249cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek R->Profile(ID); 32501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 32511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Lookup the equivance class. If there isn't one, create it. 3252cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugType& BT = R->getBugType(); 3253cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek Register(&BT); 3254cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void *InsertPos; 3255404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis BugReportEquivClass* EQ = EQClasses.FindNodeOrInsertPos(ID, InsertPos); 32561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3257cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek if (!EQ) { 325887d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar EQ = new BugReportEquivClass(std::move(R)); 3259404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis EQClasses.InsertNode(EQ, InsertPos); 32603b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks EQClassesVector.push_back(EQ); 3261176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines } else 326287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar EQ->AddReport(std::move(R)); 326361f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek} 326461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 326506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 326606c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek//===----------------------------------------------------------------------===// 326706c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek// Emitting reports in equivalence classes. 326806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek//===----------------------------------------------------------------------===// 326906c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 327006c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremeneknamespace { 3271ba5fb5a955c896815c439289fc51c03cf0635129Kovarththanan Rajaratnamstruct FRIEC_WLItem { 327206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek const ExplodedNode *N; 327306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek ExplodedNode::const_succ_iterator I, E; 327487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 327506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek FRIEC_WLItem(const ExplodedNode *n) 327606c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek : N(n), I(N->succ_begin()), E(N->succ_end()) {} 327787d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar}; 327806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek} 327906c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 328061f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenekstatic BugReport * 328161f52bd3c524268e25b48a1ed3730aedd6cc8374Ted KremenekFindReportInEquivalenceClass(BugReportEquivClass& EQ, 32825f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVectorImpl<BugReport*> &bugReports) { 328361f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 328406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek BugReportEquivClass::iterator I = EQ.begin(), E = EQ.end(); 328506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek assert(I != E); 32864a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer BugType& BT = I->getBugType(); 328761f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 328840406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek // If we don't need to suppress any of the nodes because they are 328940406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek // post-dominated by a sink, simply add all the nodes in the equivalence class 329040406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek // to 'Nodes'. Any of the reports will serve as a "representative" report. 329161f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek if (!BT.isSuppressOnSink()) { 329287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar BugReport *R = &*I; 329361f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek for (BugReportEquivClass::iterator I=EQ.begin(), E=EQ.end(); I!=E; ++I) { 32949c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *N = I->getErrorNode(); 329561f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek if (N) { 329687d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar R = &*I; 329740406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek bugReports.push_back(R); 329861f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek } 329961f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek } 330006c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek return R; 330161f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek } 330261f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 330306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // For bug reports that should be suppressed when all paths are post-dominated 330406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // by a sink node, iterate through the reports in the equivalence class 330506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // until we find one that isn't post-dominated (if one exists). We use a 330606c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // DFS traversal of the ExplodedGraph to find a non-sink node. We could write 330706c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // this as a recursive function, but we don't want to risk blowing out the 330806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // stack for very long paths. 33096bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines BugReport *exampleReport = nullptr; 331061f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 331106c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek for (; I != E; ++I) { 33124a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer const ExplodedNode *errorNode = I->getErrorNode(); 331306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 331440406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek if (!errorNode) 331506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek continue; 331640406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek if (errorNode->isSink()) { 3317b219cfc4d75f0a03630b7c4509ef791b7e97b2c8David Blaikie llvm_unreachable( 331806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek "BugType::isSuppressSink() should not be 'true' for sink end nodes"); 331906c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 332061f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // No successors? By definition this nodes isn't post-dominated by a sink. 332140406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek if (errorNode->succ_empty()) { 332287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar bugReports.push_back(&*I); 332340406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek if (!exampleReport) 332487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar exampleReport = &*I; 332561f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek continue; 332661f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek } 332761f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 332806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // At this point we know that 'N' is not a sink and it has at least one 332987d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar // successor. Use a DFS worklist to find a non-sink end-of-path node. 333006c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek typedef FRIEC_WLItem WLItem; 33315f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner typedef SmallVector<WLItem, 10> DFSWorkList; 333206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek llvm::DenseMap<const ExplodedNode *, unsigned> Visited; 333387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 333406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek DFSWorkList WL; 333540406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek WL.push_back(errorNode); 333640406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek Visited[errorNode] = 1; 333787d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 333806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek while (!WL.empty()) { 333906c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek WLItem &WI = WL.back(); 334006c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek assert(!WI.N->succ_empty()); 334187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 334206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek for (; WI.I != WI.E; ++WI.I) { 334387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar const ExplodedNode *Succ = *WI.I; 334406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // End-of-path node? 334506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek if (Succ->succ_empty()) { 334661f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // If we found an end-of-path node that is not a sink. 334761f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek if (!Succ->isSink()) { 334887d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar bugReports.push_back(&*I); 334940406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek if (!exampleReport) 335087d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar exampleReport = &*I; 335161f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek WL.clear(); 335261f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek break; 335361f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek } 335406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // Found a sink? Continue on to the next successor. 335506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek continue; 335606c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 335706c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // Mark the successor as visited. If it hasn't been explored, 335806c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek // enqueue it to the DFS worklist. 335906c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek unsigned &mark = Visited[Succ]; 336006c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek if (!mark) { 336106c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek mark = 1; 336206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek WL.push_back(Succ); 336306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek break; 336406c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 336506c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 336661f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek 336761f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // The worklist may have been cleared at this point. First 336861f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // check if it is empty before checking the last item. 336961f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek if (!WL.empty() && &WL.back() == &WI) 337006c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek WL.pop_back(); 337106c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 337206c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek } 337306c9cb4d1a29e708f51bce9f7ee5acbe1c3761c3Ted Kremenek 337461f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // ExampleReport will be NULL if all the nodes in the equivalence class 337561f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek // were post-dominated by sinks. 337640406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek return exampleReport; 337761f52bd3c524268e25b48a1ed3730aedd6cc8374Ted Kremenek} 3378e0a58073b76fc016325a35152533b8468df2bf4aTed Kremenek 3379cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekvoid BugReporter::FlushReport(BugReportEquivClass& EQ) { 33805f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner SmallVector<BugReport*, 10> bugReports; 338140406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek BugReport *exampleReport = FindReportInEquivalenceClass(EQ, bugReports); 3382c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek if (exampleReport) { 3383651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines for (PathDiagnosticConsumer *PDC : getPathDiagnosticConsumers()) { 3384651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines FlushReport(exampleReport, *PDC, bugReports); 3385c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek } 3386c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek } 3387c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek} 3388c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 3389c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekvoid BugReporter::FlushReport(BugReport *exampleReport, 3390c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticConsumer &PD, 3391c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<BugReport*> bugReports) { 33921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3393cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek // FIXME: Make sure we use the 'R' for the path that was actually used. 33941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // Probably doesn't make a difference in practice. 339540406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek BugType& BT = exampleReport->getBugType(); 33961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3397651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines std::unique_ptr<PathDiagnostic> D(new PathDiagnostic( 3398651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines exampleReport->getBugType().getCheckName(), 3399651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines exampleReport->getDeclWithIssue(), exampleReport->getBugType().getName(), 3400651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines exampleReport->getDescription(), 3401651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines exampleReport->getShortDescription(/*Fallback=*/false), BT.getCategory(), 3402651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines exampleReport->getUniqueingLocation(), 3403651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines exampleReport->getUniqueingDecl())); 3404d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek 3405cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose MaxBugClassSize = std::max(bugReports.size(), 3406cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose static_cast<size_t>(MaxBugClassSize)); 3407cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose 3408c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek // Generate the full path diagnostic, using the generation scheme 3409d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // specified by the PathDiagnosticConsumer. Note that we have to generate 3410d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // path diagnostics even for consumers which do not support paths, because 3411d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose // the BugReporterVisitors may mark this bug as a false positive. 3412d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose if (!bugReports.empty()) 3413d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose if (!generatePathDiagnostic(*D.get(), PD, bugReports)) 3414d632d6fc606f0be438c3b6fe5c43f1b3f5db98b1Jordan Rose return; 34153148eb4a75f70f2636075c364d03104223f004d3Ted Kremenek 3416cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose MaxValidBugClassSize = std::max(bugReports.size(), 3417cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose static_cast<size_t>(MaxValidBugClassSize)); 3418cc08ca9b3cd2b715a699bcc772ce2e83a502915aJordan Rose 3419d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks // Examine the report and see if the last piece is in a header. Reset the 3420d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks // report location to the last piece in the main source file. 3421d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks AnalyzerOptions& Opts = getAnalyzerOptions(); 3422d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks if (Opts.shouldReportIssuesInMainSourceFile() && !Opts.AnalyzeAll) 3423d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks D->resetDiagnosticLocationToMainFile(); 3424d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks 3425c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek // If the path is empty, generate a single step path with the location 3426c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek // of the issue. 3427802e02463b880f53a6e645bde78cc412481ce9e0Ted Kremenek if (D->path.empty()) { 3428c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticLocation L = exampleReport->getLocation(getSourceManager()); 3429176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines auto piece = llvm::make_unique<PathDiagnosticEventPiece>( 3430176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines L, exampleReport->getDescription()); 343187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar for (SourceRange Range : exampleReport->getRanges()) 34320e2c34f92f00628d48968dfea096d36381f494cbStephen Hines piece->addRange(Range); 3433176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines D->setEndOfPath(std::move(piece)); 34343148eb4a75f70f2636075c364d03104223f004d3Ted Kremenek } 34351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3436c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek // Get the meta data. 3437c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek const BugReport::ExtraTextList &Meta = exampleReport->getExtraText(); 3438c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek for (BugReport::ExtraTextList::const_iterator i = Meta.begin(), 3439c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek e = Meta.end(); i != e; ++i) { 3440c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek D->addMeta(*i); 3441c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek } 3442c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 3443176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines PD.HandlePathDiagnostic(std::move(D)); 344461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek} 344557202071e477530e9348bc76671ee369b2399b92Ted Kremenek 344607189521a15d9c088216b943649cb9fe231cbb57Ted Kremenekvoid BugReporter::EmitBasicReport(const Decl *DeclWithIssue, 3447651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines const CheckerBase *Checker, 3448651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines StringRef Name, StringRef Category, 3449651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines StringRef Str, PathDiagnosticLocation Loc, 3450651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines ArrayRef<SourceRange> Ranges) { 3451651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines EmitBasicReport(DeclWithIssue, Checker->getCheckName(), Name, Category, Str, 3452651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines Loc, Ranges); 3453651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines} 3454651f13cea278ec967336033dd032faef0e9fc2ecStephen Hinesvoid BugReporter::EmitBasicReport(const Decl *DeclWithIssue, 3455651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines CheckName CheckName, 3456651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines StringRef name, StringRef category, 3457590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef str, PathDiagnosticLocation Loc, 345831b71f3097a338315a144067dde5b160c4e44fc9Jordan Rose ArrayRef<SourceRange> Ranges) { 34591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3460404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis // 'BT' is owned by BugReporter. 3461651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines BugType *BT = getBugTypeForName(CheckName, name, category); 346287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar auto R = llvm::make_unique<BugReport>(*BT, str, Loc); 346307189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek R->setDeclWithIssue(DeclWithIssue); 346431b71f3097a338315a144067dde5b160c4e44fc9Jordan Rose for (ArrayRef<SourceRange>::iterator I = Ranges.begin(), E = Ranges.end(); 346531b71f3097a338315a144067dde5b160c4e44fc9Jordan Rose I != E; ++I) 346631b71f3097a338315a144067dde5b160c4e44fc9Jordan Rose R->addRange(*I); 346787d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar emitReport(std::move(R)); 3468cabe66811fe43835b8c5a0854552768fc53261e3Ted Kremenek} 3469404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 3470651f13cea278ec967336033dd032faef0e9fc2ecStephen HinesBugType *BugReporter::getBugTypeForName(CheckName CheckName, StringRef name, 34715f9e272e632e951b1efe824cd16acb4d96077930Chris Lattner StringRef category) { 3472f7ccbad5d9949e7ddd1cbef43d482553b811e026Dylan Noblesmith SmallString<136> fullDesc; 3473651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines llvm::raw_svector_ostream(fullDesc) << CheckName.getName() << ":" << name 3474651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines << ":" << category; 3475176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines BugType *&BT = StrBugTypes[fullDesc]; 3476176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines if (!BT) 3477651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines BT = new BugType(CheckName, name, category); 3478404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis return BT; 3479404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis} 3480632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose 3481651f13cea278ec967336033dd032faef0e9fc2ecStephen HinesLLVM_DUMP_METHOD void PathPieces::dump() const { 3482632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose unsigned index = 0; 3483632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose for (PathPieces::const_iterator I = begin(), E = end(); I != E; ++I) { 3484632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "[" << index++ << "] "; 3485632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose (*I)->dump(); 3486632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "\n"; 3487632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose } 3488632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose} 3489632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose 34904967a710c84587c654b56c828382219c3937dacbPirama Arumuga NainarLLVM_DUMP_METHOD void PathDiagnosticCallPiece::dump() const { 3491632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "CALL\n--------------\n"; 3492632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose 3493632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose if (const Stmt *SLoc = getLocStmt(getLocation())) 3494632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose SLoc->dump(); 3495632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose else if (const NamedDecl *ND = dyn_cast<NamedDecl>(getCallee())) 3496632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << *ND << "\n"; 3497632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose else 3498632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose getLocation().dump(); 3499632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose} 3500632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose 35014967a710c84587c654b56c828382219c3937dacbPirama Arumuga NainarLLVM_DUMP_METHOD void PathDiagnosticEventPiece::dump() const { 3502632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "EVENT\n--------------\n"; 3503632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << getString() << "\n"; 3504632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << " ---- at ----\n"; 3505632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose getLocation().dump(); 3506632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose} 3507632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose 35084967a710c84587c654b56c828382219c3937dacbPirama Arumuga NainarLLVM_DUMP_METHOD void PathDiagnosticControlFlowPiece::dump() const { 3509632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "CONTROL\n--------------\n"; 3510632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose getStartLocation().dump(); 3511632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << " ---- to ----\n"; 3512632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose getEndLocation().dump(); 3513632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose} 3514632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose 35154967a710c84587c654b56c828382219c3937dacbPirama Arumuga NainarLLVM_DUMP_METHOD void PathDiagnosticMacroPiece::dump() const { 3516632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "MACRO\n--------------\n"; 3517632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose // FIXME: Print which macro is being invoked. 3518632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose} 3519632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose 35204967a710c84587c654b56c828382219c3937dacbPirama Arumuga NainarLLVM_DUMP_METHOD void PathDiagnosticLocation::dump() const { 3521632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose if (!isValid()) { 3522632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "<INVALID>\n"; 3523632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose return; 3524632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose } 3525632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose 3526632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose switch (K) { 3527632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose case RangeK: 3528632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose // FIXME: actually print the range. 3529632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "<range>\n"; 3530632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose break; 3531632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose case SingleLocK: 3532632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose asLocation().dump(); 3533632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "\n"; 3534632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose break; 3535632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose case StmtK: 3536632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose if (S) 3537632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose S->dump(); 3538632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose else 3539632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "<NULL STMT>\n"; 3540632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose break; 3541632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose case DeclK: 3542632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose if (const NamedDecl *ND = dyn_cast_or_null<NamedDecl>(D)) 3543632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << *ND << "\n"; 3544632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose else if (isa<BlockDecl>(D)) 3545632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose // FIXME: Make this nicer. 3546632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "<block>\n"; 3547632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose else if (D) 3548632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "<unknown decl>\n"; 3549632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose else 3550632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose llvm::errs() << "<NULL DECL>\n"; 3551632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose break; 3552632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose } 3553632182d0e2011a6e21cf9abe34eef5a1f037e7efJordan Rose} 3554