BugReporter.h revision 97bfb558f69c09b01a5c1510f08dc91eb62329a7
1db0e15ae3e2b5e180541eec35e2bce54359ca7d8Zhongxing Xu//===--- BugReporter.h - Generate PathDiagnostics --------------*- C++ -*-===// 261f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek// 361f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek// The LLVM Compiler Infrastructure 461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek// 561f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek// This file is distributed under the University of Illinois Open Source 661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek// License. See LICENSE.TXT for details. 761f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek// 861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek//===----------------------------------------------------------------------===// 961f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek// 1061f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek// This file defines BugReporter, a utility class for generating 1118c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek// PathDiagnostics for analyses based on ProgramState. 1261f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek// 1361f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek//===----------------------------------------------------------------------===// 1461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 155a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis#ifndef LLVM_CLANG_GR_BUGREPORTER 165a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis#define LLVM_CLANG_GR_BUGREPORTER 1761f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 18d2f642b56e87493edfc3b0dab359b5e32d5f8a5eTed Kremenek#include "clang/Basic/SourceLocation.h" 1950bbc165b063155cc23c360deb7b865502e068e2Anna Zaks#include "clang/StaticAnalyzer/Core/BugReporter/BugReporterVisitor.h" 20590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks#include "clang/StaticAnalyzer/Core/BugReporter/PathDiagnostic.h" 2118c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState.h" 2230a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "llvm/ADT/DenseSet.h" 231b431023814196f87515a540ebcb9e9f1a9176a1Ted Kremenek#include "llvm/ADT/FoldingSet.h" 241b431023814196f87515a540ebcb9e9f1a9176a1Ted Kremenek#include "llvm/ADT/ImmutableSet.h" 2580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks#include "llvm/ADT/SmallSet.h" 2630a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "llvm/ADT/ilist.h" 2730a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "llvm/ADT/ilist_node.h" 28e207558e9dbed963eebf5cf31fdb02616f1545a3Ted Kremenek 2961f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremeneknamespace clang { 301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 315a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidisclass ASTContext; 32d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieclass DiagnosticsEngine; 335a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidisclass Stmt; 345a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidisclass ParentMap; 355a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 369ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremeneknamespace ento { 375a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 3861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekclass PathDiagnostic; 395e2d2c2ee3cf410643e0f9a5701708e51409d973Benjamin Kramerclass ExplodedNode; 405e2d2c2ee3cf410643e0f9a5701708e51409d973Benjamin Kramerclass ExplodedGraph; 418e6431adab313e283a992698f6fc7afe62420999Anna Zaksclass BugReport; 4250a6d0ce344c02782e0207574005c3b2aaa5077cTed Kremenekclass BugReporter; 438966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenekclass BugReporterContext; 44d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidisclass ExprEngine; 45cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekclass BugType; 461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 47cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 48cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// Interface for individual bug reports. 49cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 508966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek 51e7c4c4ccc6a51c82332382267b84e9d72f229b5eAnna Zaks/// This class provides an interface through which checkers can create 52e7c4c4ccc6a51c82332382267b84e9d72f229b5eAnna Zaks/// individual bug reports. 534a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramerclass BugReport : public llvm::ilist_node<BugReport> { 5476aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenekpublic: 55e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks class NodeResolver { 5699ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 57e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks public: 58e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual ~NodeResolver() {} 59e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual const ExplodedNode* 60e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks getOriginalNode(const ExplodedNode *N) = 0; 61e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks }; 62e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 63e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks typedef const SourceRange *ranges_iterator; 643bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose typedef SmallVector<BugReporterVisitor *, 8> VisitorList; 653bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose typedef VisitorList::iterator visitor_iterator; 667f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks typedef SmallVector<StringRef, 2> ExtraTextList; 67e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 687a9bb52171f962d51ab13c1e012d2236feb9558dTed Kremenekprotected: 69e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks friend class BugReporter; 70e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks friend class BugReportEquivClass; 71e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 72cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugType& BT; 7307189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek const Decl *DeclWithIssue; 74d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek std::string ShortDescription; 75cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek std::string Description; 76590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticLocation Location; 77ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks PathDiagnosticLocation UniqueingLocation; 7897bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks const Decl *UniqueingDecl; 7997bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks 80212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care const ExplodedNode *ErrorNode; 81e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks SmallVector<SourceRange, 4> Ranges; 827f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks ExtraTextList ExtraText; 8376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 8476aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek typedef llvm::DenseSet<SymbolRef> Symbols; 8576aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek typedef llvm::DenseSet<const MemRegion *> Regions; 8676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 87c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// A (stack of) a set of symbols that are registered with this 88c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// report as being "interesting", and thus used to help decide which 89c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// diagnostics to include when constructing the final path diagnostic. 90c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// The stack is largely used by BugReporter when generating PathDiagnostics 91c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// for multiple PathDiagnosticConsumers. 92c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek llvm::SmallVector<Symbols *, 2> interestingSymbols; 93c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 94c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// A (stack of) set of regions that are registered with this report as being 9576aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek /// "interesting", and thus used to help decide which diagnostics 9676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek /// to include when constructing the final path diagnostic. 97c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// The stack is largely used by BugReporter when generating PathDiagnostics 98c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// for multiple PathDiagnosticConsumers. 99c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek llvm::SmallVector<Regions *, 2> interestingRegions; 1008e6431adab313e283a992698f6fc7afe62420999Anna Zaks 10180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks /// A set of location contexts that correspoind to call sites which should be 10280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks /// considered "interesting". 10380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks llvm::SmallSet<const LocationContext *, 2> InterestingLocationContexts; 10480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 1053bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// A set of custom visitors which generate "event" diagnostics at 1063bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// interesting points in the path. 1073bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose VisitorList Callbacks; 1083bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 1093bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// Used for ensuring the visitors are only added once. 1108e6431adab313e283a992698f6fc7afe62420999Anna Zaks llvm::FoldingSet<BugReporterVisitor> CallbacksSet; 111cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 1123bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// Used for clients to tell if the report's configuration has changed 1133bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// since the last time they checked. 1143bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose unsigned ConfigurationChangeToken; 115ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek 116ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// When set, this flag disables all callstack pruning from a diagnostic 117ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// path. This is useful for some reports that want maximum fidelty 118ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// when reporting an issue. 119ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek bool DoNotPrunePath; 1203bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 1218347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// Used to track unique reasons why a bug report might be invalid. 1228347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// 1238347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// \sa markInvalid 1248347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// \sa removeInvalidation 1258347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose typedef std::pair<const void *, const void *> InvalidationRecord; 1268347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 1278347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// If non-empty, this bug report is likely a false positive and should not be 1288347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// shown to the user. 1298347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// 1308347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// \sa markInvalid 1318347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// \sa removeInvalidation 1328347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose llvm::SmallSet<InvalidationRecord, 4> Invalidations; 1338347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 134c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekprivate: 135c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek // Used internally by BugReporter. 136c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek Symbols &getInterestingSymbols(); 137c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek Regions &getInterestingRegions(); 138c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 139c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek void lazyInitializeInterestingSets(); 140c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek void pushInterestingSymbolsAndRegions(); 141c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek void popInterestingSymbolsAndRegions(); 142c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 143e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zakspublic: 144686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugReport(BugType& bt, StringRef desc, const ExplodedNode *errornode) 14507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek : BT(bt), DeclWithIssue(0), Description(desc), ErrorNode(errornode), 146ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek ConfigurationChangeToken(0), DoNotPrunePath(false) {} 1471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 148686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugReport(BugType& bt, StringRef shortDesc, StringRef desc, 149212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care const ExplodedNode *errornode) 15007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek : BT(bt), DeclWithIssue(0), ShortDescription(shortDesc), Description(desc), 151ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek ErrorNode(errornode), ConfigurationChangeToken(0), 152ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek DoNotPrunePath(false) {} 153d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek 154590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks BugReport(BugType& bt, StringRef desc, PathDiagnosticLocation l) 15507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek : BT(bt), DeclWithIssue(0), Description(desc), Location(l), ErrorNode(0), 156ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek ConfigurationChangeToken(0), 157ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek DoNotPrunePath(false) {} 158b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks 159ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// \brief Create a BugReport with a custom uniqueing location. 160ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// 161ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// The reports that have the same report location, description, bug type, and 162ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// ranges are uniqued - only one of the equivalent reports will be presented 163ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// to the user. This method allows to rest the location which should be used 164ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// for uniquing reports. For example, memory leaks checker, could set this to 165ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// the allocation site, rather then the location where the bug is reported. 166ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks BugReport(BugType& bt, StringRef desc, const ExplodedNode *errornode, 16797bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks PathDiagnosticLocation LocationToUnique, const Decl *DeclToUnique) 16807189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek : BT(bt), DeclWithIssue(0), Description(desc), 16907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek UniqueingLocation(LocationToUnique), 17097bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks UniqueingDecl(DeclToUnique), 1718347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose ErrorNode(errornode), ConfigurationChangeToken(0), 1728347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose DoNotPrunePath(false) {} 173ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks 17450a6d0ce344c02782e0207574005c3b2aaa5077cTed Kremenek virtual ~BugReport(); 1751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 176cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek const BugType& getBugType() const { return BT; } 177cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugType& getBugType() { return BT; } 1781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1799c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *getErrorNode() const { return ErrorNode; } 1801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 181686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const StringRef getDescription() const { return Description; } 182d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek 1833a46f5fd1709f6df03bbb8b0abf84052dc0f39ffJordan Rose const StringRef getShortDescription(bool UseFallback = true) const { 1843a46f5fd1709f6df03bbb8b0abf84052dc0f39ffJordan Rose if (ShortDescription.empty() && UseFallback) 1853a46f5fd1709f6df03bbb8b0abf84052dc0f39ffJordan Rose return Description; 1863a46f5fd1709f6df03bbb8b0abf84052dc0f39ffJordan Rose return ShortDescription; 187d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek } 1881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 189ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// Indicates whether or not any path pruning should take place 190ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// when generating a PathDiagnostic from this BugReport. 191ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek bool shouldPrunePath() const { return !DoNotPrunePath; } 192ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek 193ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// Disable all path pruning when generating a PathDiagnostic. 194ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek void disablePathPruning() { DoNotPrunePath = true; } 195ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek 19676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek void markInteresting(SymbolRef sym); 19776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek void markInteresting(const MemRegion *R); 19876aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek void markInteresting(SVal V); 19980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks void markInteresting(const LocationContext *LC); 20076aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 201c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek bool isInteresting(SymbolRef sym); 202c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek bool isInteresting(const MemRegion *R); 203c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek bool isInteresting(SVal V); 20480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks bool isInteresting(const LocationContext *LC); 2053bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 2063bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose unsigned getConfigurationChangeToken() const { 2073bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose return ConfigurationChangeToken; 2083bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose } 2098347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 2108347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// Returns whether or not this report should be considered valid. 2118347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// 2128347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// Invalid reports are those that have been classified as likely false 2138347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// positives after the fact. 2148347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose bool isValid() const { 2158347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose return Invalidations.empty(); 2168347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose } 2178347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 2188347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// Marks the current report as invalid, meaning that it is probably a false 2198347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// positive and should not be reported to the user. 2208347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// 2218347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// The \p Tag and \p Data arguments are intended to be opaque identifiers for 2228347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// this particular invalidation, where \p Tag represents the visitor 2238347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// responsible for invalidation, and \p Data represents the reason this 2248347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// visitor decided to invalidate the bug report. 2258347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// 2268347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// \sa removeInvalidation 2278347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose void markInvalid(const void *Tag, const void *Data) { 2288347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose Invalidations.insert(std::make_pair(Tag, Data)); 2298347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose } 2308347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 2318347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// Reverses the effects of a previous invalidation. 2328347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// 2338347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// \sa markInvalid 2348347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose void removeInvalidation(const void *Tag, const void *Data) { 2358347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose Invalidations.erase(std::make_pair(Tag, Data)); 2368347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose } 23776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 23807189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek /// Return the canonical declaration, be it a method or class, where 23907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek /// this issue semantically occurred. 24007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek const Decl *getDeclWithIssue() const; 24107189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek 24207189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek /// Specifically set the Decl where an issue occurred. This isn't necessary 24307189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek /// for BugReports that cover a path as it will be automatically inferred. 24407189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void setDeclWithIssue(const Decl *declWithIssue) { 24507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek DeclWithIssue = declWithIssue; 24607189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek } 24707189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek 248e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief This allows for addition of meta data to the diagnostic. 24938ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 25038ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// Currently, only the HTMLDiagnosticClient knows how to display it. 2517f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks void addExtraText(StringRef S) { 2527f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks ExtraText.push_back(S); 2537f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks } 2547f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks 2557f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks virtual const ExtraTextList &getExtraText() { 2567f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks return ExtraText; 257072192bcbb05a0fee7ec3061750b27e8d2004952Ted Kremenek } 2581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 25938ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Return the "definitive" location of the reported bug. 26038ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 261cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek /// While a bug can span an entire path, usually there is a specific 262fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner /// location that can be used to identify where the key issue occurred. 263cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek /// This location is used by clients rendering diagnostics. 264590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks virtual PathDiagnosticLocation getLocation(const SourceManager &SM) const; 2651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 26697bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks /// \brief Get the location on which the report should be uniqued. 26797bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks PathDiagnosticLocation getUniqueingLocation() const { 26897bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks return UniqueingLocation; 26997bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks } 27097bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks 27197bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks /// \brief Get the declaration containing the uniqueing location. 27297bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks const Decl *getUniqueingDecl() const { 27397bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks return UniqueingDecl; 27497bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks } 27597bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks 27623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const Stmt *getStmt() const; 27723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 278e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Add a range to a bug report. 279e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// 280e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// Ranges are used to highlight regions of interest in the source code. 281e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// They should be at the same source code line as the BugReport location. 28214924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks /// By default, the source range of the statement corresponding to the error 28314924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks /// node will be used; add a single invalid range to specify absence of 28414924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks /// ranges. 285e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks void addRange(SourceRange R) { 28614924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks assert((R.isValid() || Ranges.empty()) && "Invalid range can only be used " 28714924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks "to specify that the report does not have a range."); 288e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks Ranges.push_back(R); 289e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks } 290640ccf071076e684713cc3c3276bb51982bff607Argyrios Kyrtzidis 291e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Get the SourceRanges associated with the report. 292e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual std::pair<ranges_iterator, ranges_iterator> getRanges(); 293e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 294e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Add custom or predefined bug report visitors to this report. 295e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// 296e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// The visitors should be used when the default trace is not sufficient. 297e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// For example, they allow constructing a more elaborate trace. 298e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \sa registerConditionVisitor(), registerTrackNullOrUndefValue(), 299e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// registerFindLastStore(), registerNilReceiverVisitor(), and 300e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// registerVarDeclsLastStore(). 30150bbc165b063155cc23c360deb7b865502e068e2Anna Zaks void addVisitor(BugReporterVisitor *visitor); 3028e6431adab313e283a992698f6fc7afe62420999Anna Zaks 3038e6431adab313e283a992698f6fc7afe62420999Anna Zaks /// Iterators through the custom diagnostic visitors. 3048e6431adab313e283a992698f6fc7afe62420999Anna Zaks visitor_iterator visitor_begin() { return Callbacks.begin(); } 3058e6431adab313e283a992698f6fc7afe62420999Anna Zaks visitor_iterator visitor_end() { return Callbacks.end(); } 3064522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks 3074522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks /// Profile to identify equivalent bug reports for error report coalescing. 3084522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks /// Reports are uniqued to ensure that we do not emit multiple diagnostics 3094522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks /// for each bug. 3104522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks virtual void Profile(llvm::FoldingSetNodeID& hash) const; 3116837faa083bebad39aa342f84c2b450fb6410eafTed Kremenek}; 312cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 3134a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer} // end ento namespace 3144a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer} // end clang namespace 3154a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer 3164a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramernamespace llvm { 3174a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer template<> struct ilist_traits<clang::ento::BugReport> 3184a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer : public ilist_default_traits<clang::ento::BugReport> { 3194a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer clang::ento::BugReport *createSentinel() const { 3204a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer return static_cast<clang::ento::BugReport *>(&Sentinel); 3214a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer } 3224a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer void destroySentinel(clang::ento::BugReport *) const {} 3234a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer 3244a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer clang::ento::BugReport *provideInitialHead() const { 3254a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer return createSentinel(); 3264a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer } 3274a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer clang::ento::BugReport *ensureHead(clang::ento::BugReport *) const { 3284a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer return createSentinel(); 3294a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer } 3304a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer private: 3314a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer mutable ilist_half_node<clang::ento::BugReport> Sentinel; 3324a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer }; 3334a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer} 3344a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer 3354a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramernamespace clang { 3364a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramernamespace ento { 3374a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer 338cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 339cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// BugTypes (collections of related reports). 340cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 3411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 342cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekclass BugReportEquivClass : public llvm::FoldingSetNode { 34338ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// List of *owned* BugReport objects. 3444a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer llvm::ilist<BugReport> Reports; 3451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 346cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek friend class BugReporter; 347cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void AddReport(BugReport* R) { Reports.push_back(R); } 348cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekpublic: 349cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugReportEquivClass(BugReport* R) { Reports.push_back(R); } 350cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek ~BugReportEquivClass(); 351cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 352cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void Profile(llvm::FoldingSetNodeID& ID) const { 353cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek assert(!Reports.empty()); 3544a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer Reports.front().Profile(ID); 355cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek } 356cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 3574a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer typedef llvm::ilist<BugReport>::iterator iterator; 3584a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer typedef llvm::ilist<BugReport>::const_iterator const_iterator; 3591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3604a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer iterator begin() { return Reports.begin(); } 3614a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer iterator end() { return Reports.end(); } 3621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3634a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer const_iterator begin() const { return Reports.begin(); } 3644a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer const_iterator end() const { return Reports.end(); } 365cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek}; 3661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 367cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 368cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// BugReporter and friends. 369cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 370cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 371c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekclass BugReporterData { 372c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekpublic: 373c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~BugReporterData(); 374d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie virtual DiagnosticsEngine& getDiagnostic() = 0; 375c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek virtual ArrayRef<PathDiagnosticConsumer*> getPathDiagnosticConsumers() = 0; 3769c378f705405d37f49795d5e915989de774fe11fTed Kremenek virtual ASTContext &getASTContext() = 0; 377c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual SourceManager& getSourceManager() = 0; 378c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek}; 3791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 38038ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// BugReporter is a utility class for generating PathDiagnostics for analysis. 38138ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// It collects the BugReports and BugTypes and knows how to generate 38238ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// and flush the corresponding diagnostics. 38361f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekclass BugReporter { 384c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekpublic: 385c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek enum Kind { BaseBRKind, GRBugReporterKind }; 386c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 387cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekprivate: 388cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek typedef llvm::ImmutableSet<BugType*> BugTypesTy; 389cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugTypesTy::Factory F; 390cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugTypesTy BugTypes; 391cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 3921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const Kind kind; 393c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek BugReporterData& D; 3941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 39538ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// Generate and flush the diagnostics for the given bug report. 396cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void FlushReport(BugReportEquivClass& EQ); 397cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 398c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// Generate and flush the diagnostics for the given bug report 399c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// and PathDiagnosticConsumer. 400c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek void FlushReport(BugReport *exampleReport, 401c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticConsumer &PD, 402c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<BugReport*> BugReports); 403c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 40438ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// The set of bug reports tracked by the BugReporter. 405404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::FoldingSet<BugReportEquivClass> EQClasses; 4063b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks /// A vector of BugReports for tracking the allocated pointers and cleanup. 4073b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks std::vector<BugReportEquivClass *> EQClassesVector; 408404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 40980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks /// A map from PathDiagnosticPiece to the LocationContext of the inlined 41080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks /// function call it represents. 41180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks llvm::DenseMap<const PathDiagnosticCallPiece*, 41280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const LocationContext*> LocationContextMap; 41380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 414cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekprotected: 4153baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugReporter(BugReporterData& d, Kind k) : BugTypes(F.getEmptySet()), kind(k), 416212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care D(d) {} 417cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 41861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekpublic: 4193baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugReporter(BugReporterData& d) : BugTypes(F.getEmptySet()), kind(BaseBRKind), 420212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care D(d) {} 421c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~BugReporter(); 4221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 42338ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Generate and flush diagnostics for all bug reports. 424cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void FlushReports(); 4251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 426c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek Kind getKind() const { return kind; } 4271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 428d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine& getDiagnostic() { 429c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return D.getDiagnostic(); 430c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 4311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 432c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<PathDiagnosticConsumer*> getPathDiagnosticConsumers() { 433c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek return D.getPathDiagnosticConsumers(); 434c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 4351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 43638ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Iterator over the set of BugTypes tracked by the BugReporter. 4373aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek typedef BugTypesTy::iterator iterator; 4383aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek iterator begin() { return BugTypes.begin(); } 4393aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek iterator end() { return BugTypes.end(); } 4401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 44138ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Iterator over the set of BugReports tracked by the BugReporter. 442404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis typedef llvm::FoldingSet<BugReportEquivClass>::iterator EQClasses_iterator; 443404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis EQClasses_iterator EQClasses_begin() { return EQClasses.begin(); } 444404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis EQClasses_iterator EQClasses_end() { return EQClasses.end(); } 445404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 4469c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &getContext() { return D.getASTContext(); } 4471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 448cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek SourceManager& getSourceManager() { return D.getSourceManager(); } 4491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4508347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose virtual bool generatePathDiagnostic(PathDiagnostic& pathDiagnostic, 451c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticConsumer &PC, 4528347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose ArrayRef<BugReport *> &bugReports) { 4538347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose return true; 4548347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose } 45561f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 456afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose bool RemoveUnneededCalls(PathPieces &pieces, BugReport *R); 45780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 458cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void Register(BugType *BT); 4591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 46038ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Add the given report to the set of reports tracked by BugReporter. 46138ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 46238ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// The reports are usually generated by the checkers. Further, they are 46338ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// folded based on the profile value, which is done to coalesce similar 46438ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// reports. 465785950e59424dca7ce0081bebf13c0acd2c4fff6Jordan Rose void emitReport(BugReport *R); 4661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 46707189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void EmitBasicReport(const Decl *DeclWithIssue, 46807189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek StringRef BugName, StringRef BugCategory, 469590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef BugStr, PathDiagnosticLocation Loc, 4708c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek SourceRange* RangeBeg, unsigned NumRanges); 4711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 47207189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void EmitBasicReport(const Decl *DeclWithIssue, 47307189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek StringRef BugName, StringRef BugCategory, 474590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef BugStr, PathDiagnosticLocation Loc) { 47507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek EmitBasicReport(DeclWithIssue, BugName, BugCategory, BugStr, Loc, 0, 0); 47662059e809596a419e6fc3e751b2f0b57b7cc51e7Ted Kremenek } 4771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 47807189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void EmitBasicReport(const Decl *DeclWithIssue, 47907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek StringRef BugName, StringRef Category, 480590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef BugStr, PathDiagnosticLocation Loc, 481f0171732efb4647772ad2a45c0f31978b0e34f71Benjamin Kramer SourceRange R) { 48207189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek EmitBasicReport(DeclWithIssue, BugName, Category, BugStr, Loc, &R, 1); 4838c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek } 4841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 48580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks void addCallPieceLocationContextPair(const PathDiagnosticCallPiece *C, 48680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const LocationContext *LC) { 48780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks LocationContextMap[C] = LC; 48880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 489404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidisprivate: 490404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::StringMap<BugType *> StrBugTypes; 491404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 492404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis /// \brief Returns a BugType that is associated with the given name and 493404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis /// category. 494686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugType *getBugTypeForName(StringRef name, StringRef category); 495c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek}; 4968966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek 497cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// FIXME: Get rid of GRBugReporter. It's the wrong abstraction. 498c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekclass GRBugReporter : public BugReporter { 499d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis ExprEngine& Eng; 5001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 501d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis GRBugReporter(BugReporterData& d, ExprEngine& eng) 502c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek : BugReporter(d, GRBugReporterKind), Eng(eng) {} 5031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 504c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~GRBugReporter(); 5051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 506cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getEngine - Return the analysis engine used to analyze a given 507cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// function or method. 508d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis ExprEngine &getEngine() { return Eng; } 509c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 510cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getGraph - Get the exploded graph created by the analysis engine 511cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// for the analyzed method or function. 51238b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu ExplodedGraph &getGraph(); 5131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 514cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getStateManager - Return the state manager used by the analysis 515cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// engine. 51618c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ProgramStateManager &getStateManager(); 5171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5188347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// Generates a path corresponding to one of the given bug reports. 5198347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// 5208347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// Which report is used for path generation is not specified. The 5218347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// bug reporter will try to pick the shortest path, but this is not 5228347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// guaranteed. 5238347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// 5248347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// \return True if the report was valid and a path was generated, 5258347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// false if the reports should be considered invalid. 5268347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose virtual bool generatePathDiagnostic(PathDiagnostic &PD, 527c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticConsumer &PC, 528c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<BugReport*> &bugReports); 529c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 530cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// classof - Used by isa<>, cast<>, and dyn_cast<>. 531c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek static bool classof(const BugReporter* R) { 532c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return R->getKind() == GRBugReporterKind; 533c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 53461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek}; 5351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5368966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenekclass BugReporterContext { 53799ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 5388966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek GRBugReporter &BR; 5398966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenekpublic: 5408e6431adab313e283a992698f6fc7afe62420999Anna Zaks BugReporterContext(GRBugReporter& br) : BR(br) {} 5411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5428e6431adab313e283a992698f6fc7afe62420999Anna Zaks virtual ~BugReporterContext() {} 5431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump GRBugReporter& getBugReporter() { return BR; } 5451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 54638b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu ExplodedGraph &getGraph() { return BR.getGraph(); } 5471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 54818c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ProgramStateManager& getStateManager() { 5498966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getStateManager(); 5508966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 5511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 552c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek SValBuilder& getSValBuilder() { 553c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek return getStateManager().getSValBuilder(); 554dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 5551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5569c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &getASTContext() { 5578966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getContext(); 5588966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 5591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5608966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek SourceManager& getSourceManager() { 5618966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getSourceManager(); 5628966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 5631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump virtual BugReport::NodeResolver& getNodeResolver() = 0; 5658966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek}; 566e207558e9dbed963eebf5cf31fdb02616f1545a3Ted Kremenek 5675a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis} // end GR namespace 5685a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 56961f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek} // end clang namespace 57061f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 57161f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek#endif 572