BugReporter.cpp revision d474da062565596015558856333423199aed5eb1
1// BugReporter.cpp - Generate PathDiagnostics for Bugs ------------*- C++ -*--// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 10// This file defines BugReporter, a utility class for generating 11// PathDiagnostics. 12// 13//===----------------------------------------------------------------------===// 14 15#define DEBUG_TYPE "BugReporter" 16 17#include "clang/StaticAnalyzer/Core/BugReporter/BugReporter.h" 18#include "clang/AST/ASTContext.h" 19#include "clang/AST/DeclObjC.h" 20#include "clang/AST/Expr.h" 21#include "clang/AST/ParentMap.h" 22#include "clang/AST/StmtObjC.h" 23#include "clang/Analysis/CFG.h" 24#include "clang/Analysis/ProgramPoint.h" 25#include "clang/Basic/SourceManager.h" 26#include "clang/StaticAnalyzer/Core/BugReporter/BugType.h" 27#include "clang/StaticAnalyzer/Core/BugReporter/PathDiagnostic.h" 28#include "clang/StaticAnalyzer/Core/PathSensitive/ExprEngine.h" 29#include "llvm/ADT/DenseMap.h" 30#include "llvm/ADT/IntrusiveRefCntPtr.h" 31#include "llvm/ADT/OwningPtr.h" 32#include "llvm/ADT/STLExtras.h" 33#include "llvm/ADT/SmallString.h" 34#include "llvm/ADT/Statistic.h" 35#include "llvm/Support/raw_ostream.h" 36#include <queue> 37 38using namespace clang; 39using namespace ento; 40 41STATISTIC(MaxBugClassSize, 42 "The maximum number of bug reports in the same equivalence class"); 43STATISTIC(MaxValidBugClassSize, 44 "The maximum number of bug reports in the same equivalence class " 45 "where at least one report is valid (not suppressed)"); 46 47BugReporterVisitor::~BugReporterVisitor() {} 48 49void BugReporterContext::anchor() {} 50 51//===----------------------------------------------------------------------===// 52// Helper routines for walking the ExplodedGraph and fetching statements. 53//===----------------------------------------------------------------------===// 54 55static const Stmt *GetPreviousStmt(const ExplodedNode *N) { 56 for (N = N->getFirstPred(); N; N = N->getFirstPred()) 57 if (const Stmt *S = PathDiagnosticLocation::getStmt(N)) 58 return S; 59 60 return 0; 61} 62 63static inline const Stmt* 64GetCurrentOrPreviousStmt(const ExplodedNode *N) { 65 if (const Stmt *S = PathDiagnosticLocation::getStmt(N)) 66 return S; 67 68 return GetPreviousStmt(N); 69} 70 71//===----------------------------------------------------------------------===// 72// Diagnostic cleanup. 73//===----------------------------------------------------------------------===// 74 75static PathDiagnosticEventPiece * 76eventsDescribeSameCondition(PathDiagnosticEventPiece *X, 77 PathDiagnosticEventPiece *Y) { 78 // Prefer diagnostics that come from ConditionBRVisitor over 79 // those that came from TrackConstraintBRVisitor. 80 const void *tagPreferred = ConditionBRVisitor::getTag(); 81 const void *tagLesser = TrackConstraintBRVisitor::getTag(); 82 83 if (X->getLocation() != Y->getLocation()) 84 return 0; 85 86 if (X->getTag() == tagPreferred && Y->getTag() == tagLesser) 87 return X; 88 89 if (Y->getTag() == tagPreferred && X->getTag() == tagLesser) 90 return Y; 91 92 return 0; 93} 94 95/// An optimization pass over PathPieces that removes redundant diagnostics 96/// generated by both ConditionBRVisitor and TrackConstraintBRVisitor. Both 97/// BugReporterVisitors use different methods to generate diagnostics, with 98/// one capable of emitting diagnostics in some cases but not in others. This 99/// can lead to redundant diagnostic pieces at the same point in a path. 100static void removeRedundantMsgs(PathPieces &path) { 101 unsigned N = path.size(); 102 if (N < 2) 103 return; 104 // NOTE: this loop intentionally is not using an iterator. Instead, we 105 // are streaming the path and modifying it in place. This is done by 106 // grabbing the front, processing it, and if we decide to keep it append 107 // it to the end of the path. The entire path is processed in this way. 108 for (unsigned i = 0; i < N; ++i) { 109 IntrusiveRefCntPtr<PathDiagnosticPiece> piece(path.front()); 110 path.pop_front(); 111 112 switch (piece->getKind()) { 113 case clang::ento::PathDiagnosticPiece::Call: 114 removeRedundantMsgs(cast<PathDiagnosticCallPiece>(piece)->path); 115 break; 116 case clang::ento::PathDiagnosticPiece::Macro: 117 removeRedundantMsgs(cast<PathDiagnosticMacroPiece>(piece)->subPieces); 118 break; 119 case clang::ento::PathDiagnosticPiece::ControlFlow: 120 break; 121 case clang::ento::PathDiagnosticPiece::Event: { 122 if (i == N-1) 123 break; 124 125 if (PathDiagnosticEventPiece *nextEvent = 126 dyn_cast<PathDiagnosticEventPiece>(path.front().getPtr())) { 127 PathDiagnosticEventPiece *event = 128 cast<PathDiagnosticEventPiece>(piece); 129 // Check to see if we should keep one of the two pieces. If we 130 // come up with a preference, record which piece to keep, and consume 131 // another piece from the path. 132 if (PathDiagnosticEventPiece *pieceToKeep = 133 eventsDescribeSameCondition(event, nextEvent)) { 134 piece = pieceToKeep; 135 path.pop_front(); 136 ++i; 137 } 138 } 139 break; 140 } 141 } 142 path.push_back(piece); 143 } 144} 145 146/// A map from PathDiagnosticPiece to the LocationContext of the inlined 147/// function call it represents. 148typedef llvm::DenseMap<const PathPieces *, const LocationContext *> 149 LocationContextMap; 150 151/// Recursively scan through a path and prune out calls and macros pieces 152/// that aren't needed. Return true if afterwards the path contains 153/// "interesting stuff" which means it shouldn't be pruned from the parent path. 154static bool removeUnneededCalls(PathPieces &pieces, BugReport *R, 155 LocationContextMap &LCM) { 156 bool containsSomethingInteresting = false; 157 const unsigned N = pieces.size(); 158 159 for (unsigned i = 0 ; i < N ; ++i) { 160 // Remove the front piece from the path. If it is still something we 161 // want to keep once we are done, we will push it back on the end. 162 IntrusiveRefCntPtr<PathDiagnosticPiece> piece(pieces.front()); 163 pieces.pop_front(); 164 165 // Throw away pieces with invalid locations. Note that we can't throw away 166 // calls just yet because they might have something interesting inside them. 167 // If so, their locations will be adjusted as necessary later. 168 if (piece->getKind() != PathDiagnosticPiece::Call && 169 piece->getLocation().asLocation().isInvalid()) 170 continue; 171 172 switch (piece->getKind()) { 173 case PathDiagnosticPiece::Call: { 174 PathDiagnosticCallPiece *call = cast<PathDiagnosticCallPiece>(piece); 175 // Check if the location context is interesting. 176 assert(LCM.count(&call->path)); 177 if (R->isInteresting(LCM[&call->path])) { 178 containsSomethingInteresting = true; 179 break; 180 } 181 182 if (!removeUnneededCalls(call->path, R, LCM)) 183 continue; 184 185 containsSomethingInteresting = true; 186 break; 187 } 188 case PathDiagnosticPiece::Macro: { 189 PathDiagnosticMacroPiece *macro = cast<PathDiagnosticMacroPiece>(piece); 190 if (!removeUnneededCalls(macro->subPieces, R, LCM)) 191 continue; 192 containsSomethingInteresting = true; 193 break; 194 } 195 case PathDiagnosticPiece::Event: { 196 PathDiagnosticEventPiece *event = cast<PathDiagnosticEventPiece>(piece); 197 198 // We never throw away an event, but we do throw it away wholesale 199 // as part of a path if we throw the entire path away. 200 containsSomethingInteresting |= !event->isPrunable(); 201 break; 202 } 203 case PathDiagnosticPiece::ControlFlow: 204 break; 205 } 206 207 pieces.push_back(piece); 208 } 209 210 return containsSomethingInteresting; 211} 212 213/// Returns true if the given decl has been implicitly given a body, either by 214/// the analyzer or by the compiler proper. 215static bool hasImplicitBody(const Decl *D) { 216 assert(D); 217 return D->isImplicit() || !D->hasBody(); 218} 219 220/// Recursively scan through a path and make sure that all call pieces have 221/// valid locations. Note that all other pieces with invalid locations should 222/// have already been pruned out. 223static void adjustCallLocations(PathPieces &Pieces, 224 PathDiagnosticLocation *LastCallLocation = 0) { 225 for (PathPieces::iterator I = Pieces.begin(), E = Pieces.end(); I != E; ++I) { 226 PathDiagnosticCallPiece *Call = dyn_cast<PathDiagnosticCallPiece>(*I); 227 228 if (!Call) { 229 assert((*I)->getLocation().asLocation().isValid()); 230 continue; 231 } 232 233 if (LastCallLocation) { 234 bool CallerIsImplicit = hasImplicitBody(Call->getCaller()); 235 if (CallerIsImplicit || !Call->callEnter.asLocation().isValid()) 236 Call->callEnter = *LastCallLocation; 237 if (CallerIsImplicit || !Call->callReturn.asLocation().isValid()) 238 Call->callReturn = *LastCallLocation; 239 } 240 241 // Recursively clean out the subclass. Keep this call around if 242 // it contains any informative diagnostics. 243 PathDiagnosticLocation *ThisCallLocation; 244 if (Call->callEnterWithin.asLocation().isValid() && 245 !hasImplicitBody(Call->getCallee())) 246 ThisCallLocation = &Call->callEnterWithin; 247 else 248 ThisCallLocation = &Call->callEnter; 249 250 assert(ThisCallLocation && "Outermost call has an invalid location"); 251 adjustCallLocations(Call->path, ThisCallLocation); 252 } 253} 254 255//===----------------------------------------------------------------------===// 256// PathDiagnosticBuilder and its associated routines and helper objects. 257//===----------------------------------------------------------------------===// 258 259namespace { 260class NodeMapClosure : public BugReport::NodeResolver { 261 InterExplodedGraphMap &M; 262public: 263 NodeMapClosure(InterExplodedGraphMap &m) : M(m) {} 264 265 const ExplodedNode *getOriginalNode(const ExplodedNode *N) { 266 return M.lookup(N); 267 } 268}; 269 270class PathDiagnosticBuilder : public BugReporterContext { 271 BugReport *R; 272 PathDiagnosticConsumer *PDC; 273 NodeMapClosure NMC; 274public: 275 const LocationContext *LC; 276 277 PathDiagnosticBuilder(GRBugReporter &br, 278 BugReport *r, InterExplodedGraphMap &Backmap, 279 PathDiagnosticConsumer *pdc) 280 : BugReporterContext(br), 281 R(r), PDC(pdc), NMC(Backmap), LC(r->getErrorNode()->getLocationContext()) 282 {} 283 284 PathDiagnosticLocation ExecutionContinues(const ExplodedNode *N); 285 286 PathDiagnosticLocation ExecutionContinues(llvm::raw_string_ostream &os, 287 const ExplodedNode *N); 288 289 BugReport *getBugReport() { return R; } 290 291 Decl const &getCodeDecl() { return R->getErrorNode()->getCodeDecl(); } 292 293 ParentMap& getParentMap() { return LC->getParentMap(); } 294 295 const Stmt *getParent(const Stmt *S) { 296 return getParentMap().getParent(S); 297 } 298 299 virtual NodeMapClosure& getNodeResolver() { return NMC; } 300 301 PathDiagnosticLocation getEnclosingStmtLocation(const Stmt *S); 302 303 PathDiagnosticConsumer::PathGenerationScheme getGenerationScheme() const { 304 return PDC ? PDC->getGenerationScheme() : PathDiagnosticConsumer::Extensive; 305 } 306 307 bool supportsLogicalOpControlFlow() const { 308 return PDC ? PDC->supportsLogicalOpControlFlow() : true; 309 } 310}; 311} // end anonymous namespace 312 313PathDiagnosticLocation 314PathDiagnosticBuilder::ExecutionContinues(const ExplodedNode *N) { 315 if (const Stmt *S = PathDiagnosticLocation::getNextStmt(N)) 316 return PathDiagnosticLocation(S, getSourceManager(), LC); 317 318 return PathDiagnosticLocation::createDeclEnd(N->getLocationContext(), 319 getSourceManager()); 320} 321 322PathDiagnosticLocation 323PathDiagnosticBuilder::ExecutionContinues(llvm::raw_string_ostream &os, 324 const ExplodedNode *N) { 325 326 // Slow, but probably doesn't matter. 327 if (os.str().empty()) 328 os << ' '; 329 330 const PathDiagnosticLocation &Loc = ExecutionContinues(N); 331 332 if (Loc.asStmt()) 333 os << "Execution continues on line " 334 << getSourceManager().getExpansionLineNumber(Loc.asLocation()) 335 << '.'; 336 else { 337 os << "Execution jumps to the end of the "; 338 const Decl *D = N->getLocationContext()->getDecl(); 339 if (isa<ObjCMethodDecl>(D)) 340 os << "method"; 341 else if (isa<FunctionDecl>(D)) 342 os << "function"; 343 else { 344 assert(isa<BlockDecl>(D)); 345 os << "anonymous block"; 346 } 347 os << '.'; 348 } 349 350 return Loc; 351} 352 353static bool IsNested(const Stmt *S, ParentMap &PM) { 354 if (isa<Expr>(S) && PM.isConsumedExpr(cast<Expr>(S))) 355 return true; 356 357 const Stmt *Parent = PM.getParentIgnoreParens(S); 358 359 if (Parent) 360 switch (Parent->getStmtClass()) { 361 case Stmt::ForStmtClass: 362 case Stmt::DoStmtClass: 363 case Stmt::WhileStmtClass: 364 return true; 365 default: 366 break; 367 } 368 369 return false; 370} 371 372PathDiagnosticLocation 373PathDiagnosticBuilder::getEnclosingStmtLocation(const Stmt *S) { 374 assert(S && "Null Stmt *passed to getEnclosingStmtLocation"); 375 ParentMap &P = getParentMap(); 376 SourceManager &SMgr = getSourceManager(); 377 378 while (IsNested(S, P)) { 379 const Stmt *Parent = P.getParentIgnoreParens(S); 380 381 if (!Parent) 382 break; 383 384 switch (Parent->getStmtClass()) { 385 case Stmt::BinaryOperatorClass: { 386 const BinaryOperator *B = cast<BinaryOperator>(Parent); 387 if (B->isLogicalOp()) 388 return PathDiagnosticLocation(S, SMgr, LC); 389 break; 390 } 391 case Stmt::CompoundStmtClass: 392 case Stmt::StmtExprClass: 393 return PathDiagnosticLocation(S, SMgr, LC); 394 case Stmt::ChooseExprClass: 395 // Similar to '?' if we are referring to condition, just have the edge 396 // point to the entire choose expression. 397 if (cast<ChooseExpr>(Parent)->getCond() == S) 398 return PathDiagnosticLocation(Parent, SMgr, LC); 399 else 400 return PathDiagnosticLocation(S, SMgr, LC); 401 case Stmt::BinaryConditionalOperatorClass: 402 case Stmt::ConditionalOperatorClass: 403 // For '?', if we are referring to condition, just have the edge point 404 // to the entire '?' expression. 405 if (cast<AbstractConditionalOperator>(Parent)->getCond() == S) 406 return PathDiagnosticLocation(Parent, SMgr, LC); 407 else 408 return PathDiagnosticLocation(S, SMgr, LC); 409 case Stmt::DoStmtClass: 410 return PathDiagnosticLocation(S, SMgr, LC); 411 case Stmt::ForStmtClass: 412 if (cast<ForStmt>(Parent)->getBody() == S) 413 return PathDiagnosticLocation(S, SMgr, LC); 414 break; 415 case Stmt::IfStmtClass: 416 if (cast<IfStmt>(Parent)->getCond() != S) 417 return PathDiagnosticLocation(S, SMgr, LC); 418 break; 419 case Stmt::ObjCForCollectionStmtClass: 420 if (cast<ObjCForCollectionStmt>(Parent)->getBody() == S) 421 return PathDiagnosticLocation(S, SMgr, LC); 422 break; 423 case Stmt::WhileStmtClass: 424 if (cast<WhileStmt>(Parent)->getCond() != S) 425 return PathDiagnosticLocation(S, SMgr, LC); 426 break; 427 default: 428 break; 429 } 430 431 S = Parent; 432 } 433 434 assert(S && "Cannot have null Stmt for PathDiagnosticLocation"); 435 436 // Special case: DeclStmts can appear in for statement declarations, in which 437 // case the ForStmt is the context. 438 if (isa<DeclStmt>(S)) { 439 if (const Stmt *Parent = P.getParent(S)) { 440 switch (Parent->getStmtClass()) { 441 case Stmt::ForStmtClass: 442 case Stmt::ObjCForCollectionStmtClass: 443 return PathDiagnosticLocation(Parent, SMgr, LC); 444 default: 445 break; 446 } 447 } 448 } 449 else if (isa<BinaryOperator>(S)) { 450 // Special case: the binary operator represents the initialization 451 // code in a for statement (this can happen when the variable being 452 // initialized is an old variable. 453 if (const ForStmt *FS = 454 dyn_cast_or_null<ForStmt>(P.getParentIgnoreParens(S))) { 455 if (FS->getInit() == S) 456 return PathDiagnosticLocation(FS, SMgr, LC); 457 } 458 } 459 460 return PathDiagnosticLocation(S, SMgr, LC); 461} 462 463//===----------------------------------------------------------------------===// 464// "Visitors only" path diagnostic generation algorithm. 465//===----------------------------------------------------------------------===// 466static bool GenerateVisitorsOnlyPathDiagnostic(PathDiagnostic &PD, 467 PathDiagnosticBuilder &PDB, 468 const ExplodedNode *N, 469 ArrayRef<BugReporterVisitor *> visitors) { 470 // All path generation skips the very first node (the error node). 471 // This is because there is special handling for the end-of-path note. 472 N = N->getFirstPred(); 473 if (!N) 474 return true; 475 476 BugReport *R = PDB.getBugReport(); 477 while (const ExplodedNode *Pred = N->getFirstPred()) { 478 for (ArrayRef<BugReporterVisitor *>::iterator I = visitors.begin(), 479 E = visitors.end(); 480 I != E; ++I) { 481 // Visit all the node pairs, but throw the path pieces away. 482 PathDiagnosticPiece *Piece = (*I)->VisitNode(N, Pred, PDB, *R); 483 delete Piece; 484 } 485 486 N = Pred; 487 } 488 489 return R->isValid(); 490} 491 492//===----------------------------------------------------------------------===// 493// "Minimal" path diagnostic generation algorithm. 494//===----------------------------------------------------------------------===// 495typedef std::pair<PathDiagnosticCallPiece*, const ExplodedNode*> StackDiagPair; 496typedef SmallVector<StackDiagPair, 6> StackDiagVector; 497 498static void updateStackPiecesWithMessage(PathDiagnosticPiece *P, 499 StackDiagVector &CallStack) { 500 // If the piece contains a special message, add it to all the call 501 // pieces on the active stack. 502 if (PathDiagnosticEventPiece *ep = 503 dyn_cast<PathDiagnosticEventPiece>(P)) { 504 505 if (ep->hasCallStackHint()) 506 for (StackDiagVector::iterator I = CallStack.begin(), 507 E = CallStack.end(); I != E; ++I) { 508 PathDiagnosticCallPiece *CP = I->first; 509 const ExplodedNode *N = I->second; 510 std::string stackMsg = ep->getCallStackMessage(N); 511 512 // The last message on the path to final bug is the most important 513 // one. Since we traverse the path backwards, do not add the message 514 // if one has been previously added. 515 if (!CP->hasCallStackMessage()) 516 CP->setCallStackMessage(stackMsg); 517 } 518 } 519} 520 521static void CompactPathDiagnostic(PathPieces &path, const SourceManager& SM); 522 523static bool GenerateMinimalPathDiagnostic(PathDiagnostic& PD, 524 PathDiagnosticBuilder &PDB, 525 const ExplodedNode *N, 526 LocationContextMap &LCM, 527 ArrayRef<BugReporterVisitor *> visitors) { 528 529 SourceManager& SMgr = PDB.getSourceManager(); 530 const LocationContext *LC = PDB.LC; 531 const ExplodedNode *NextNode = N->pred_empty() 532 ? NULL : *(N->pred_begin()); 533 534 StackDiagVector CallStack; 535 536 while (NextNode) { 537 N = NextNode; 538 PDB.LC = N->getLocationContext(); 539 NextNode = N->getFirstPred(); 540 541 ProgramPoint P = N->getLocation(); 542 543 do { 544 if (Optional<CallExitEnd> CE = P.getAs<CallExitEnd>()) { 545 PathDiagnosticCallPiece *C = 546 PathDiagnosticCallPiece::construct(N, *CE, SMgr); 547 // Record the mapping from call piece to LocationContext. 548 LCM[&C->path] = CE->getCalleeContext(); 549 PD.getActivePath().push_front(C); 550 PD.pushActivePath(&C->path); 551 CallStack.push_back(StackDiagPair(C, N)); 552 break; 553 } 554 555 if (Optional<CallEnter> CE = P.getAs<CallEnter>()) { 556 // Flush all locations, and pop the active path. 557 bool VisitedEntireCall = PD.isWithinCall(); 558 PD.popActivePath(); 559 560 // Either we just added a bunch of stuff to the top-level path, or 561 // we have a previous CallExitEnd. If the former, it means that the 562 // path terminated within a function call. We must then take the 563 // current contents of the active path and place it within 564 // a new PathDiagnosticCallPiece. 565 PathDiagnosticCallPiece *C; 566 if (VisitedEntireCall) { 567 C = cast<PathDiagnosticCallPiece>(PD.getActivePath().front()); 568 } else { 569 const Decl *Caller = CE->getLocationContext()->getDecl(); 570 C = PathDiagnosticCallPiece::construct(PD.getActivePath(), Caller); 571 // Record the mapping from call piece to LocationContext. 572 LCM[&C->path] = CE->getCalleeContext(); 573 } 574 575 C->setCallee(*CE, SMgr); 576 if (!CallStack.empty()) { 577 assert(CallStack.back().first == C); 578 CallStack.pop_back(); 579 } 580 break; 581 } 582 583 if (Optional<BlockEdge> BE = P.getAs<BlockEdge>()) { 584 const CFGBlock *Src = BE->getSrc(); 585 const CFGBlock *Dst = BE->getDst(); 586 const Stmt *T = Src->getTerminator(); 587 588 if (!T) 589 break; 590 591 PathDiagnosticLocation Start = 592 PathDiagnosticLocation::createBegin(T, SMgr, 593 N->getLocationContext()); 594 595 switch (T->getStmtClass()) { 596 default: 597 break; 598 599 case Stmt::GotoStmtClass: 600 case Stmt::IndirectGotoStmtClass: { 601 const Stmt *S = PathDiagnosticLocation::getNextStmt(N); 602 603 if (!S) 604 break; 605 606 std::string sbuf; 607 llvm::raw_string_ostream os(sbuf); 608 const PathDiagnosticLocation &End = PDB.getEnclosingStmtLocation(S); 609 610 os << "Control jumps to line " 611 << End.asLocation().getExpansionLineNumber(); 612 PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 613 Start, End, os.str())); 614 break; 615 } 616 617 case Stmt::SwitchStmtClass: { 618 // Figure out what case arm we took. 619 std::string sbuf; 620 llvm::raw_string_ostream os(sbuf); 621 622 if (const Stmt *S = Dst->getLabel()) { 623 PathDiagnosticLocation End(S, SMgr, LC); 624 625 switch (S->getStmtClass()) { 626 default: 627 os << "No cases match in the switch statement. " 628 "Control jumps to line " 629 << End.asLocation().getExpansionLineNumber(); 630 break; 631 case Stmt::DefaultStmtClass: 632 os << "Control jumps to the 'default' case at line " 633 << End.asLocation().getExpansionLineNumber(); 634 break; 635 636 case Stmt::CaseStmtClass: { 637 os << "Control jumps to 'case "; 638 const CaseStmt *Case = cast<CaseStmt>(S); 639 const Expr *LHS = Case->getLHS()->IgnoreParenCasts(); 640 641 // Determine if it is an enum. 642 bool GetRawInt = true; 643 644 if (const DeclRefExpr *DR = dyn_cast<DeclRefExpr>(LHS)) { 645 // FIXME: Maybe this should be an assertion. Are there cases 646 // were it is not an EnumConstantDecl? 647 const EnumConstantDecl *D = 648 dyn_cast<EnumConstantDecl>(DR->getDecl()); 649 650 if (D) { 651 GetRawInt = false; 652 os << *D; 653 } 654 } 655 656 if (GetRawInt) 657 os << LHS->EvaluateKnownConstInt(PDB.getASTContext()); 658 659 os << ":' at line " 660 << End.asLocation().getExpansionLineNumber(); 661 break; 662 } 663 } 664 PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 665 Start, End, os.str())); 666 } 667 else { 668 os << "'Default' branch taken. "; 669 const PathDiagnosticLocation &End = PDB.ExecutionContinues(os, N); 670 PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 671 Start, End, os.str())); 672 } 673 674 break; 675 } 676 677 case Stmt::BreakStmtClass: 678 case Stmt::ContinueStmtClass: { 679 std::string sbuf; 680 llvm::raw_string_ostream os(sbuf); 681 PathDiagnosticLocation End = PDB.ExecutionContinues(os, N); 682 PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 683 Start, End, os.str())); 684 break; 685 } 686 687 // Determine control-flow for ternary '?'. 688 case Stmt::BinaryConditionalOperatorClass: 689 case Stmt::ConditionalOperatorClass: { 690 std::string sbuf; 691 llvm::raw_string_ostream os(sbuf); 692 os << "'?' condition is "; 693 694 if (*(Src->succ_begin()+1) == Dst) 695 os << "false"; 696 else 697 os << "true"; 698 699 PathDiagnosticLocation End = PDB.ExecutionContinues(N); 700 701 if (const Stmt *S = End.asStmt()) 702 End = PDB.getEnclosingStmtLocation(S); 703 704 PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 705 Start, End, os.str())); 706 break; 707 } 708 709 // Determine control-flow for short-circuited '&&' and '||'. 710 case Stmt::BinaryOperatorClass: { 711 if (!PDB.supportsLogicalOpControlFlow()) 712 break; 713 714 const BinaryOperator *B = cast<BinaryOperator>(T); 715 std::string sbuf; 716 llvm::raw_string_ostream os(sbuf); 717 os << "Left side of '"; 718 719 if (B->getOpcode() == BO_LAnd) { 720 os << "&&" << "' is "; 721 722 if (*(Src->succ_begin()+1) == Dst) { 723 os << "false"; 724 PathDiagnosticLocation End(B->getLHS(), SMgr, LC); 725 PathDiagnosticLocation Start = 726 PathDiagnosticLocation::createOperatorLoc(B, SMgr); 727 PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 728 Start, End, os.str())); 729 } 730 else { 731 os << "true"; 732 PathDiagnosticLocation Start(B->getLHS(), SMgr, LC); 733 PathDiagnosticLocation End = PDB.ExecutionContinues(N); 734 PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 735 Start, End, os.str())); 736 } 737 } 738 else { 739 assert(B->getOpcode() == BO_LOr); 740 os << "||" << "' is "; 741 742 if (*(Src->succ_begin()+1) == Dst) { 743 os << "false"; 744 PathDiagnosticLocation Start(B->getLHS(), SMgr, LC); 745 PathDiagnosticLocation End = PDB.ExecutionContinues(N); 746 PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 747 Start, End, os.str())); 748 } 749 else { 750 os << "true"; 751 PathDiagnosticLocation End(B->getLHS(), SMgr, LC); 752 PathDiagnosticLocation Start = 753 PathDiagnosticLocation::createOperatorLoc(B, SMgr); 754 PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 755 Start, End, os.str())); 756 } 757 } 758 759 break; 760 } 761 762 case Stmt::DoStmtClass: { 763 if (*(Src->succ_begin()) == Dst) { 764 std::string sbuf; 765 llvm::raw_string_ostream os(sbuf); 766 767 os << "Loop condition is true. "; 768 PathDiagnosticLocation End = PDB.ExecutionContinues(os, N); 769 770 if (const Stmt *S = End.asStmt()) 771 End = PDB.getEnclosingStmtLocation(S); 772 773 PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 774 Start, End, os.str())); 775 } 776 else { 777 PathDiagnosticLocation End = PDB.ExecutionContinues(N); 778 779 if (const Stmt *S = End.asStmt()) 780 End = PDB.getEnclosingStmtLocation(S); 781 782 PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 783 Start, End, "Loop condition is false. Exiting loop")); 784 } 785 786 break; 787 } 788 789 case Stmt::WhileStmtClass: 790 case Stmt::ForStmtClass: { 791 if (*(Src->succ_begin()+1) == Dst) { 792 std::string sbuf; 793 llvm::raw_string_ostream os(sbuf); 794 795 os << "Loop condition is false. "; 796 PathDiagnosticLocation End = PDB.ExecutionContinues(os, N); 797 if (const Stmt *S = End.asStmt()) 798 End = PDB.getEnclosingStmtLocation(S); 799 800 PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 801 Start, End, os.str())); 802 } 803 else { 804 PathDiagnosticLocation End = PDB.ExecutionContinues(N); 805 if (const Stmt *S = End.asStmt()) 806 End = PDB.getEnclosingStmtLocation(S); 807 808 PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 809 Start, End, "Loop condition is true. Entering loop body")); 810 } 811 812 break; 813 } 814 815 case Stmt::IfStmtClass: { 816 PathDiagnosticLocation End = PDB.ExecutionContinues(N); 817 818 if (const Stmt *S = End.asStmt()) 819 End = PDB.getEnclosingStmtLocation(S); 820 821 if (*(Src->succ_begin()+1) == Dst) 822 PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 823 Start, End, "Taking false branch")); 824 else 825 PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece( 826 Start, End, "Taking true branch")); 827 828 break; 829 } 830 } 831 } 832 } while(0); 833 834 if (NextNode) { 835 // Add diagnostic pieces from custom visitors. 836 BugReport *R = PDB.getBugReport(); 837 for (ArrayRef<BugReporterVisitor *>::iterator I = visitors.begin(), 838 E = visitors.end(); 839 I != E; ++I) { 840 if (PathDiagnosticPiece *p = (*I)->VisitNode(N, NextNode, PDB, *R)) { 841 PD.getActivePath().push_front(p); 842 updateStackPiecesWithMessage(p, CallStack); 843 } 844 } 845 } 846 } 847 848 if (!PDB.getBugReport()->isValid()) 849 return false; 850 851 // After constructing the full PathDiagnostic, do a pass over it to compact 852 // PathDiagnosticPieces that occur within a macro. 853 CompactPathDiagnostic(PD.getMutablePieces(), PDB.getSourceManager()); 854 return true; 855} 856 857//===----------------------------------------------------------------------===// 858// "Extensive" PathDiagnostic generation. 859//===----------------------------------------------------------------------===// 860 861static bool IsControlFlowExpr(const Stmt *S) { 862 const Expr *E = dyn_cast<Expr>(S); 863 864 if (!E) 865 return false; 866 867 E = E->IgnoreParenCasts(); 868 869 if (isa<AbstractConditionalOperator>(E)) 870 return true; 871 872 if (const BinaryOperator *B = dyn_cast<BinaryOperator>(E)) 873 if (B->isLogicalOp()) 874 return true; 875 876 return false; 877} 878 879namespace { 880class ContextLocation : public PathDiagnosticLocation { 881 bool IsDead; 882public: 883 ContextLocation(const PathDiagnosticLocation &L, bool isdead = false) 884 : PathDiagnosticLocation(L), IsDead(isdead) {} 885 886 void markDead() { IsDead = true; } 887 bool isDead() const { return IsDead; } 888}; 889 890static PathDiagnosticLocation cleanUpLocation(PathDiagnosticLocation L, 891 const LocationContext *LC, 892 bool firstCharOnly = false) { 893 if (const Stmt *S = L.asStmt()) { 894 const Stmt *Original = S; 895 while (1) { 896 // Adjust the location for some expressions that are best referenced 897 // by one of their subexpressions. 898 switch (S->getStmtClass()) { 899 default: 900 break; 901 case Stmt::ParenExprClass: 902 case Stmt::GenericSelectionExprClass: 903 S = cast<Expr>(S)->IgnoreParens(); 904 firstCharOnly = true; 905 continue; 906 case Stmt::BinaryConditionalOperatorClass: 907 case Stmt::ConditionalOperatorClass: 908 S = cast<AbstractConditionalOperator>(S)->getCond(); 909 firstCharOnly = true; 910 continue; 911 case Stmt::ChooseExprClass: 912 S = cast<ChooseExpr>(S)->getCond(); 913 firstCharOnly = true; 914 continue; 915 case Stmt::BinaryOperatorClass: 916 S = cast<BinaryOperator>(S)->getLHS(); 917 firstCharOnly = true; 918 continue; 919 } 920 921 break; 922 } 923 924 if (S != Original) 925 L = PathDiagnosticLocation(S, L.getManager(), LC); 926 } 927 928 if (firstCharOnly) 929 L = PathDiagnosticLocation::createSingleLocation(L); 930 931 return L; 932} 933 934class EdgeBuilder { 935 std::vector<ContextLocation> CLocs; 936 typedef std::vector<ContextLocation>::iterator iterator; 937 PathDiagnostic &PD; 938 PathDiagnosticBuilder &PDB; 939 PathDiagnosticLocation PrevLoc; 940 941 bool IsConsumedExpr(const PathDiagnosticLocation &L); 942 943 bool containsLocation(const PathDiagnosticLocation &Container, 944 const PathDiagnosticLocation &Containee); 945 946 PathDiagnosticLocation getContextLocation(const PathDiagnosticLocation &L); 947 948 949 950 void popLocation() { 951 if (!CLocs.back().isDead() && CLocs.back().asLocation().isFileID()) { 952 // For contexts, we only one the first character as the range. 953 rawAddEdge(cleanUpLocation(CLocs.back(), PDB.LC, true)); 954 } 955 CLocs.pop_back(); 956 } 957 958public: 959 EdgeBuilder(PathDiagnostic &pd, PathDiagnosticBuilder &pdb) 960 : PD(pd), PDB(pdb) { 961 962 // If the PathDiagnostic already has pieces, add the enclosing statement 963 // of the first piece as a context as well. 964 if (!PD.path.empty()) { 965 PrevLoc = (*PD.path.begin())->getLocation(); 966 967 if (const Stmt *S = PrevLoc.asStmt()) 968 addExtendedContext(PDB.getEnclosingStmtLocation(S).asStmt()); 969 } 970 } 971 972 ~EdgeBuilder() { 973 while (!CLocs.empty()) popLocation(); 974 975 // Finally, add an initial edge from the start location of the first 976 // statement (if it doesn't already exist). 977 PathDiagnosticLocation L = PathDiagnosticLocation::createDeclBegin( 978 PDB.LC, 979 PDB.getSourceManager()); 980 if (L.isValid()) 981 rawAddEdge(L); 982 } 983 984 void flushLocations() { 985 while (!CLocs.empty()) 986 popLocation(); 987 PrevLoc = PathDiagnosticLocation(); 988 } 989 990 void addEdge(PathDiagnosticLocation NewLoc, bool alwaysAdd = false, 991 bool IsPostJump = false); 992 993 void rawAddEdge(PathDiagnosticLocation NewLoc); 994 995 void addContext(const Stmt *S); 996 void addContext(const PathDiagnosticLocation &L); 997 void addExtendedContext(const Stmt *S); 998}; 999} // end anonymous namespace 1000 1001 1002PathDiagnosticLocation 1003EdgeBuilder::getContextLocation(const PathDiagnosticLocation &L) { 1004 if (const Stmt *S = L.asStmt()) { 1005 if (IsControlFlowExpr(S)) 1006 return L; 1007 1008 return PDB.getEnclosingStmtLocation(S); 1009 } 1010 1011 return L; 1012} 1013 1014bool EdgeBuilder::containsLocation(const PathDiagnosticLocation &Container, 1015 const PathDiagnosticLocation &Containee) { 1016 1017 if (Container == Containee) 1018 return true; 1019 1020 if (Container.asDecl()) 1021 return true; 1022 1023 if (const Stmt *S = Containee.asStmt()) 1024 if (const Stmt *ContainerS = Container.asStmt()) { 1025 while (S) { 1026 if (S == ContainerS) 1027 return true; 1028 S = PDB.getParent(S); 1029 } 1030 return false; 1031 } 1032 1033 // Less accurate: compare using source ranges. 1034 SourceRange ContainerR = Container.asRange(); 1035 SourceRange ContaineeR = Containee.asRange(); 1036 1037 SourceManager &SM = PDB.getSourceManager(); 1038 SourceLocation ContainerRBeg = SM.getExpansionLoc(ContainerR.getBegin()); 1039 SourceLocation ContainerREnd = SM.getExpansionLoc(ContainerR.getEnd()); 1040 SourceLocation ContaineeRBeg = SM.getExpansionLoc(ContaineeR.getBegin()); 1041 SourceLocation ContaineeREnd = SM.getExpansionLoc(ContaineeR.getEnd()); 1042 1043 unsigned ContainerBegLine = SM.getExpansionLineNumber(ContainerRBeg); 1044 unsigned ContainerEndLine = SM.getExpansionLineNumber(ContainerREnd); 1045 unsigned ContaineeBegLine = SM.getExpansionLineNumber(ContaineeRBeg); 1046 unsigned ContaineeEndLine = SM.getExpansionLineNumber(ContaineeREnd); 1047 1048 assert(ContainerBegLine <= ContainerEndLine); 1049 assert(ContaineeBegLine <= ContaineeEndLine); 1050 1051 return (ContainerBegLine <= ContaineeBegLine && 1052 ContainerEndLine >= ContaineeEndLine && 1053 (ContainerBegLine != ContaineeBegLine || 1054 SM.getExpansionColumnNumber(ContainerRBeg) <= 1055 SM.getExpansionColumnNumber(ContaineeRBeg)) && 1056 (ContainerEndLine != ContaineeEndLine || 1057 SM.getExpansionColumnNumber(ContainerREnd) >= 1058 SM.getExpansionColumnNumber(ContaineeREnd))); 1059} 1060 1061void EdgeBuilder::rawAddEdge(PathDiagnosticLocation NewLoc) { 1062 if (!PrevLoc.isValid()) { 1063 PrevLoc = NewLoc; 1064 return; 1065 } 1066 1067 const PathDiagnosticLocation &NewLocClean = cleanUpLocation(NewLoc, PDB.LC); 1068 const PathDiagnosticLocation &PrevLocClean = cleanUpLocation(PrevLoc, PDB.LC); 1069 1070 if (PrevLocClean.asLocation().isInvalid()) { 1071 PrevLoc = NewLoc; 1072 return; 1073 } 1074 1075 if (NewLocClean.asLocation() == PrevLocClean.asLocation()) 1076 return; 1077 1078 // FIXME: Ignore intra-macro edges for now. 1079 if (NewLocClean.asLocation().getExpansionLoc() == 1080 PrevLocClean.asLocation().getExpansionLoc()) 1081 return; 1082 1083 PD.getActivePath().push_front(new PathDiagnosticControlFlowPiece(NewLocClean, PrevLocClean)); 1084 PrevLoc = NewLoc; 1085} 1086 1087void EdgeBuilder::addEdge(PathDiagnosticLocation NewLoc, bool alwaysAdd, 1088 bool IsPostJump) { 1089 1090 if (!alwaysAdd && NewLoc.asLocation().isMacroID()) 1091 return; 1092 1093 const PathDiagnosticLocation &CLoc = getContextLocation(NewLoc); 1094 1095 while (!CLocs.empty()) { 1096 ContextLocation &TopContextLoc = CLocs.back(); 1097 1098 // Is the top location context the same as the one for the new location? 1099 if (TopContextLoc == CLoc) { 1100 if (alwaysAdd) { 1101 if (IsConsumedExpr(TopContextLoc)) 1102 TopContextLoc.markDead(); 1103 1104 rawAddEdge(NewLoc); 1105 } 1106 1107 if (IsPostJump) 1108 TopContextLoc.markDead(); 1109 return; 1110 } 1111 1112 if (containsLocation(TopContextLoc, CLoc)) { 1113 if (alwaysAdd) { 1114 rawAddEdge(NewLoc); 1115 1116 if (IsConsumedExpr(CLoc)) { 1117 CLocs.push_back(ContextLocation(CLoc, /*IsDead=*/true)); 1118 return; 1119 } 1120 } 1121 1122 CLocs.push_back(ContextLocation(CLoc, /*IsDead=*/IsPostJump)); 1123 return; 1124 } 1125 1126 // Context does not contain the location. Flush it. 1127 popLocation(); 1128 } 1129 1130 // If we reach here, there is no enclosing context. Just add the edge. 1131 rawAddEdge(NewLoc); 1132} 1133 1134bool EdgeBuilder::IsConsumedExpr(const PathDiagnosticLocation &L) { 1135 if (const Expr *X = dyn_cast_or_null<Expr>(L.asStmt())) 1136 return PDB.getParentMap().isConsumedExpr(X) && !IsControlFlowExpr(X); 1137 1138 return false; 1139} 1140 1141void EdgeBuilder::addExtendedContext(const Stmt *S) { 1142 if (!S) 1143 return; 1144 1145 const Stmt *Parent = PDB.getParent(S); 1146 while (Parent) { 1147 if (isa<CompoundStmt>(Parent)) 1148 Parent = PDB.getParent(Parent); 1149 else 1150 break; 1151 } 1152 1153 if (Parent) { 1154 switch (Parent->getStmtClass()) { 1155 case Stmt::DoStmtClass: 1156 case Stmt::ObjCAtSynchronizedStmtClass: 1157 addContext(Parent); 1158 default: 1159 break; 1160 } 1161 } 1162 1163 addContext(S); 1164} 1165 1166void EdgeBuilder::addContext(const Stmt *S) { 1167 if (!S) 1168 return; 1169 1170 PathDiagnosticLocation L(S, PDB.getSourceManager(), PDB.LC); 1171 addContext(L); 1172} 1173 1174void EdgeBuilder::addContext(const PathDiagnosticLocation &L) { 1175 while (!CLocs.empty()) { 1176 const PathDiagnosticLocation &TopContextLoc = CLocs.back(); 1177 1178 // Is the top location context the same as the one for the new location? 1179 if (TopContextLoc == L) 1180 return; 1181 1182 if (containsLocation(TopContextLoc, L)) { 1183 CLocs.push_back(L); 1184 return; 1185 } 1186 1187 // Context does not contain the location. Flush it. 1188 popLocation(); 1189 } 1190 1191 CLocs.push_back(L); 1192} 1193 1194// Cone-of-influence: support the reverse propagation of "interesting" symbols 1195// and values by tracing interesting calculations backwards through evaluated 1196// expressions along a path. This is probably overly complicated, but the idea 1197// is that if an expression computed an "interesting" value, the child 1198// expressions are are also likely to be "interesting" as well (which then 1199// propagates to the values they in turn compute). This reverse propagation 1200// is needed to track interesting correlations across function call boundaries, 1201// where formal arguments bind to actual arguments, etc. This is also needed 1202// because the constraint solver sometimes simplifies certain symbolic values 1203// into constants when appropriate, and this complicates reasoning about 1204// interesting values. 1205typedef llvm::DenseSet<const Expr *> InterestingExprs; 1206 1207static void reversePropagateIntererstingSymbols(BugReport &R, 1208 InterestingExprs &IE, 1209 const ProgramState *State, 1210 const Expr *Ex, 1211 const LocationContext *LCtx) { 1212 SVal V = State->getSVal(Ex, LCtx); 1213 if (!(R.isInteresting(V) || IE.count(Ex))) 1214 return; 1215 1216 switch (Ex->getStmtClass()) { 1217 default: 1218 if (!isa<CastExpr>(Ex)) 1219 break; 1220 // Fall through. 1221 case Stmt::BinaryOperatorClass: 1222 case Stmt::UnaryOperatorClass: { 1223 for (Stmt::const_child_iterator CI = Ex->child_begin(), 1224 CE = Ex->child_end(); 1225 CI != CE; ++CI) { 1226 if (const Expr *child = dyn_cast_or_null<Expr>(*CI)) { 1227 IE.insert(child); 1228 SVal ChildV = State->getSVal(child, LCtx); 1229 R.markInteresting(ChildV); 1230 } 1231 break; 1232 } 1233 } 1234 } 1235 1236 R.markInteresting(V); 1237} 1238 1239static void reversePropagateInterestingSymbols(BugReport &R, 1240 InterestingExprs &IE, 1241 const ProgramState *State, 1242 const LocationContext *CalleeCtx, 1243 const LocationContext *CallerCtx) 1244{ 1245 // FIXME: Handle non-CallExpr-based CallEvents. 1246 const StackFrameContext *Callee = CalleeCtx->getCurrentStackFrame(); 1247 const Stmt *CallSite = Callee->getCallSite(); 1248 if (const CallExpr *CE = dyn_cast_or_null<CallExpr>(CallSite)) { 1249 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(CalleeCtx->getDecl())) { 1250 FunctionDecl::param_const_iterator PI = FD->param_begin(), 1251 PE = FD->param_end(); 1252 CallExpr::const_arg_iterator AI = CE->arg_begin(), AE = CE->arg_end(); 1253 for (; AI != AE && PI != PE; ++AI, ++PI) { 1254 if (const Expr *ArgE = *AI) { 1255 if (const ParmVarDecl *PD = *PI) { 1256 Loc LV = State->getLValue(PD, CalleeCtx); 1257 if (R.isInteresting(LV) || R.isInteresting(State->getRawSVal(LV))) 1258 IE.insert(ArgE); 1259 } 1260 } 1261 } 1262 } 1263 } 1264} 1265 1266//===----------------------------------------------------------------------===// 1267// Functions for determining if a loop was executed 0 times. 1268//===----------------------------------------------------------------------===// 1269 1270static bool isLoop(const Stmt *Term) { 1271 switch (Term->getStmtClass()) { 1272 case Stmt::ForStmtClass: 1273 case Stmt::WhileStmtClass: 1274 case Stmt::ObjCForCollectionStmtClass: 1275 return true; 1276 default: 1277 // Note that we intentionally do not include do..while here. 1278 return false; 1279 } 1280} 1281 1282static bool isJumpToFalseBranch(const BlockEdge *BE) { 1283 const CFGBlock *Src = BE->getSrc(); 1284 assert(Src->succ_size() == 2); 1285 return (*(Src->succ_begin()+1) == BE->getDst()); 1286} 1287 1288/// Return true if the terminator is a loop and the destination is the 1289/// false branch. 1290static bool isLoopJumpPastBody(const Stmt *Term, const BlockEdge *BE) { 1291 if (!isLoop(Term)) 1292 return false; 1293 1294 // Did we take the false branch? 1295 return isJumpToFalseBranch(BE); 1296} 1297 1298static bool isContainedByStmt(ParentMap &PM, const Stmt *S, const Stmt *SubS) { 1299 while (SubS) { 1300 if (SubS == S) 1301 return true; 1302 SubS = PM.getParent(SubS); 1303 } 1304 return false; 1305} 1306 1307static const Stmt *getStmtBeforeCond(ParentMap &PM, const Stmt *Term, 1308 const ExplodedNode *N) { 1309 while (N) { 1310 Optional<StmtPoint> SP = N->getLocation().getAs<StmtPoint>(); 1311 if (SP) { 1312 const Stmt *S = SP->getStmt(); 1313 if (!isContainedByStmt(PM, Term, S)) 1314 return S; 1315 } 1316 N = N->getFirstPred(); 1317 } 1318 return 0; 1319} 1320 1321static bool isInLoopBody(ParentMap &PM, const Stmt *S, const Stmt *Term) { 1322 const Stmt *LoopBody = 0; 1323 switch (Term->getStmtClass()) { 1324 case Stmt::ForStmtClass: { 1325 const ForStmt *FS = cast<ForStmt>(Term); 1326 if (isContainedByStmt(PM, FS->getInc(), S)) 1327 return true; 1328 LoopBody = FS->getBody(); 1329 break; 1330 } 1331 case Stmt::ObjCForCollectionStmtClass: { 1332 const ObjCForCollectionStmt *FC = cast<ObjCForCollectionStmt>(Term); 1333 LoopBody = FC->getBody(); 1334 break; 1335 } 1336 case Stmt::WhileStmtClass: 1337 LoopBody = cast<WhileStmt>(Term)->getBody(); 1338 break; 1339 default: 1340 return false; 1341 } 1342 return isContainedByStmt(PM, LoopBody, S); 1343} 1344 1345//===----------------------------------------------------------------------===// 1346// Top-level logic for generating extensive path diagnostics. 1347//===----------------------------------------------------------------------===// 1348 1349static bool GenerateExtensivePathDiagnostic(PathDiagnostic& PD, 1350 PathDiagnosticBuilder &PDB, 1351 const ExplodedNode *N, 1352 LocationContextMap &LCM, 1353 ArrayRef<BugReporterVisitor *> visitors) { 1354 EdgeBuilder EB(PD, PDB); 1355 const SourceManager& SM = PDB.getSourceManager(); 1356 StackDiagVector CallStack; 1357 InterestingExprs IE; 1358 1359 const ExplodedNode *NextNode = N->pred_empty() ? NULL : *(N->pred_begin()); 1360 while (NextNode) { 1361 N = NextNode; 1362 NextNode = N->getFirstPred(); 1363 ProgramPoint P = N->getLocation(); 1364 1365 do { 1366 if (Optional<PostStmt> PS = P.getAs<PostStmt>()) { 1367 if (const Expr *Ex = PS->getStmtAs<Expr>()) 1368 reversePropagateIntererstingSymbols(*PDB.getBugReport(), IE, 1369 N->getState().getPtr(), Ex, 1370 N->getLocationContext()); 1371 } 1372 1373 if (Optional<CallExitEnd> CE = P.getAs<CallExitEnd>()) { 1374 const Stmt *S = CE->getCalleeContext()->getCallSite(); 1375 if (const Expr *Ex = dyn_cast_or_null<Expr>(S)) { 1376 reversePropagateIntererstingSymbols(*PDB.getBugReport(), IE, 1377 N->getState().getPtr(), Ex, 1378 N->getLocationContext()); 1379 } 1380 1381 PathDiagnosticCallPiece *C = 1382 PathDiagnosticCallPiece::construct(N, *CE, SM); 1383 LCM[&C->path] = CE->getCalleeContext(); 1384 1385 EB.addEdge(C->callReturn, /*AlwaysAdd=*/true, /*IsPostJump=*/true); 1386 EB.flushLocations(); 1387 1388 PD.getActivePath().push_front(C); 1389 PD.pushActivePath(&C->path); 1390 CallStack.push_back(StackDiagPair(C, N)); 1391 break; 1392 } 1393 1394 // Pop the call hierarchy if we are done walking the contents 1395 // of a function call. 1396 if (Optional<CallEnter> CE = P.getAs<CallEnter>()) { 1397 // Add an edge to the start of the function. 1398 const Decl *D = CE->getCalleeContext()->getDecl(); 1399 PathDiagnosticLocation pos = 1400 PathDiagnosticLocation::createBegin(D, SM); 1401 EB.addEdge(pos); 1402 1403 // Flush all locations, and pop the active path. 1404 bool VisitedEntireCall = PD.isWithinCall(); 1405 EB.flushLocations(); 1406 PD.popActivePath(); 1407 PDB.LC = N->getLocationContext(); 1408 1409 // Either we just added a bunch of stuff to the top-level path, or 1410 // we have a previous CallExitEnd. If the former, it means that the 1411 // path terminated within a function call. We must then take the 1412 // current contents of the active path and place it within 1413 // a new PathDiagnosticCallPiece. 1414 PathDiagnosticCallPiece *C; 1415 if (VisitedEntireCall) { 1416 C = cast<PathDiagnosticCallPiece>(PD.getActivePath().front()); 1417 } else { 1418 const Decl *Caller = CE->getLocationContext()->getDecl(); 1419 C = PathDiagnosticCallPiece::construct(PD.getActivePath(), Caller); 1420 LCM[&C->path] = CE->getCalleeContext(); 1421 } 1422 1423 C->setCallee(*CE, SM); 1424 EB.addContext(C->getLocation()); 1425 1426 if (!CallStack.empty()) { 1427 assert(CallStack.back().first == C); 1428 CallStack.pop_back(); 1429 } 1430 break; 1431 } 1432 1433 // Note that is important that we update the LocationContext 1434 // after looking at CallExits. CallExit basically adds an 1435 // edge in the *caller*, so we don't want to update the LocationContext 1436 // too soon. 1437 PDB.LC = N->getLocationContext(); 1438 1439 // Block edges. 1440 if (Optional<BlockEdge> BE = P.getAs<BlockEdge>()) { 1441 // Does this represent entering a call? If so, look at propagating 1442 // interesting symbols across call boundaries. 1443 if (NextNode) { 1444 const LocationContext *CallerCtx = NextNode->getLocationContext(); 1445 const LocationContext *CalleeCtx = PDB.LC; 1446 if (CallerCtx != CalleeCtx) { 1447 reversePropagateInterestingSymbols(*PDB.getBugReport(), IE, 1448 N->getState().getPtr(), 1449 CalleeCtx, CallerCtx); 1450 } 1451 } 1452 1453 // Are we jumping to the head of a loop? Add a special diagnostic. 1454 if (const Stmt *Loop = BE->getSrc()->getLoopTarget()) { 1455 PathDiagnosticLocation L(Loop, SM, PDB.LC); 1456 const CompoundStmt *CS = NULL; 1457 1458 if (const ForStmt *FS = dyn_cast<ForStmt>(Loop)) 1459 CS = dyn_cast<CompoundStmt>(FS->getBody()); 1460 else if (const WhileStmt *WS = dyn_cast<WhileStmt>(Loop)) 1461 CS = dyn_cast<CompoundStmt>(WS->getBody()); 1462 1463 PathDiagnosticEventPiece *p = 1464 new PathDiagnosticEventPiece(L, 1465 "Looping back to the head of the loop"); 1466 p->setPrunable(true); 1467 1468 EB.addEdge(p->getLocation(), true); 1469 PD.getActivePath().push_front(p); 1470 1471 if (CS) { 1472 PathDiagnosticLocation BL = 1473 PathDiagnosticLocation::createEndBrace(CS, SM); 1474 EB.addEdge(BL); 1475 } 1476 } 1477 1478 const CFGBlock *BSrc = BE->getSrc(); 1479 ParentMap &PM = PDB.getParentMap(); 1480 1481 if (const Stmt *Term = BSrc->getTerminator()) { 1482 // Are we jumping past the loop body without ever executing the 1483 // loop (because the condition was false)? 1484 if (isLoopJumpPastBody(Term, &*BE) && 1485 !isInLoopBody(PM, 1486 getStmtBeforeCond(PM, 1487 BSrc->getTerminatorCondition(), 1488 N), 1489 Term)) { 1490 PathDiagnosticLocation L(Term, SM, PDB.LC); 1491 PathDiagnosticEventPiece *PE = 1492 new PathDiagnosticEventPiece(L, "Loop body executed 0 times"); 1493 PE->setPrunable(true); 1494 1495 EB.addEdge(PE->getLocation(), true); 1496 PD.getActivePath().push_front(PE); 1497 } 1498 1499 // In any case, add the terminator as the current statement 1500 // context for control edges. 1501 EB.addContext(Term); 1502 } 1503 1504 break; 1505 } 1506 1507 if (Optional<BlockEntrance> BE = P.getAs<BlockEntrance>()) { 1508 Optional<CFGElement> First = BE->getFirstElement(); 1509 if (Optional<CFGStmt> S = First ? First->getAs<CFGStmt>() : None) { 1510 const Stmt *stmt = S->getStmt(); 1511 if (IsControlFlowExpr(stmt)) { 1512 // Add the proper context for '&&', '||', and '?'. 1513 EB.addContext(stmt); 1514 } 1515 else 1516 EB.addExtendedContext(PDB.getEnclosingStmtLocation(stmt).asStmt()); 1517 } 1518 1519 break; 1520 } 1521 1522 1523 } while (0); 1524 1525 if (!NextNode) 1526 continue; 1527 1528 // Add pieces from custom visitors. 1529 BugReport *R = PDB.getBugReport(); 1530 for (ArrayRef<BugReporterVisitor *>::iterator I = visitors.begin(), 1531 E = visitors.end(); 1532 I != E; ++I) { 1533 if (PathDiagnosticPiece *p = (*I)->VisitNode(N, NextNode, PDB, *R)) { 1534 const PathDiagnosticLocation &Loc = p->getLocation(); 1535 EB.addEdge(Loc, true); 1536 PD.getActivePath().push_front(p); 1537 updateStackPiecesWithMessage(p, CallStack); 1538 1539 if (const Stmt *S = Loc.asStmt()) 1540 EB.addExtendedContext(PDB.getEnclosingStmtLocation(S).asStmt()); 1541 } 1542 } 1543 } 1544 1545 return PDB.getBugReport()->isValid(); 1546} 1547 1548/// \brief Adds a sanitized control-flow diagnostic edge to a path. 1549static void addEdgeToPath(PathPieces &path, 1550 PathDiagnosticLocation &PrevLoc, 1551 PathDiagnosticLocation NewLoc, 1552 const LocationContext *LC) { 1553 if (!NewLoc.isValid()) 1554 return; 1555 1556 SourceLocation NewLocL = NewLoc.asLocation(); 1557 if (NewLocL.isInvalid() || NewLocL.isMacroID()) 1558 return; 1559 1560 if (!PrevLoc.isValid()) { 1561 PrevLoc = NewLoc; 1562 return; 1563 } 1564 1565 // FIXME: ignore intra-macro edges for now. 1566 if (NewLoc.asLocation().getExpansionLoc() == 1567 PrevLoc.asLocation().getExpansionLoc()) 1568 return; 1569 1570 path.push_front(new PathDiagnosticControlFlowPiece(NewLoc, 1571 PrevLoc)); 1572 PrevLoc = NewLoc; 1573} 1574 1575/// A customized wrapper for CFGBlock::getTerminatorCondition() 1576/// which returns the element for ObjCForCollectionStmts. 1577static const Stmt *getTerminatorCondition(const CFGBlock *B) { 1578 const Stmt *S = B->getTerminatorCondition(); 1579 if (const ObjCForCollectionStmt *FS = 1580 dyn_cast_or_null<ObjCForCollectionStmt>(S)) 1581 return FS->getElement(); 1582 return S; 1583} 1584 1585static bool 1586GenerateAlternateExtensivePathDiagnostic(PathDiagnostic& PD, 1587 PathDiagnosticBuilder &PDB, 1588 const ExplodedNode *N, 1589 LocationContextMap &LCM, 1590 ArrayRef<BugReporterVisitor *> visitors) { 1591 1592 BugReport *report = PDB.getBugReport(); 1593 const SourceManager& SM = PDB.getSourceManager(); 1594 StackDiagVector CallStack; 1595 InterestingExprs IE; 1596 1597 PathDiagnosticLocation PrevLoc = PD.getLocation(); 1598 1599 const ExplodedNode *NextNode = N->getFirstPred(); 1600 while (NextNode) { 1601 N = NextNode; 1602 NextNode = N->getFirstPred(); 1603 ProgramPoint P = N->getLocation(); 1604 1605 do { 1606 // Have we encountered an entrance to a call? It may be 1607 // the case that we have not encountered a matching 1608 // call exit before this point. This means that the path 1609 // terminated within the call itself. 1610 if (Optional<CallEnter> CE = P.getAs<CallEnter>()) { 1611 // Did we visit an entire call? 1612 bool VisitedEntireCall = PD.isWithinCall(); 1613 PD.popActivePath(); 1614 1615 PathDiagnosticCallPiece *C; 1616 if (VisitedEntireCall) { 1617 PathDiagnosticPiece *P = PD.getActivePath().front().getPtr(); 1618 C = cast<PathDiagnosticCallPiece>(P); 1619 } else { 1620 const Decl *Caller = CE->getLocationContext()->getDecl(); 1621 C = PathDiagnosticCallPiece::construct(PD.getActivePath(), Caller); 1622 1623 // Since we just transferred the path over to the call piece, 1624 // reset the mapping from active to location context. 1625 assert(PD.getActivePath().size() == 1 && 1626 PD.getActivePath().front() == C); 1627 LCM[&PD.getActivePath()] = 0; 1628 1629 // Record the location context mapping for the path within 1630 // the call. 1631 assert(LCM[&C->path] == 0 || 1632 LCM[&C->path] == CE->getCalleeContext()); 1633 LCM[&C->path] = CE->getCalleeContext(); 1634 1635 // If this is the first item in the active path, record 1636 // the new mapping from active path to location context. 1637 const LocationContext *&NewLC = LCM[&PD.getActivePath()]; 1638 if (!NewLC) 1639 NewLC = N->getLocationContext(); 1640 1641 PDB.LC = NewLC; 1642 } 1643 C->setCallee(*CE, SM); 1644 1645 // Update the previous location in the active path. 1646 PrevLoc = C->getLocation(); 1647 1648 if (!CallStack.empty()) { 1649 assert(CallStack.back().first == C); 1650 CallStack.pop_back(); 1651 } 1652 break; 1653 } 1654 1655 // Query the location context here and the previous location 1656 // as processing CallEnter may change the active path. 1657 PDB.LC = N->getLocationContext(); 1658 1659 // Record the mapping from the active path to the location 1660 // context. 1661 assert(!LCM[&PD.getActivePath()] || 1662 LCM[&PD.getActivePath()] == PDB.LC); 1663 LCM[&PD.getActivePath()] = PDB.LC; 1664 1665 // Have we encountered an exit from a function call? 1666 if (Optional<CallExitEnd> CE = P.getAs<CallExitEnd>()) { 1667 const Stmt *S = CE->getCalleeContext()->getCallSite(); 1668 // Propagate the interesting symbols accordingly. 1669 if (const Expr *Ex = dyn_cast_or_null<Expr>(S)) { 1670 reversePropagateIntererstingSymbols(*PDB.getBugReport(), IE, 1671 N->getState().getPtr(), Ex, 1672 N->getLocationContext()); 1673 } 1674 1675 // We are descending into a call (backwards). Construct 1676 // a new call piece to contain the path pieces for that call. 1677 PathDiagnosticCallPiece *C = 1678 PathDiagnosticCallPiece::construct(N, *CE, SM); 1679 1680 // Record the location context for this call piece. 1681 LCM[&C->path] = CE->getCalleeContext(); 1682 1683 // Add the edge to the return site. 1684 addEdgeToPath(PD.getActivePath(), PrevLoc, C->callReturn, PDB.LC); 1685 PD.getActivePath().push_front(C); 1686 PrevLoc.invalidate(); 1687 1688 // Make the contents of the call the active path for now. 1689 PD.pushActivePath(&C->path); 1690 CallStack.push_back(StackDiagPair(C, N)); 1691 break; 1692 } 1693 1694 if (Optional<PostStmt> PS = P.getAs<PostStmt>()) { 1695 // For expressions, make sure we propagate the 1696 // interesting symbols correctly. 1697 if (const Expr *Ex = PS->getStmtAs<Expr>()) 1698 reversePropagateIntererstingSymbols(*PDB.getBugReport(), IE, 1699 N->getState().getPtr(), Ex, 1700 N->getLocationContext()); 1701 1702 // Add an edge. If this is an ObjCForCollectionStmt do 1703 // not add an edge here as it appears in the CFG both 1704 // as a terminator and as a terminator condition. 1705 if (!isa<ObjCForCollectionStmt>(PS->getStmt())) { 1706 PathDiagnosticLocation L = 1707 PathDiagnosticLocation(PS->getStmt(), SM, PDB.LC); 1708 addEdgeToPath(PD.getActivePath(), PrevLoc, L, PDB.LC); 1709 } 1710 break; 1711 } 1712 1713 // Block edges. 1714 if (Optional<BlockEdge> BE = P.getAs<BlockEdge>()) { 1715 // Does this represent entering a call? If so, look at propagating 1716 // interesting symbols across call boundaries. 1717 if (NextNode) { 1718 const LocationContext *CallerCtx = NextNode->getLocationContext(); 1719 const LocationContext *CalleeCtx = PDB.LC; 1720 if (CallerCtx != CalleeCtx) { 1721 reversePropagateInterestingSymbols(*PDB.getBugReport(), IE, 1722 N->getState().getPtr(), 1723 CalleeCtx, CallerCtx); 1724 } 1725 } 1726 1727 // Are we jumping to the head of a loop? Add a special diagnostic. 1728 if (const Stmt *Loop = BE->getSrc()->getLoopTarget()) { 1729 PathDiagnosticLocation L(Loop, SM, PDB.LC); 1730 const CompoundStmt *CS = NULL; 1731 1732 if (const ForStmt *FS = dyn_cast<ForStmt>(Loop)) 1733 CS = dyn_cast<CompoundStmt>(FS->getBody()); 1734 else if (const WhileStmt *WS = dyn_cast<WhileStmt>(Loop)) 1735 CS = dyn_cast<CompoundStmt>(WS->getBody()); 1736 else if (const ObjCForCollectionStmt *OFS = 1737 dyn_cast<ObjCForCollectionStmt>(Loop)) { 1738 CS = dyn_cast<CompoundStmt>(OFS->getBody()); 1739 } 1740 1741 PathDiagnosticEventPiece *p = 1742 new PathDiagnosticEventPiece(L, "Looping back to the head " 1743 "of the loop"); 1744 p->setPrunable(true); 1745 1746 addEdgeToPath(PD.getActivePath(), PrevLoc, p->getLocation(), PDB.LC); 1747 PD.getActivePath().push_front(p); 1748 1749 if (CS) { 1750 addEdgeToPath(PD.getActivePath(), PrevLoc, 1751 PathDiagnosticLocation::createEndBrace(CS, SM), 1752 PDB.LC); 1753 } 1754 } 1755 1756 const CFGBlock *BSrc = BE->getSrc(); 1757 ParentMap &PM = PDB.getParentMap(); 1758 1759 if (const Stmt *Term = BSrc->getTerminator()) { 1760 // Are we jumping past the loop body without ever executing the 1761 // loop (because the condition was false)? 1762 if (isLoop(Term)) { 1763 const Stmt *TermCond = getTerminatorCondition(BSrc); 1764 bool IsInLoopBody = 1765 isInLoopBody(PM, getStmtBeforeCond(PM, TermCond, N), Term); 1766 1767 const char *str = 0; 1768 1769 if (isJumpToFalseBranch(&*BE)) { 1770 if (!IsInLoopBody) { 1771 str = "Loop body executed 0 times"; 1772 } 1773 } 1774 else { 1775 str = "Entering loop body"; 1776 } 1777 1778 if (str) { 1779 PathDiagnosticLocation L(TermCond, SM, PDB.LC); 1780 PathDiagnosticEventPiece *PE = 1781 new PathDiagnosticEventPiece(L, str); 1782 PE->setPrunable(true); 1783 addEdgeToPath(PD.getActivePath(), PrevLoc, 1784 PE->getLocation(), PDB.LC); 1785 PD.getActivePath().push_front(PE); 1786 } 1787 } 1788 else if (isa<BreakStmt>(Term) || isa<ContinueStmt>(Term) || 1789 isa<GotoStmt>(Term)) { 1790 PathDiagnosticLocation L(Term, SM, PDB.LC); 1791 addEdgeToPath(PD.getActivePath(), PrevLoc, L, PDB.LC); 1792 } 1793 } 1794 break; 1795 } 1796 } while (0); 1797 1798 if (!NextNode) 1799 continue; 1800 1801 // Add pieces from custom visitors. 1802 for (ArrayRef<BugReporterVisitor *>::iterator I = visitors.begin(), 1803 E = visitors.end(); 1804 I != E; ++I) { 1805 if (PathDiagnosticPiece *p = (*I)->VisitNode(N, NextNode, PDB, *report)) { 1806 addEdgeToPath(PD.getActivePath(), PrevLoc, p->getLocation(), PDB.LC); 1807 PD.getActivePath().push_front(p); 1808 updateStackPiecesWithMessage(p, CallStack); 1809 } 1810 } 1811 } 1812 1813 return report->isValid(); 1814} 1815 1816static const Stmt *getLocStmt(PathDiagnosticLocation L) { 1817 if (!L.isValid()) 1818 return 0; 1819 return L.asStmt(); 1820} 1821 1822static const Stmt *getStmtParent(const Stmt *S, ParentMap &PM) { 1823 if (!S) 1824 return 0; 1825 1826 while (true) { 1827 S = PM.getParentIgnoreParens(S); 1828 1829 if (!S) 1830 break; 1831 1832 if (isa<ExprWithCleanups>(S) || 1833 isa<CXXBindTemporaryExpr>(S) || 1834 isa<SubstNonTypeTemplateParmExpr>(S)) 1835 continue; 1836 1837 break; 1838 } 1839 1840 return S; 1841} 1842 1843static bool isConditionForTerminator(const Stmt *S, const Stmt *Cond) { 1844 switch (S->getStmtClass()) { 1845 case Stmt::BinaryOperatorClass: { 1846 const BinaryOperator *BO = cast<BinaryOperator>(S); 1847 if (!BO->isLogicalOp()) 1848 return false; 1849 return BO->getLHS() == Cond || BO->getRHS() == Cond; 1850 } 1851 case Stmt::IfStmtClass: 1852 return cast<IfStmt>(S)->getCond() == Cond; 1853 case Stmt::ForStmtClass: 1854 return cast<ForStmt>(S)->getCond() == Cond; 1855 case Stmt::WhileStmtClass: 1856 return cast<WhileStmt>(S)->getCond() == Cond; 1857 case Stmt::DoStmtClass: 1858 return cast<DoStmt>(S)->getCond() == Cond; 1859 case Stmt::ChooseExprClass: 1860 return cast<ChooseExpr>(S)->getCond() == Cond; 1861 case Stmt::IndirectGotoStmtClass: 1862 return cast<IndirectGotoStmt>(S)->getTarget() == Cond; 1863 case Stmt::SwitchStmtClass: 1864 return cast<SwitchStmt>(S)->getCond() == Cond; 1865 case Stmt::BinaryConditionalOperatorClass: 1866 return cast<BinaryConditionalOperator>(S)->getCond() == Cond; 1867 case Stmt::ConditionalOperatorClass: { 1868 const ConditionalOperator *CO = cast<ConditionalOperator>(S); 1869 return CO->getCond() == Cond || 1870 CO->getLHS() == Cond || 1871 CO->getRHS() == Cond; 1872 } 1873 case Stmt::ObjCForCollectionStmtClass: 1874 return cast<ObjCForCollectionStmt>(S)->getElement() == Cond; 1875 default: 1876 return false; 1877 } 1878} 1879 1880static bool isIncrementOrInitInForLoop(const Stmt *S, const Stmt *FL) { 1881 const ForStmt *FS = dyn_cast<ForStmt>(FL); 1882 if (!FS) 1883 return false; 1884 return FS->getInc() == S || FS->getInit() == S; 1885} 1886 1887typedef llvm::DenseSet<const PathDiagnosticCallPiece *> 1888 OptimizedCallsSet; 1889 1890void PathPieces::dump() const { 1891 unsigned index = 0; 1892 for (PathPieces::const_iterator I = begin(), E = end(); I != E; ++I ) { 1893 llvm::errs() << "[" << index++ << "]"; 1894 1895 switch ((*I)->getKind()) { 1896 case PathDiagnosticPiece::Call: 1897 llvm::errs() << " CALL\n--------------\n"; 1898 1899 if (const Stmt *SLoc = getLocStmt((*I)->getLocation())) { 1900 SLoc->dump(); 1901 } else { 1902 const PathDiagnosticCallPiece *Call = cast<PathDiagnosticCallPiece>(*I); 1903 if (const NamedDecl *ND = dyn_cast<NamedDecl>(Call->getCallee())) 1904 llvm::errs() << *ND << "\n"; 1905 } 1906 break; 1907 case PathDiagnosticPiece::Event: 1908 llvm::errs() << " EVENT\n--------------\n"; 1909 llvm::errs() << (*I)->getString() << "\n"; 1910 if (const Stmt *SLoc = getLocStmt((*I)->getLocation())) { 1911 llvm::errs() << " ---- at ----\n"; 1912 SLoc->dump(); 1913 } 1914 break; 1915 case PathDiagnosticPiece::Macro: 1916 llvm::errs() << " MACRO\n--------------\n"; 1917 // FIXME: print which macro is being invoked. 1918 break; 1919 case PathDiagnosticPiece::ControlFlow: { 1920 const PathDiagnosticControlFlowPiece *CP = 1921 cast<PathDiagnosticControlFlowPiece>(*I); 1922 llvm::errs() << " CONTROL\n--------------\n"; 1923 1924 if (const Stmt *s1Start = getLocStmt(CP->getStartLocation())) 1925 s1Start->dump(); 1926 else 1927 llvm::errs() << "NULL\n"; 1928 1929 llvm::errs() << " ---- to ----\n"; 1930 1931 if (const Stmt *s1End = getLocStmt(CP->getEndLocation())) 1932 s1End->dump(); 1933 else 1934 llvm::errs() << "NULL\n"; 1935 1936 break; 1937 } 1938 } 1939 1940 llvm::errs() << "\n"; 1941 } 1942} 1943 1944/// \brief Return true if X is contained by Y. 1945static bool lexicalContains(ParentMap &PM, 1946 const Stmt *X, 1947 const Stmt *Y) { 1948 while (X) { 1949 if (X == Y) 1950 return true; 1951 X = PM.getParent(X); 1952 } 1953 return false; 1954} 1955 1956// Remove short edges on the same line less than 3 columns in difference. 1957static void removePunyEdges(PathPieces &path, 1958 SourceManager &SM, 1959 ParentMap &PM) { 1960 1961 bool erased = false; 1962 1963 for (PathPieces::iterator I = path.begin(), E = path.end(); I != E; 1964 erased ? I : ++I) { 1965 1966 erased = false; 1967 1968 PathDiagnosticControlFlowPiece *PieceI = 1969 dyn_cast<PathDiagnosticControlFlowPiece>(*I); 1970 1971 if (!PieceI) 1972 continue; 1973 1974 const Stmt *start = getLocStmt(PieceI->getStartLocation()); 1975 const Stmt *end = getLocStmt(PieceI->getEndLocation()); 1976 1977 if (!start || !end) 1978 continue; 1979 1980 const Stmt *endParent = PM.getParent(end); 1981 if (!endParent) 1982 continue; 1983 1984 if (isConditionForTerminator(end, endParent)) 1985 continue; 1986 1987 bool Invalid = false; 1988 FullSourceLoc StartL(start->getLocStart(), SM); 1989 FullSourceLoc EndL(end->getLocStart(), SM); 1990 1991 unsigned startLine = StartL.getSpellingLineNumber(&Invalid); 1992 if (Invalid) 1993 continue; 1994 1995 unsigned endLine = EndL.getSpellingLineNumber(&Invalid); 1996 if (Invalid) 1997 continue; 1998 1999 if (startLine != endLine) 2000 continue; 2001 2002 unsigned startCol = StartL.getSpellingColumnNumber(&Invalid); 2003 if (Invalid) 2004 continue; 2005 2006 unsigned endCol = EndL.getSpellingColumnNumber(&Invalid); 2007 if (Invalid) 2008 continue; 2009 2010 if (abs((int)startCol - (int)endCol) <= 2) { 2011 I = path.erase(I); 2012 erased = true; 2013 continue; 2014 } 2015 } 2016} 2017 2018static void removeIdenticalEvents(PathPieces &path) { 2019 for (PathPieces::iterator I = path.begin(), E = path.end(); I != E; ++I) { 2020 PathDiagnosticEventPiece *PieceI = 2021 dyn_cast<PathDiagnosticEventPiece>(*I); 2022 2023 if (!PieceI) 2024 continue; 2025 2026 PathPieces::iterator NextI = I; ++NextI; 2027 if (NextI == E) 2028 return; 2029 2030 PathDiagnosticEventPiece *PieceNextI = 2031 dyn_cast<PathDiagnosticEventPiece>(*NextI); 2032 2033 if (!PieceNextI) 2034 continue; 2035 2036 // Erase the second piece if it has the same exact message text. 2037 if (PieceI->getString() == PieceNextI->getString()) { 2038 path.erase(NextI); 2039 } 2040 } 2041} 2042 2043static bool optimizeEdges(PathPieces &path, SourceManager &SM, 2044 OptimizedCallsSet &OCS, 2045 LocationContextMap &LCM) { 2046 bool hasChanges = false; 2047 const LocationContext *LC = LCM[&path]; 2048 assert(LC); 2049 ParentMap &PM = LC->getParentMap(); 2050 bool isFirst = true; 2051 2052 for (PathPieces::iterator I = path.begin(), E = path.end(); I != E; ) { 2053 bool wasFirst = isFirst; 2054 isFirst = false; 2055 2056 // Optimize subpaths. 2057 if (PathDiagnosticCallPiece *CallI = dyn_cast<PathDiagnosticCallPiece>(*I)){ 2058 // Record the fact that a call has been optimized so we only do the 2059 // effort once. 2060 if (!OCS.count(CallI)) { 2061 while (optimizeEdges(CallI->path, SM, OCS, LCM)) {} 2062 OCS.insert(CallI); 2063 } 2064 ++I; 2065 continue; 2066 } 2067 2068 // Pattern match the current piece and its successor. 2069 PathDiagnosticControlFlowPiece *PieceI = 2070 dyn_cast<PathDiagnosticControlFlowPiece>(*I); 2071 2072 if (!PieceI) { 2073 ++I; 2074 continue; 2075 } 2076 2077 const Stmt *s1Start = getLocStmt(PieceI->getStartLocation()); 2078 const Stmt *s1End = getLocStmt(PieceI->getEndLocation()); 2079 const Stmt *level1 = getStmtParent(s1Start, PM); 2080 const Stmt *level2 = getStmtParent(s1End, PM); 2081 2082 if (wasFirst) { 2083 // If the first edge (in isolation) is just a transition from 2084 // an expression to a parent expression then eliminate that edge. 2085 if (level1 && level2 && level2 == PM.getParent(level1)) { 2086 path.erase(I); 2087 // Since we are erasing the current edge at the start of the 2088 // path, just return now so we start analyzing the start of the path 2089 // again. 2090 return true; 2091 } 2092 2093 // If the first edge (in isolation) is a transition from the 2094 // initialization or increment in a for loop then remove it. 2095 if (level1 && isIncrementOrInitInForLoop(s1Start, level1)) { 2096 path.erase(I); 2097 return true; 2098 } 2099 } 2100 2101 PathPieces::iterator NextI = I; ++NextI; 2102 if (NextI == E) 2103 break; 2104 2105 PathDiagnosticControlFlowPiece *PieceNextI = 2106 dyn_cast<PathDiagnosticControlFlowPiece>(*NextI); 2107 2108 if (!PieceNextI) { 2109 ++I; 2110 continue; 2111 } 2112 2113 const Stmt *s2Start = getLocStmt(PieceNextI->getStartLocation()); 2114 const Stmt *s2End = getLocStmt(PieceNextI->getEndLocation()); 2115 const Stmt *level3 = getStmtParent(s2Start, PM); 2116 const Stmt *level4 = getStmtParent(s2End, PM); 2117 2118 // Rule I. 2119 // 2120 // If we have two consecutive control edges whose end/begin locations 2121 // are at the same level (e.g. statements or top-level expressions within 2122 // a compound statement, or siblings share a single ancestor expression), 2123 // then merge them if they have no interesting intermediate event. 2124 // 2125 // For example: 2126 // 2127 // (1.1 -> 1.2) -> (1.2 -> 1.3) becomes (1.1 -> 1.3) because the common 2128 // parent is '1'. Here 'x.y.z' represents the hierarchy of statements. 2129 // 2130 // NOTE: this will be limited later in cases where we add barriers 2131 // to prevent this optimization. 2132 // 2133 if (level1 && level1 == level2 && level1 == level3 && level1 == level4) { 2134 PieceI->setEndLocation(PieceNextI->getEndLocation()); 2135 path.erase(NextI); 2136 hasChanges = true; 2137 continue; 2138 } 2139 2140 // Rule II. 2141 // 2142 // Eliminate edges between subexpressions and parent expressions 2143 // when the subexpression is consumed. 2144 // 2145 // NOTE: this will be limited later in cases where we add barriers 2146 // to prevent this optimization. 2147 // 2148 if (s1End && s1End == s2Start && level2) { 2149 bool removeEdge = false; 2150 // Remove edges into the increment or initialization of a 2151 // loop that have no interleaving event. This means that 2152 // they aren't interesting. 2153 if (isIncrementOrInitInForLoop(s1End, level2)) 2154 removeEdge = true; 2155 // Next only consider edges that are not anchored on 2156 // the condition of a terminator. This are intermediate edges 2157 // that we might want to trim. 2158 else if (!isConditionForTerminator(level2, s1End)) { 2159 // Trim edges on expressions that are consumed by 2160 // the parent expression. 2161 if (isa<Expr>(s1End) && PM.isConsumedExpr(cast<Expr>(s1End))) { 2162 removeEdge = true; 2163 } 2164 // Trim edges where a lexical containment doesn't exist. 2165 // For example: 2166 // 2167 // X -> Y -> Z 2168 // 2169 // If 'Z' lexically contains Y (it is an ancestor) and 2170 // 'X' does not lexically contain Y (it is a descendant OR 2171 // it has no lexical relationship at all) then trim. 2172 // 2173 // This can eliminate edges where we dive into a subexpression 2174 // and then pop back out, etc. 2175 else if (s1Start && s2End && 2176 lexicalContains(PM, s2Start, s2End) && 2177 !lexicalContains(PM, s1End, s1Start)) { 2178 removeEdge = true; 2179 } 2180 } 2181 2182 if (removeEdge) { 2183 PieceI->setEndLocation(PieceNextI->getEndLocation()); 2184 path.erase(NextI); 2185 hasChanges = true; 2186 continue; 2187 } 2188 } 2189 2190 // Optimize edges for ObjC fast-enumeration loops. 2191 // 2192 // (X -> collection) -> (collection -> element) 2193 // 2194 // becomes: 2195 // 2196 // (X -> element) 2197 if (s1End == s2Start) { 2198 const ObjCForCollectionStmt *FS = 2199 dyn_cast_or_null<ObjCForCollectionStmt>(level3); 2200 if (FS && FS->getCollection()->IgnoreParens() == s2Start && 2201 s2End == FS->getElement()) { 2202 PieceI->setEndLocation(PieceNextI->getEndLocation()); 2203 path.erase(NextI); 2204 hasChanges = true; 2205 continue; 2206 } 2207 } 2208 2209 // No changes at this index? Move to the next one. 2210 ++I; 2211 } 2212 2213 if (!hasChanges) { 2214 // Remove any puny edges left over after primary optimization pass. 2215 removePunyEdges(path, SM, PM); 2216 // Remove identical events. 2217 removeIdenticalEvents(path); 2218 } 2219 2220 return hasChanges; 2221} 2222 2223static void adjustBranchEdges(PathPieces &pieces, LocationContextMap &LCM, 2224 SourceManager &SM) { 2225 // Retrieve the parent map for this path. 2226 const LocationContext *LC = LCM[&pieces]; 2227 ParentMap &PM = LC->getParentMap(); 2228 PathPieces::iterator Prev = pieces.end(); 2229 for (PathPieces::iterator I = pieces.begin(), E = pieces.end(); I != E; 2230 Prev = I, ++I) { 2231 // Adjust edges in subpaths. 2232 if (PathDiagnosticCallPiece *Call = dyn_cast<PathDiagnosticCallPiece>(*I)) { 2233 adjustBranchEdges(Call->path, LCM, SM); 2234 continue; 2235 } 2236 2237 PathDiagnosticControlFlowPiece *PieceI = 2238 dyn_cast<PathDiagnosticControlFlowPiece>(*I); 2239 2240 if (!PieceI) 2241 continue; 2242 2243 // We are looking at two edges. Is the second one incident 2244 // on an expression (or subexpression) of a branch condition. 2245 const Stmt *Dst = getLocStmt(PieceI->getEndLocation()); 2246 const Stmt *Src = getLocStmt(PieceI->getStartLocation()); 2247 2248 if (!Dst || !Src) 2249 continue; 2250 2251 const Stmt *Branch = 0; 2252 const Stmt *S = Dst; 2253 while (const Stmt *Parent = getStmtParent(S, PM)) { 2254 if (const ForStmt *FS = dyn_cast<ForStmt>(Parent)) { 2255 if (FS->getCond()->IgnoreParens() == S) 2256 Branch = FS; 2257 break; 2258 } 2259 if (const WhileStmt *WS = dyn_cast<WhileStmt>(Parent)) { 2260 if (WS->getCond()->IgnoreParens() == S) 2261 Branch = WS; 2262 break; 2263 } 2264 if (const IfStmt *IS = dyn_cast<IfStmt>(Parent)) { 2265 if (IS->getCond()->IgnoreParens() == S) 2266 Branch = IS; 2267 break; 2268 } 2269 if (const ObjCForCollectionStmt *OFS = 2270 dyn_cast<ObjCForCollectionStmt>(Parent)) { 2271 if (OFS->getElement() == S) 2272 Branch = OFS; 2273 break; 2274 } 2275 2276 S = Parent; 2277 } 2278 2279 // If 'Branch' is non-null we have found a match where we have an edge 2280 // incident on the condition of a if/for/while statement. 2281 if (!Branch) 2282 continue; 2283 2284 // If the current source of the edge is the if/for/while, then there is 2285 // nothing left to be done. 2286 if (Src == Branch) 2287 continue; 2288 2289 // Now look at the previous edge. We want to know if this was in the same 2290 // "level" as the for statement. 2291 const Stmt *SrcParent = getStmtParent(Src, PM); 2292 const Stmt *BranchParent = getStmtParent(Branch, PM); 2293 if (SrcParent && SrcParent == BranchParent) { 2294 PathDiagnosticLocation L(Branch, SM, LC); 2295 bool needsEdge = true; 2296 2297 if (Prev != E) { 2298 if (PathDiagnosticControlFlowPiece *P = 2299 dyn_cast<PathDiagnosticControlFlowPiece>(*Prev)) { 2300 const Stmt *PrevSrc = getLocStmt(P->getStartLocation()); 2301 if (PrevSrc) { 2302 const Stmt *PrevSrcParent = getStmtParent(PrevSrc, PM); 2303 if (PrevSrcParent == BranchParent) { 2304 P->setEndLocation(L); 2305 needsEdge = false; 2306 } 2307 } 2308 } 2309 } 2310 2311 if (needsEdge) { 2312 PathDiagnosticControlFlowPiece *P = 2313 new PathDiagnosticControlFlowPiece(PieceI->getStartLocation(), L); 2314 pieces.insert(I, P); 2315 } 2316 2317 PieceI->setStartLocation(L); 2318 } 2319 } 2320} 2321 2322//===----------------------------------------------------------------------===// 2323// Methods for BugType and subclasses. 2324//===----------------------------------------------------------------------===// 2325BugType::~BugType() { } 2326 2327void BugType::FlushReports(BugReporter &BR) {} 2328 2329void BuiltinBug::anchor() {} 2330 2331//===----------------------------------------------------------------------===// 2332// Methods for BugReport and subclasses. 2333//===----------------------------------------------------------------------===// 2334 2335void BugReport::NodeResolver::anchor() {} 2336 2337void BugReport::addVisitor(BugReporterVisitor* visitor) { 2338 if (!visitor) 2339 return; 2340 2341 llvm::FoldingSetNodeID ID; 2342 visitor->Profile(ID); 2343 void *InsertPos; 2344 2345 if (CallbacksSet.FindNodeOrInsertPos(ID, InsertPos)) { 2346 delete visitor; 2347 return; 2348 } 2349 2350 CallbacksSet.InsertNode(visitor, InsertPos); 2351 Callbacks.push_back(visitor); 2352 ++ConfigurationChangeToken; 2353} 2354 2355BugReport::~BugReport() { 2356 for (visitor_iterator I = visitor_begin(), E = visitor_end(); I != E; ++I) { 2357 delete *I; 2358 } 2359 while (!interestingSymbols.empty()) { 2360 popInterestingSymbolsAndRegions(); 2361 } 2362} 2363 2364const Decl *BugReport::getDeclWithIssue() const { 2365 if (DeclWithIssue) 2366 return DeclWithIssue; 2367 2368 const ExplodedNode *N = getErrorNode(); 2369 if (!N) 2370 return 0; 2371 2372 const LocationContext *LC = N->getLocationContext(); 2373 return LC->getCurrentStackFrame()->getDecl(); 2374} 2375 2376void BugReport::Profile(llvm::FoldingSetNodeID& hash) const { 2377 hash.AddPointer(&BT); 2378 hash.AddString(Description); 2379 PathDiagnosticLocation UL = getUniqueingLocation(); 2380 if (UL.isValid()) { 2381 UL.Profile(hash); 2382 } else if (Location.isValid()) { 2383 Location.Profile(hash); 2384 } else { 2385 assert(ErrorNode); 2386 hash.AddPointer(GetCurrentOrPreviousStmt(ErrorNode)); 2387 } 2388 2389 for (SmallVectorImpl<SourceRange>::const_iterator I = 2390 Ranges.begin(), E = Ranges.end(); I != E; ++I) { 2391 const SourceRange range = *I; 2392 if (!range.isValid()) 2393 continue; 2394 hash.AddInteger(range.getBegin().getRawEncoding()); 2395 hash.AddInteger(range.getEnd().getRawEncoding()); 2396 } 2397} 2398 2399void BugReport::markInteresting(SymbolRef sym) { 2400 if (!sym) 2401 return; 2402 2403 // If the symbol wasn't already in our set, note a configuration change. 2404 if (getInterestingSymbols().insert(sym).second) 2405 ++ConfigurationChangeToken; 2406 2407 if (const SymbolMetadata *meta = dyn_cast<SymbolMetadata>(sym)) 2408 getInterestingRegions().insert(meta->getRegion()); 2409} 2410 2411void BugReport::markInteresting(const MemRegion *R) { 2412 if (!R) 2413 return; 2414 2415 // If the base region wasn't already in our set, note a configuration change. 2416 R = R->getBaseRegion(); 2417 if (getInterestingRegions().insert(R).second) 2418 ++ConfigurationChangeToken; 2419 2420 if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(R)) 2421 getInterestingSymbols().insert(SR->getSymbol()); 2422} 2423 2424void BugReport::markInteresting(SVal V) { 2425 markInteresting(V.getAsRegion()); 2426 markInteresting(V.getAsSymbol()); 2427} 2428 2429void BugReport::markInteresting(const LocationContext *LC) { 2430 if (!LC) 2431 return; 2432 InterestingLocationContexts.insert(LC); 2433} 2434 2435bool BugReport::isInteresting(SVal V) { 2436 return isInteresting(V.getAsRegion()) || isInteresting(V.getAsSymbol()); 2437} 2438 2439bool BugReport::isInteresting(SymbolRef sym) { 2440 if (!sym) 2441 return false; 2442 // We don't currently consider metadata symbols to be interesting 2443 // even if we know their region is interesting. Is that correct behavior? 2444 return getInterestingSymbols().count(sym); 2445} 2446 2447bool BugReport::isInteresting(const MemRegion *R) { 2448 if (!R) 2449 return false; 2450 R = R->getBaseRegion(); 2451 bool b = getInterestingRegions().count(R); 2452 if (b) 2453 return true; 2454 if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(R)) 2455 return getInterestingSymbols().count(SR->getSymbol()); 2456 return false; 2457} 2458 2459bool BugReport::isInteresting(const LocationContext *LC) { 2460 if (!LC) 2461 return false; 2462 return InterestingLocationContexts.count(LC); 2463} 2464 2465void BugReport::lazyInitializeInterestingSets() { 2466 if (interestingSymbols.empty()) { 2467 interestingSymbols.push_back(new Symbols()); 2468 interestingRegions.push_back(new Regions()); 2469 } 2470} 2471 2472BugReport::Symbols &BugReport::getInterestingSymbols() { 2473 lazyInitializeInterestingSets(); 2474 return *interestingSymbols.back(); 2475} 2476 2477BugReport::Regions &BugReport::getInterestingRegions() { 2478 lazyInitializeInterestingSets(); 2479 return *interestingRegions.back(); 2480} 2481 2482void BugReport::pushInterestingSymbolsAndRegions() { 2483 interestingSymbols.push_back(new Symbols(getInterestingSymbols())); 2484 interestingRegions.push_back(new Regions(getInterestingRegions())); 2485} 2486 2487void BugReport::popInterestingSymbolsAndRegions() { 2488 delete interestingSymbols.back(); 2489 interestingSymbols.pop_back(); 2490 delete interestingRegions.back(); 2491 interestingRegions.pop_back(); 2492} 2493 2494const Stmt *BugReport::getStmt() const { 2495 if (!ErrorNode) 2496 return 0; 2497 2498 ProgramPoint ProgP = ErrorNode->getLocation(); 2499 const Stmt *S = NULL; 2500 2501 if (Optional<BlockEntrance> BE = ProgP.getAs<BlockEntrance>()) { 2502 CFGBlock &Exit = ProgP.getLocationContext()->getCFG()->getExit(); 2503 if (BE->getBlock() == &Exit) 2504 S = GetPreviousStmt(ErrorNode); 2505 } 2506 if (!S) 2507 S = PathDiagnosticLocation::getStmt(ErrorNode); 2508 2509 return S; 2510} 2511 2512std::pair<BugReport::ranges_iterator, BugReport::ranges_iterator> 2513BugReport::getRanges() { 2514 // If no custom ranges, add the range of the statement corresponding to 2515 // the error node. 2516 if (Ranges.empty()) { 2517 if (const Expr *E = dyn_cast_or_null<Expr>(getStmt())) 2518 addRange(E->getSourceRange()); 2519 else 2520 return std::make_pair(ranges_iterator(), ranges_iterator()); 2521 } 2522 2523 // User-specified absence of range info. 2524 if (Ranges.size() == 1 && !Ranges.begin()->isValid()) 2525 return std::make_pair(ranges_iterator(), ranges_iterator()); 2526 2527 return std::make_pair(Ranges.begin(), Ranges.end()); 2528} 2529 2530PathDiagnosticLocation BugReport::getLocation(const SourceManager &SM) const { 2531 if (ErrorNode) { 2532 assert(!Location.isValid() && 2533 "Either Location or ErrorNode should be specified but not both."); 2534 return PathDiagnosticLocation::createEndOfPath(ErrorNode, SM); 2535 } else { 2536 assert(Location.isValid()); 2537 return Location; 2538 } 2539 2540 return PathDiagnosticLocation(); 2541} 2542 2543//===----------------------------------------------------------------------===// 2544// Methods for BugReporter and subclasses. 2545//===----------------------------------------------------------------------===// 2546 2547BugReportEquivClass::~BugReportEquivClass() { } 2548GRBugReporter::~GRBugReporter() { } 2549BugReporterData::~BugReporterData() {} 2550 2551ExplodedGraph &GRBugReporter::getGraph() { return Eng.getGraph(); } 2552 2553ProgramStateManager& 2554GRBugReporter::getStateManager() { return Eng.getStateManager(); } 2555 2556BugReporter::~BugReporter() { 2557 FlushReports(); 2558 2559 // Free the bug reports we are tracking. 2560 typedef std::vector<BugReportEquivClass *> ContTy; 2561 for (ContTy::iterator I = EQClassesVector.begin(), E = EQClassesVector.end(); 2562 I != E; ++I) { 2563 delete *I; 2564 } 2565} 2566 2567void BugReporter::FlushReports() { 2568 if (BugTypes.isEmpty()) 2569 return; 2570 2571 // First flush the warnings for each BugType. This may end up creating new 2572 // warnings and new BugTypes. 2573 // FIXME: Only NSErrorChecker needs BugType's FlushReports. 2574 // Turn NSErrorChecker into a proper checker and remove this. 2575 SmallVector<const BugType*, 16> bugTypes; 2576 for (BugTypesTy::iterator I=BugTypes.begin(), E=BugTypes.end(); I!=E; ++I) 2577 bugTypes.push_back(*I); 2578 for (SmallVector<const BugType*, 16>::iterator 2579 I = bugTypes.begin(), E = bugTypes.end(); I != E; ++I) 2580 const_cast<BugType*>(*I)->FlushReports(*this); 2581 2582 // We need to flush reports in deterministic order to ensure the order 2583 // of the reports is consistent between runs. 2584 typedef std::vector<BugReportEquivClass *> ContVecTy; 2585 for (ContVecTy::iterator EI=EQClassesVector.begin(), EE=EQClassesVector.end(); 2586 EI != EE; ++EI){ 2587 BugReportEquivClass& EQ = **EI; 2588 FlushReport(EQ); 2589 } 2590 2591 // BugReporter owns and deletes only BugTypes created implicitly through 2592 // EmitBasicReport. 2593 // FIXME: There are leaks from checkers that assume that the BugTypes they 2594 // create will be destroyed by the BugReporter. 2595 for (llvm::StringMap<BugType*>::iterator 2596 I = StrBugTypes.begin(), E = StrBugTypes.end(); I != E; ++I) 2597 delete I->second; 2598 2599 // Remove all references to the BugType objects. 2600 BugTypes = F.getEmptySet(); 2601} 2602 2603//===----------------------------------------------------------------------===// 2604// PathDiagnostics generation. 2605//===----------------------------------------------------------------------===// 2606 2607namespace { 2608/// A wrapper around a report graph, which contains only a single path, and its 2609/// node maps. 2610class ReportGraph { 2611public: 2612 InterExplodedGraphMap BackMap; 2613 OwningPtr<ExplodedGraph> Graph; 2614 const ExplodedNode *ErrorNode; 2615 size_t Index; 2616}; 2617 2618/// A wrapper around a trimmed graph and its node maps. 2619class TrimmedGraph { 2620 InterExplodedGraphMap InverseMap; 2621 2622 typedef llvm::DenseMap<const ExplodedNode *, unsigned> PriorityMapTy; 2623 PriorityMapTy PriorityMap; 2624 2625 typedef std::pair<const ExplodedNode *, size_t> NodeIndexPair; 2626 SmallVector<NodeIndexPair, 32> ReportNodes; 2627 2628 OwningPtr<ExplodedGraph> G; 2629 2630 /// A helper class for sorting ExplodedNodes by priority. 2631 template <bool Descending> 2632 class PriorityCompare { 2633 const PriorityMapTy &PriorityMap; 2634 2635 public: 2636 PriorityCompare(const PriorityMapTy &M) : PriorityMap(M) {} 2637 2638 bool operator()(const ExplodedNode *LHS, const ExplodedNode *RHS) const { 2639 PriorityMapTy::const_iterator LI = PriorityMap.find(LHS); 2640 PriorityMapTy::const_iterator RI = PriorityMap.find(RHS); 2641 PriorityMapTy::const_iterator E = PriorityMap.end(); 2642 2643 if (LI == E) 2644 return Descending; 2645 if (RI == E) 2646 return !Descending; 2647 2648 return Descending ? LI->second > RI->second 2649 : LI->second < RI->second; 2650 } 2651 2652 bool operator()(const NodeIndexPair &LHS, const NodeIndexPair &RHS) const { 2653 return (*this)(LHS.first, RHS.first); 2654 } 2655 }; 2656 2657public: 2658 TrimmedGraph(const ExplodedGraph *OriginalGraph, 2659 ArrayRef<const ExplodedNode *> Nodes); 2660 2661 bool popNextReportGraph(ReportGraph &GraphWrapper); 2662}; 2663} 2664 2665TrimmedGraph::TrimmedGraph(const ExplodedGraph *OriginalGraph, 2666 ArrayRef<const ExplodedNode *> Nodes) { 2667 // The trimmed graph is created in the body of the constructor to ensure 2668 // that the DenseMaps have been initialized already. 2669 InterExplodedGraphMap ForwardMap; 2670 G.reset(OriginalGraph->trim(Nodes, &ForwardMap, &InverseMap)); 2671 2672 // Find the (first) error node in the trimmed graph. We just need to consult 2673 // the node map which maps from nodes in the original graph to nodes 2674 // in the new graph. 2675 llvm::SmallPtrSet<const ExplodedNode *, 32> RemainingNodes; 2676 2677 for (unsigned i = 0, count = Nodes.size(); i < count; ++i) { 2678 if (const ExplodedNode *NewNode = ForwardMap.lookup(Nodes[i])) { 2679 ReportNodes.push_back(std::make_pair(NewNode, i)); 2680 RemainingNodes.insert(NewNode); 2681 } 2682 } 2683 2684 assert(!RemainingNodes.empty() && "No error node found in the trimmed graph"); 2685 2686 // Perform a forward BFS to find all the shortest paths. 2687 std::queue<const ExplodedNode *> WS; 2688 2689 assert(G->num_roots() == 1); 2690 WS.push(*G->roots_begin()); 2691 unsigned Priority = 0; 2692 2693 while (!WS.empty()) { 2694 const ExplodedNode *Node = WS.front(); 2695 WS.pop(); 2696 2697 PriorityMapTy::iterator PriorityEntry; 2698 bool IsNew; 2699 llvm::tie(PriorityEntry, IsNew) = 2700 PriorityMap.insert(std::make_pair(Node, Priority)); 2701 ++Priority; 2702 2703 if (!IsNew) { 2704 assert(PriorityEntry->second <= Priority); 2705 continue; 2706 } 2707 2708 if (RemainingNodes.erase(Node)) 2709 if (RemainingNodes.empty()) 2710 break; 2711 2712 for (ExplodedNode::const_pred_iterator I = Node->succ_begin(), 2713 E = Node->succ_end(); 2714 I != E; ++I) 2715 WS.push(*I); 2716 } 2717 2718 // Sort the error paths from longest to shortest. 2719 std::sort(ReportNodes.begin(), ReportNodes.end(), 2720 PriorityCompare<true>(PriorityMap)); 2721} 2722 2723bool TrimmedGraph::popNextReportGraph(ReportGraph &GraphWrapper) { 2724 if (ReportNodes.empty()) 2725 return false; 2726 2727 const ExplodedNode *OrigN; 2728 llvm::tie(OrigN, GraphWrapper.Index) = ReportNodes.pop_back_val(); 2729 assert(PriorityMap.find(OrigN) != PriorityMap.end() && 2730 "error node not accessible from root"); 2731 2732 // Create a new graph with a single path. This is the graph 2733 // that will be returned to the caller. 2734 ExplodedGraph *GNew = new ExplodedGraph(); 2735 GraphWrapper.Graph.reset(GNew); 2736 GraphWrapper.BackMap.clear(); 2737 2738 // Now walk from the error node up the BFS path, always taking the 2739 // predeccessor with the lowest number. 2740 ExplodedNode *Succ = 0; 2741 while (true) { 2742 // Create the equivalent node in the new graph with the same state 2743 // and location. 2744 ExplodedNode *NewN = GNew->getNode(OrigN->getLocation(), OrigN->getState(), 2745 OrigN->isSink()); 2746 2747 // Store the mapping to the original node. 2748 InterExplodedGraphMap::const_iterator IMitr = InverseMap.find(OrigN); 2749 assert(IMitr != InverseMap.end() && "No mapping to original node."); 2750 GraphWrapper.BackMap[NewN] = IMitr->second; 2751 2752 // Link up the new node with the previous node. 2753 if (Succ) 2754 Succ->addPredecessor(NewN, *GNew); 2755 else 2756 GraphWrapper.ErrorNode = NewN; 2757 2758 Succ = NewN; 2759 2760 // Are we at the final node? 2761 if (OrigN->pred_empty()) { 2762 GNew->addRoot(NewN); 2763 break; 2764 } 2765 2766 // Find the next predeccessor node. We choose the node that is marked 2767 // with the lowest BFS number. 2768 OrigN = *std::min_element(OrigN->pred_begin(), OrigN->pred_end(), 2769 PriorityCompare<false>(PriorityMap)); 2770 } 2771 2772 return true; 2773} 2774 2775 2776/// CompactPathDiagnostic - This function postprocesses a PathDiagnostic object 2777/// and collapses PathDiagosticPieces that are expanded by macros. 2778static void CompactPathDiagnostic(PathPieces &path, const SourceManager& SM) { 2779 typedef std::vector<std::pair<IntrusiveRefCntPtr<PathDiagnosticMacroPiece>, 2780 SourceLocation> > MacroStackTy; 2781 2782 typedef std::vector<IntrusiveRefCntPtr<PathDiagnosticPiece> > 2783 PiecesTy; 2784 2785 MacroStackTy MacroStack; 2786 PiecesTy Pieces; 2787 2788 for (PathPieces::const_iterator I = path.begin(), E = path.end(); 2789 I!=E; ++I) { 2790 2791 PathDiagnosticPiece *piece = I->getPtr(); 2792 2793 // Recursively compact calls. 2794 if (PathDiagnosticCallPiece *call=dyn_cast<PathDiagnosticCallPiece>(piece)){ 2795 CompactPathDiagnostic(call->path, SM); 2796 } 2797 2798 // Get the location of the PathDiagnosticPiece. 2799 const FullSourceLoc Loc = piece->getLocation().asLocation(); 2800 2801 // Determine the instantiation location, which is the location we group 2802 // related PathDiagnosticPieces. 2803 SourceLocation InstantiationLoc = Loc.isMacroID() ? 2804 SM.getExpansionLoc(Loc) : 2805 SourceLocation(); 2806 2807 if (Loc.isFileID()) { 2808 MacroStack.clear(); 2809 Pieces.push_back(piece); 2810 continue; 2811 } 2812 2813 assert(Loc.isMacroID()); 2814 2815 // Is the PathDiagnosticPiece within the same macro group? 2816 if (!MacroStack.empty() && InstantiationLoc == MacroStack.back().second) { 2817 MacroStack.back().first->subPieces.push_back(piece); 2818 continue; 2819 } 2820 2821 // We aren't in the same group. Are we descending into a new macro 2822 // or are part of an old one? 2823 IntrusiveRefCntPtr<PathDiagnosticMacroPiece> MacroGroup; 2824 2825 SourceLocation ParentInstantiationLoc = InstantiationLoc.isMacroID() ? 2826 SM.getExpansionLoc(Loc) : 2827 SourceLocation(); 2828 2829 // Walk the entire macro stack. 2830 while (!MacroStack.empty()) { 2831 if (InstantiationLoc == MacroStack.back().second) { 2832 MacroGroup = MacroStack.back().first; 2833 break; 2834 } 2835 2836 if (ParentInstantiationLoc == MacroStack.back().second) { 2837 MacroGroup = MacroStack.back().first; 2838 break; 2839 } 2840 2841 MacroStack.pop_back(); 2842 } 2843 2844 if (!MacroGroup || ParentInstantiationLoc == MacroStack.back().second) { 2845 // Create a new macro group and add it to the stack. 2846 PathDiagnosticMacroPiece *NewGroup = 2847 new PathDiagnosticMacroPiece( 2848 PathDiagnosticLocation::createSingleLocation(piece->getLocation())); 2849 2850 if (MacroGroup) 2851 MacroGroup->subPieces.push_back(NewGroup); 2852 else { 2853 assert(InstantiationLoc.isFileID()); 2854 Pieces.push_back(NewGroup); 2855 } 2856 2857 MacroGroup = NewGroup; 2858 MacroStack.push_back(std::make_pair(MacroGroup, InstantiationLoc)); 2859 } 2860 2861 // Finally, add the PathDiagnosticPiece to the group. 2862 MacroGroup->subPieces.push_back(piece); 2863 } 2864 2865 // Now take the pieces and construct a new PathDiagnostic. 2866 path.clear(); 2867 2868 for (PiecesTy::iterator I=Pieces.begin(), E=Pieces.end(); I!=E; ++I) 2869 path.push_back(*I); 2870} 2871 2872bool GRBugReporter::generatePathDiagnostic(PathDiagnostic& PD, 2873 PathDiagnosticConsumer &PC, 2874 ArrayRef<BugReport *> &bugReports) { 2875 assert(!bugReports.empty()); 2876 2877 bool HasValid = false; 2878 bool HasInvalid = false; 2879 SmallVector<const ExplodedNode *, 32> errorNodes; 2880 for (ArrayRef<BugReport*>::iterator I = bugReports.begin(), 2881 E = bugReports.end(); I != E; ++I) { 2882 if ((*I)->isValid()) { 2883 HasValid = true; 2884 errorNodes.push_back((*I)->getErrorNode()); 2885 } else { 2886 // Keep the errorNodes list in sync with the bugReports list. 2887 HasInvalid = true; 2888 errorNodes.push_back(0); 2889 } 2890 } 2891 2892 // If all the reports have been marked invalid by a previous path generation, 2893 // we're done. 2894 if (!HasValid) 2895 return false; 2896 2897 typedef PathDiagnosticConsumer::PathGenerationScheme PathGenerationScheme; 2898 PathGenerationScheme ActiveScheme = PC.getGenerationScheme(); 2899 2900 if (ActiveScheme == PathDiagnosticConsumer::Extensive) { 2901 AnalyzerOptions &options = getAnalyzerOptions(); 2902 if (options.getBooleanOption("path-diagnostics-alternate", false)) { 2903 ActiveScheme = PathDiagnosticConsumer::AlternateExtensive; 2904 } 2905 } 2906 2907 TrimmedGraph TrimG(&getGraph(), errorNodes); 2908 ReportGraph ErrorGraph; 2909 2910 while (TrimG.popNextReportGraph(ErrorGraph)) { 2911 // Find the BugReport with the original location. 2912 assert(ErrorGraph.Index < bugReports.size()); 2913 BugReport *R = bugReports[ErrorGraph.Index]; 2914 assert(R && "No original report found for sliced graph."); 2915 assert(R->isValid() && "Report selected by trimmed graph marked invalid."); 2916 2917 // Start building the path diagnostic... 2918 PathDiagnosticBuilder PDB(*this, R, ErrorGraph.BackMap, &PC); 2919 const ExplodedNode *N = ErrorGraph.ErrorNode; 2920 2921 // Register additional node visitors. 2922 R->addVisitor(new NilReceiverBRVisitor()); 2923 R->addVisitor(new ConditionBRVisitor()); 2924 R->addVisitor(new LikelyFalsePositiveSuppressionBRVisitor()); 2925 2926 BugReport::VisitorList visitors; 2927 unsigned origReportConfigToken, finalReportConfigToken; 2928 LocationContextMap LCM; 2929 2930 // While generating diagnostics, it's possible the visitors will decide 2931 // new symbols and regions are interesting, or add other visitors based on 2932 // the information they find. If they do, we need to regenerate the path 2933 // based on our new report configuration. 2934 do { 2935 // Get a clean copy of all the visitors. 2936 for (BugReport::visitor_iterator I = R->visitor_begin(), 2937 E = R->visitor_end(); I != E; ++I) 2938 visitors.push_back((*I)->clone()); 2939 2940 // Clear out the active path from any previous work. 2941 PD.resetPath(); 2942 origReportConfigToken = R->getConfigurationChangeToken(); 2943 2944 // Generate the very last diagnostic piece - the piece is visible before 2945 // the trace is expanded. 2946 PathDiagnosticPiece *LastPiece = 0; 2947 for (BugReport::visitor_iterator I = visitors.begin(), E = visitors.end(); 2948 I != E; ++I) { 2949 if (PathDiagnosticPiece *Piece = (*I)->getEndPath(PDB, N, *R)) { 2950 assert (!LastPiece && 2951 "There can only be one final piece in a diagnostic."); 2952 LastPiece = Piece; 2953 } 2954 } 2955 2956 if (ActiveScheme != PathDiagnosticConsumer::None) { 2957 if (!LastPiece) 2958 LastPiece = BugReporterVisitor::getDefaultEndPath(PDB, N, *R); 2959 assert(LastPiece); 2960 PD.setEndOfPath(LastPiece); 2961 } 2962 2963 // Make sure we get a clean location context map so we don't 2964 // hold onto old mappings. 2965 LCM.clear(); 2966 2967 switch (ActiveScheme) { 2968 case PathDiagnosticConsumer::AlternateExtensive: 2969 GenerateAlternateExtensivePathDiagnostic(PD, PDB, N, LCM, visitors); 2970 break; 2971 case PathDiagnosticConsumer::Extensive: 2972 GenerateExtensivePathDiagnostic(PD, PDB, N, LCM, visitors); 2973 break; 2974 case PathDiagnosticConsumer::Minimal: 2975 GenerateMinimalPathDiagnostic(PD, PDB, N, LCM, visitors); 2976 break; 2977 case PathDiagnosticConsumer::None: 2978 GenerateVisitorsOnlyPathDiagnostic(PD, PDB, N, visitors); 2979 break; 2980 } 2981 2982 // Clean up the visitors we used. 2983 llvm::DeleteContainerPointers(visitors); 2984 2985 // Did anything change while generating this path? 2986 finalReportConfigToken = R->getConfigurationChangeToken(); 2987 } while (finalReportConfigToken != origReportConfigToken); 2988 2989 if (!R->isValid()) 2990 continue; 2991 2992 // Finally, prune the diagnostic path of uninteresting stuff. 2993 if (!PD.path.empty()) { 2994 // Remove messages that are basically the same. 2995 removeRedundantMsgs(PD.getMutablePieces()); 2996 2997 if (R->shouldPrunePath() && getAnalyzerOptions().shouldPrunePaths()) { 2998 bool stillHasNotes = removeUnneededCalls(PD.getMutablePieces(), R, LCM); 2999 assert(stillHasNotes); 3000 (void)stillHasNotes; 3001 } 3002 3003 adjustCallLocations(PD.getMutablePieces()); 3004 3005 if (ActiveScheme == PathDiagnosticConsumer::AlternateExtensive) { 3006 SourceManager &SM = getSourceManager(); 3007 3008 // Reduce the number of edges from a very conservative set 3009 // to an aesthetically pleasing subset that conveys the 3010 // necessary information. 3011 OptimizedCallsSet OCS; 3012 while (optimizeEdges(PD.getMutablePieces(), SM, OCS, LCM)) {} 3013 3014 // Adjust edges into loop conditions to make them more uniform 3015 // and aesthetically pleasing. 3016 adjustBranchEdges(PD.getMutablePieces(), LCM, SM); 3017 } 3018 } 3019 3020 // We found a report and didn't suppress it. 3021 return true; 3022 } 3023 3024 // We suppressed all the reports in this equivalence class. 3025 assert(!HasInvalid && "Inconsistent suppression"); 3026 (void)HasInvalid; 3027 return false; 3028} 3029 3030void BugReporter::Register(BugType *BT) { 3031 BugTypes = F.add(BugTypes, BT); 3032} 3033 3034void BugReporter::emitReport(BugReport* R) { 3035 // Compute the bug report's hash to determine its equivalence class. 3036 llvm::FoldingSetNodeID ID; 3037 R->Profile(ID); 3038 3039 // Lookup the equivance class. If there isn't one, create it. 3040 BugType& BT = R->getBugType(); 3041 Register(&BT); 3042 void *InsertPos; 3043 BugReportEquivClass* EQ = EQClasses.FindNodeOrInsertPos(ID, InsertPos); 3044 3045 if (!EQ) { 3046 EQ = new BugReportEquivClass(R); 3047 EQClasses.InsertNode(EQ, InsertPos); 3048 EQClassesVector.push_back(EQ); 3049 } 3050 else 3051 EQ->AddReport(R); 3052} 3053 3054 3055//===----------------------------------------------------------------------===// 3056// Emitting reports in equivalence classes. 3057//===----------------------------------------------------------------------===// 3058 3059namespace { 3060struct FRIEC_WLItem { 3061 const ExplodedNode *N; 3062 ExplodedNode::const_succ_iterator I, E; 3063 3064 FRIEC_WLItem(const ExplodedNode *n) 3065 : N(n), I(N->succ_begin()), E(N->succ_end()) {} 3066}; 3067} 3068 3069static BugReport * 3070FindReportInEquivalenceClass(BugReportEquivClass& EQ, 3071 SmallVectorImpl<BugReport*> &bugReports) { 3072 3073 BugReportEquivClass::iterator I = EQ.begin(), E = EQ.end(); 3074 assert(I != E); 3075 BugType& BT = I->getBugType(); 3076 3077 // If we don't need to suppress any of the nodes because they are 3078 // post-dominated by a sink, simply add all the nodes in the equivalence class 3079 // to 'Nodes'. Any of the reports will serve as a "representative" report. 3080 if (!BT.isSuppressOnSink()) { 3081 BugReport *R = I; 3082 for (BugReportEquivClass::iterator I=EQ.begin(), E=EQ.end(); I!=E; ++I) { 3083 const ExplodedNode *N = I->getErrorNode(); 3084 if (N) { 3085 R = I; 3086 bugReports.push_back(R); 3087 } 3088 } 3089 return R; 3090 } 3091 3092 // For bug reports that should be suppressed when all paths are post-dominated 3093 // by a sink node, iterate through the reports in the equivalence class 3094 // until we find one that isn't post-dominated (if one exists). We use a 3095 // DFS traversal of the ExplodedGraph to find a non-sink node. We could write 3096 // this as a recursive function, but we don't want to risk blowing out the 3097 // stack for very long paths. 3098 BugReport *exampleReport = 0; 3099 3100 for (; I != E; ++I) { 3101 const ExplodedNode *errorNode = I->getErrorNode(); 3102 3103 if (!errorNode) 3104 continue; 3105 if (errorNode->isSink()) { 3106 llvm_unreachable( 3107 "BugType::isSuppressSink() should not be 'true' for sink end nodes"); 3108 } 3109 // No successors? By definition this nodes isn't post-dominated by a sink. 3110 if (errorNode->succ_empty()) { 3111 bugReports.push_back(I); 3112 if (!exampleReport) 3113 exampleReport = I; 3114 continue; 3115 } 3116 3117 // At this point we know that 'N' is not a sink and it has at least one 3118 // successor. Use a DFS worklist to find a non-sink end-of-path node. 3119 typedef FRIEC_WLItem WLItem; 3120 typedef SmallVector<WLItem, 10> DFSWorkList; 3121 llvm::DenseMap<const ExplodedNode *, unsigned> Visited; 3122 3123 DFSWorkList WL; 3124 WL.push_back(errorNode); 3125 Visited[errorNode] = 1; 3126 3127 while (!WL.empty()) { 3128 WLItem &WI = WL.back(); 3129 assert(!WI.N->succ_empty()); 3130 3131 for (; WI.I != WI.E; ++WI.I) { 3132 const ExplodedNode *Succ = *WI.I; 3133 // End-of-path node? 3134 if (Succ->succ_empty()) { 3135 // If we found an end-of-path node that is not a sink. 3136 if (!Succ->isSink()) { 3137 bugReports.push_back(I); 3138 if (!exampleReport) 3139 exampleReport = I; 3140 WL.clear(); 3141 break; 3142 } 3143 // Found a sink? Continue on to the next successor. 3144 continue; 3145 } 3146 // Mark the successor as visited. If it hasn't been explored, 3147 // enqueue it to the DFS worklist. 3148 unsigned &mark = Visited[Succ]; 3149 if (!mark) { 3150 mark = 1; 3151 WL.push_back(Succ); 3152 break; 3153 } 3154 } 3155 3156 // The worklist may have been cleared at this point. First 3157 // check if it is empty before checking the last item. 3158 if (!WL.empty() && &WL.back() == &WI) 3159 WL.pop_back(); 3160 } 3161 } 3162 3163 // ExampleReport will be NULL if all the nodes in the equivalence class 3164 // were post-dominated by sinks. 3165 return exampleReport; 3166} 3167 3168void BugReporter::FlushReport(BugReportEquivClass& EQ) { 3169 SmallVector<BugReport*, 10> bugReports; 3170 BugReport *exampleReport = FindReportInEquivalenceClass(EQ, bugReports); 3171 if (exampleReport) { 3172 const PathDiagnosticConsumers &C = getPathDiagnosticConsumers(); 3173 for (PathDiagnosticConsumers::const_iterator I=C.begin(), 3174 E=C.end(); I != E; ++I) { 3175 FlushReport(exampleReport, **I, bugReports); 3176 } 3177 } 3178} 3179 3180void BugReporter::FlushReport(BugReport *exampleReport, 3181 PathDiagnosticConsumer &PD, 3182 ArrayRef<BugReport*> bugReports) { 3183 3184 // FIXME: Make sure we use the 'R' for the path that was actually used. 3185 // Probably doesn't make a difference in practice. 3186 BugType& BT = exampleReport->getBugType(); 3187 3188 OwningPtr<PathDiagnostic> 3189 D(new PathDiagnostic(exampleReport->getDeclWithIssue(), 3190 exampleReport->getBugType().getName(), 3191 exampleReport->getDescription(), 3192 exampleReport->getShortDescription(/*Fallback=*/false), 3193 BT.getCategory(), 3194 exampleReport->getUniqueingLocation(), 3195 exampleReport->getUniqueingDecl())); 3196 3197 MaxBugClassSize = std::max(bugReports.size(), 3198 static_cast<size_t>(MaxBugClassSize)); 3199 3200 // Generate the full path diagnostic, using the generation scheme 3201 // specified by the PathDiagnosticConsumer. Note that we have to generate 3202 // path diagnostics even for consumers which do not support paths, because 3203 // the BugReporterVisitors may mark this bug as a false positive. 3204 if (!bugReports.empty()) 3205 if (!generatePathDiagnostic(*D.get(), PD, bugReports)) 3206 return; 3207 3208 MaxValidBugClassSize = std::max(bugReports.size(), 3209 static_cast<size_t>(MaxValidBugClassSize)); 3210 3211 // Examine the report and see if the last piece is in a header. Reset the 3212 // report location to the last piece in the main source file. 3213 AnalyzerOptions& Opts = getAnalyzerOptions(); 3214 if (Opts.shouldReportIssuesInMainSourceFile() && !Opts.AnalyzeAll) 3215 D->resetDiagnosticLocationToMainFile(); 3216 3217 // If the path is empty, generate a single step path with the location 3218 // of the issue. 3219 if (D->path.empty()) { 3220 PathDiagnosticLocation L = exampleReport->getLocation(getSourceManager()); 3221 PathDiagnosticPiece *piece = 3222 new PathDiagnosticEventPiece(L, exampleReport->getDescription()); 3223 BugReport::ranges_iterator Beg, End; 3224 llvm::tie(Beg, End) = exampleReport->getRanges(); 3225 for ( ; Beg != End; ++Beg) 3226 piece->addRange(*Beg); 3227 D->setEndOfPath(piece); 3228 } 3229 3230 // Get the meta data. 3231 const BugReport::ExtraTextList &Meta = exampleReport->getExtraText(); 3232 for (BugReport::ExtraTextList::const_iterator i = Meta.begin(), 3233 e = Meta.end(); i != e; ++i) { 3234 D->addMeta(*i); 3235 } 3236 3237 PD.HandlePathDiagnostic(D.take()); 3238} 3239 3240void BugReporter::EmitBasicReport(const Decl *DeclWithIssue, 3241 StringRef name, 3242 StringRef category, 3243 StringRef str, PathDiagnosticLocation Loc, 3244 SourceRange* RBeg, unsigned NumRanges) { 3245 3246 // 'BT' is owned by BugReporter. 3247 BugType *BT = getBugTypeForName(name, category); 3248 BugReport *R = new BugReport(*BT, str, Loc); 3249 R->setDeclWithIssue(DeclWithIssue); 3250 for ( ; NumRanges > 0 ; --NumRanges, ++RBeg) R->addRange(*RBeg); 3251 emitReport(R); 3252} 3253 3254BugType *BugReporter::getBugTypeForName(StringRef name, 3255 StringRef category) { 3256 SmallString<136> fullDesc; 3257 llvm::raw_svector_ostream(fullDesc) << name << ":" << category; 3258 llvm::StringMapEntry<BugType *> & 3259 entry = StrBugTypes.GetOrCreateValue(fullDesc); 3260 BugType *BT = entry.getValue(); 3261 if (!BT) { 3262 BT = new BugType(name, category); 3263 entry.setValue(BT); 3264 } 3265 return BT; 3266} 3267