BugReporter.h revision d95b70175646829c26344d5f0bda1ec3009f2a5b
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" 19d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks#include "clang/StaticAnalyzer/Core/AnalyzerOptions.h" 2050bbc165b063155cc23c360deb7b865502e068e2Anna Zaks#include "clang/StaticAnalyzer/Core/BugReporter/BugReporterVisitor.h" 21590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks#include "clang/StaticAnalyzer/Core/BugReporter/PathDiagnostic.h" 2218c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState.h" 2330a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "llvm/ADT/DenseSet.h" 241b431023814196f87515a540ebcb9e9f1a9176a1Ted Kremenek#include "llvm/ADT/FoldingSet.h" 251b431023814196f87515a540ebcb9e9f1a9176a1Ted Kremenek#include "llvm/ADT/ImmutableSet.h" 2680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks#include "llvm/ADT/SmallSet.h" 2730a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "llvm/ADT/ilist.h" 2830a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "llvm/ADT/ilist_node.h" 29e207558e9dbed963eebf5cf31fdb02616f1545a3Ted Kremenek 3061f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremeneknamespace clang { 311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 325a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidisclass ASTContext; 33d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieclass DiagnosticsEngine; 345a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidisclass Stmt; 355a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidisclass ParentMap; 365a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 379ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremeneknamespace ento { 385a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 3961f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekclass PathDiagnostic; 405e2d2c2ee3cf410643e0f9a5701708e51409d973Benjamin Kramerclass ExplodedNode; 415e2d2c2ee3cf410643e0f9a5701708e51409d973Benjamin Kramerclass ExplodedGraph; 428e6431adab313e283a992698f6fc7afe62420999Anna Zaksclass BugReport; 4350a6d0ce344c02782e0207574005c3b2aaa5077cTed Kremenekclass BugReporter; 448966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenekclass BugReporterContext; 45d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidisclass ExprEngine; 46cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekclass BugType; 471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 48cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 49cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// Interface for individual bug reports. 50cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 518966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek 52e7c4c4ccc6a51c82332382267b84e9d72f229b5eAnna Zaks/// This class provides an interface through which checkers can create 53e7c4c4ccc6a51c82332382267b84e9d72f229b5eAnna Zaks/// individual bug reports. 544a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramerclass BugReport : public llvm::ilist_node<BugReport> { 5576aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenekpublic: 56e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks class NodeResolver { 5799ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 58e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks public: 59e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual ~NodeResolver() {} 60e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual const ExplodedNode* 61e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks getOriginalNode(const ExplodedNode *N) = 0; 62e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks }; 63e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 64e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks typedef const SourceRange *ranges_iterator; 653bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose typedef SmallVector<BugReporterVisitor *, 8> VisitorList; 663bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose typedef VisitorList::iterator visitor_iterator; 677f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks typedef SmallVector<StringRef, 2> ExtraTextList; 68e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 697a9bb52171f962d51ab13c1e012d2236feb9558dTed Kremenekprotected: 70e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks friend class BugReporter; 71e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks friend class BugReportEquivClass; 72e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 73cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugType& BT; 7407189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek const Decl *DeclWithIssue; 75d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek std::string ShortDescription; 76cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek std::string Description; 77590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticLocation Location; 78ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks PathDiagnosticLocation UniqueingLocation; 7997bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks const Decl *UniqueingDecl; 8097bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks 81212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care const ExplodedNode *ErrorNode; 82e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks SmallVector<SourceRange, 4> Ranges; 837f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks ExtraTextList ExtraText; 8476aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 8576aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek typedef llvm::DenseSet<SymbolRef> Symbols; 8676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek typedef llvm::DenseSet<const MemRegion *> Regions; 8776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 88c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// A (stack of) a set of symbols that are registered with this 89c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// report as being "interesting", and thus used to help decide which 90c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// diagnostics to include when constructing the final path diagnostic. 91c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// The stack is largely used by BugReporter when generating PathDiagnostics 92c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// for multiple PathDiagnosticConsumers. 93cfa88f893915ceb8ae4ce2f17c46c24a4d67502fDmitri Gribenko SmallVector<Symbols *, 2> interestingSymbols; 94c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 95c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// A (stack of) set of regions that are registered with this report as being 9676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek /// "interesting", and thus used to help decide which diagnostics 9776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek /// to include when constructing the final path diagnostic. 98c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// The stack is largely used by BugReporter when generating PathDiagnostics 99c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// for multiple PathDiagnosticConsumers. 100cfa88f893915ceb8ae4ce2f17c46c24a4d67502fDmitri Gribenko SmallVector<Regions *, 2> interestingRegions; 1018e6431adab313e283a992698f6fc7afe62420999Anna Zaks 10280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks /// A set of location contexts that correspoind to call sites which should be 10380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks /// considered "interesting". 10480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks llvm::SmallSet<const LocationContext *, 2> InterestingLocationContexts; 10580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 1063bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// A set of custom visitors which generate "event" diagnostics at 1073bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// interesting points in the path. 1083bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose VisitorList Callbacks; 1093bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 1103bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// Used for ensuring the visitors are only added once. 1118e6431adab313e283a992698f6fc7afe62420999Anna Zaks llvm::FoldingSet<BugReporterVisitor> CallbacksSet; 112cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 1133bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// Used for clients to tell if the report's configuration has changed 1143bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// since the last time they checked. 1153bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose unsigned ConfigurationChangeToken; 116ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek 117ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// When set, this flag disables all callstack pruning from a diagnostic 118ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// path. This is useful for some reports that want maximum fidelty 119ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// when reporting an issue. 120ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek bool DoNotPrunePath; 1213bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 1228347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// Used to track unique reasons why a bug report might be invalid. 1238347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// 1248347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// \sa markInvalid 1258347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// \sa removeInvalidation 1268347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose typedef std::pair<const void *, const void *> InvalidationRecord; 1278347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 1288347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// If non-empty, this bug report is likely a false positive and should not be 1298347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// shown to the user. 1308347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// 1318347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// \sa markInvalid 1328347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// \sa removeInvalidation 1338347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose llvm::SmallSet<InvalidationRecord, 4> Invalidations; 1348347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 135c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekprivate: 136c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek // Used internally by BugReporter. 137c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek Symbols &getInterestingSymbols(); 138c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek Regions &getInterestingRegions(); 139c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 140c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek void lazyInitializeInterestingSets(); 141c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek void pushInterestingSymbolsAndRegions(); 142c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek void popInterestingSymbolsAndRegions(); 143c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 144e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zakspublic: 145686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugReport(BugType& bt, StringRef desc, const ExplodedNode *errornode) 14607189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek : BT(bt), DeclWithIssue(0), Description(desc), ErrorNode(errornode), 147ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek ConfigurationChangeToken(0), DoNotPrunePath(false) {} 1481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 149686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugReport(BugType& bt, StringRef shortDesc, StringRef desc, 150212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care const ExplodedNode *errornode) 15107189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek : BT(bt), DeclWithIssue(0), ShortDescription(shortDesc), Description(desc), 152ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek ErrorNode(errornode), ConfigurationChangeToken(0), 153ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek DoNotPrunePath(false) {} 154d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek 155590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks BugReport(BugType& bt, StringRef desc, PathDiagnosticLocation l) 15607189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek : BT(bt), DeclWithIssue(0), Description(desc), Location(l), ErrorNode(0), 157ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek ConfigurationChangeToken(0), 158ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek DoNotPrunePath(false) {} 159b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks 160ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// \brief Create a BugReport with a custom uniqueing location. 161ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// 162ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// The reports that have the same report location, description, bug type, and 163ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// ranges are uniqued - only one of the equivalent reports will be presented 164ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// to the user. This method allows to rest the location which should be used 165ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// for uniquing reports. For example, memory leaks checker, could set this to 166ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// the allocation site, rather then the location where the bug is reported. 167ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks BugReport(BugType& bt, StringRef desc, const ExplodedNode *errornode, 16897bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks PathDiagnosticLocation LocationToUnique, const Decl *DeclToUnique) 16907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek : BT(bt), DeclWithIssue(0), Description(desc), 17007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek UniqueingLocation(LocationToUnique), 17197bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks UniqueingDecl(DeclToUnique), 1728347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose ErrorNode(errornode), ConfigurationChangeToken(0), 1738347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose DoNotPrunePath(false) {} 174ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks 17550a6d0ce344c02782e0207574005c3b2aaa5077cTed Kremenek virtual ~BugReport(); 1761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 177cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek const BugType& getBugType() const { return BT; } 178cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugType& getBugType() { return BT; } 1791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1809c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *getErrorNode() const { return ErrorNode; } 1811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 182686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const StringRef getDescription() const { return Description; } 183d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek 1843a46f5fd1709f6df03bbb8b0abf84052dc0f39ffJordan Rose const StringRef getShortDescription(bool UseFallback = true) const { 1853a46f5fd1709f6df03bbb8b0abf84052dc0f39ffJordan Rose if (ShortDescription.empty() && UseFallback) 1863a46f5fd1709f6df03bbb8b0abf84052dc0f39ffJordan Rose return Description; 1873a46f5fd1709f6df03bbb8b0abf84052dc0f39ffJordan Rose return ShortDescription; 188d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek } 1891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 190ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// Indicates whether or not any path pruning should take place 191ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// when generating a PathDiagnostic from this BugReport. 192ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek bool shouldPrunePath() const { return !DoNotPrunePath; } 193ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek 194ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// Disable all path pruning when generating a PathDiagnostic. 195ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek void disablePathPruning() { DoNotPrunePath = true; } 196ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek 19776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek void markInteresting(SymbolRef sym); 19876aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek void markInteresting(const MemRegion *R); 19976aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek void markInteresting(SVal V); 20080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks void markInteresting(const LocationContext *LC); 20176aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 202c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek bool isInteresting(SymbolRef sym); 203c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek bool isInteresting(const MemRegion *R); 204c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek bool isInteresting(SVal V); 20580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks bool isInteresting(const LocationContext *LC); 2063bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 2073bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose unsigned getConfigurationChangeToken() const { 2083bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose return ConfigurationChangeToken; 2093bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose } 2108347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 2118347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// Returns whether or not this report should be considered valid. 2128347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// 2138347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// Invalid reports are those that have been classified as likely false 2148347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// positives after the fact. 2158347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose bool isValid() const { 2168347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose return Invalidations.empty(); 2178347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose } 2188347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 2198347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// Marks the current report as invalid, meaning that it is probably a false 2208347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// positive and should not be reported to the user. 2218347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// 2228347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// The \p Tag and \p Data arguments are intended to be opaque identifiers for 2238347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// this particular invalidation, where \p Tag represents the visitor 2248347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// responsible for invalidation, and \p Data represents the reason this 2258347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// visitor decided to invalidate the bug report. 2268347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// 2278347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// \sa removeInvalidation 2288347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose void markInvalid(const void *Tag, const void *Data) { 2298347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose Invalidations.insert(std::make_pair(Tag, Data)); 2308347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose } 2318347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose 2328347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// Reverses the effects of a previous invalidation. 2338347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// 2348347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// \sa markInvalid 2358347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose void removeInvalidation(const void *Tag, const void *Data) { 2368347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose Invalidations.erase(std::make_pair(Tag, Data)); 2378347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose } 23876aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 23907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek /// Return the canonical declaration, be it a method or class, where 24007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek /// this issue semantically occurred. 24107189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek const Decl *getDeclWithIssue() const; 24207189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek 24307189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek /// Specifically set the Decl where an issue occurred. This isn't necessary 24407189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek /// for BugReports that cover a path as it will be automatically inferred. 24507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void setDeclWithIssue(const Decl *declWithIssue) { 24607189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek DeclWithIssue = declWithIssue; 24707189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek } 24807189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek 249e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief This allows for addition of meta data to the diagnostic. 25038ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 25138ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// Currently, only the HTMLDiagnosticClient knows how to display it. 2527f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks void addExtraText(StringRef S) { 2537f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks ExtraText.push_back(S); 2547f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks } 2557f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks 2567f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks virtual const ExtraTextList &getExtraText() { 2577f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks return ExtraText; 258072192bcbb05a0fee7ec3061750b27e8d2004952Ted Kremenek } 2591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 26038ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Return the "definitive" location of the reported bug. 26138ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 262cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek /// While a bug can span an entire path, usually there is a specific 263fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner /// location that can be used to identify where the key issue occurred. 264cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek /// This location is used by clients rendering diagnostics. 265590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks virtual PathDiagnosticLocation getLocation(const SourceManager &SM) const; 2661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 26797bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks /// \brief Get the location on which the report should be uniqued. 26897bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks PathDiagnosticLocation getUniqueingLocation() const { 26997bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks return UniqueingLocation; 27097bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks } 27197bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks 27297bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks /// \brief Get the declaration containing the uniqueing location. 27397bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks const Decl *getUniqueingDecl() const { 27497bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks return UniqueingDecl; 27597bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks } 27697bfb558f69c09b01a5c1510f08dc91eb62329a7Anna Zaks 27723f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const Stmt *getStmt() const; 27823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 279e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Add a range to a bug report. 280e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// 281e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// Ranges are used to highlight regions of interest in the source code. 282e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// They should be at the same source code line as the BugReport location. 28314924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks /// By default, the source range of the statement corresponding to the error 28414924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks /// node will be used; add a single invalid range to specify absence of 28514924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks /// ranges. 286e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks void addRange(SourceRange R) { 28714924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks assert((R.isValid() || Ranges.empty()) && "Invalid range can only be used " 28814924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks "to specify that the report does not have a range."); 289e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks Ranges.push_back(R); 290e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks } 291640ccf071076e684713cc3c3276bb51982bff607Argyrios Kyrtzidis 292e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Get the SourceRanges associated with the report. 293e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual std::pair<ranges_iterator, ranges_iterator> getRanges(); 294e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 295e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Add custom or predefined bug report visitors to this report. 296e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// 297e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// The visitors should be used when the default trace is not sufficient. 298e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// For example, they allow constructing a more elaborate trace. 299e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \sa registerConditionVisitor(), registerTrackNullOrUndefValue(), 300e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// registerFindLastStore(), registerNilReceiverVisitor(), and 301e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// registerVarDeclsLastStore(). 30250bbc165b063155cc23c360deb7b865502e068e2Anna Zaks void addVisitor(BugReporterVisitor *visitor); 3038e6431adab313e283a992698f6fc7afe62420999Anna Zaks 3048e6431adab313e283a992698f6fc7afe62420999Anna Zaks /// Iterators through the custom diagnostic visitors. 3058e6431adab313e283a992698f6fc7afe62420999Anna Zaks visitor_iterator visitor_begin() { return Callbacks.begin(); } 3068e6431adab313e283a992698f6fc7afe62420999Anna Zaks visitor_iterator visitor_end() { return Callbacks.end(); } 3074522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks 3084522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks /// Profile to identify equivalent bug reports for error report coalescing. 3094522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks /// Reports are uniqued to ensure that we do not emit multiple diagnostics 3104522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks /// for each bug. 3114522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks virtual void Profile(llvm::FoldingSetNodeID& hash) const; 3126837faa083bebad39aa342f84c2b450fb6410eafTed Kremenek}; 313cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 3144a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer} // end ento namespace 3154a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer} // end clang namespace 3164a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer 3174a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramernamespace llvm { 3184a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer template<> struct ilist_traits<clang::ento::BugReport> 3194a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer : public ilist_default_traits<clang::ento::BugReport> { 3204a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer clang::ento::BugReport *createSentinel() const { 3214a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer return static_cast<clang::ento::BugReport *>(&Sentinel); 3224a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer } 3234a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer void destroySentinel(clang::ento::BugReport *) const {} 3244a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer 3254a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer clang::ento::BugReport *provideInitialHead() const { 3264a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer return createSentinel(); 3274a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer } 3284a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer clang::ento::BugReport *ensureHead(clang::ento::BugReport *) const { 3294a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer return createSentinel(); 3304a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer } 3314a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer private: 3324a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer mutable ilist_half_node<clang::ento::BugReport> Sentinel; 3334a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer }; 3344a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer} 3354a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer 3364a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramernamespace clang { 3374a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramernamespace ento { 3384a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer 339cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 340cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// BugTypes (collections of related reports). 341cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 3421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 343cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekclass BugReportEquivClass : public llvm::FoldingSetNode { 34438ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// List of *owned* BugReport objects. 3454a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer llvm::ilist<BugReport> Reports; 3461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 347cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek friend class BugReporter; 348cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void AddReport(BugReport* R) { Reports.push_back(R); } 349cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekpublic: 350cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugReportEquivClass(BugReport* R) { Reports.push_back(R); } 351cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek ~BugReportEquivClass(); 352cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 353cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void Profile(llvm::FoldingSetNodeID& ID) const { 354cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek assert(!Reports.empty()); 3554a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer Reports.front().Profile(ID); 356cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek } 357cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 3584a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer typedef llvm::ilist<BugReport>::iterator iterator; 3594a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer typedef llvm::ilist<BugReport>::const_iterator const_iterator; 3601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3614a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer iterator begin() { return Reports.begin(); } 3624a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer iterator end() { return Reports.end(); } 3631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3644a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer const_iterator begin() const { return Reports.begin(); } 3654a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer const_iterator end() const { return Reports.end(); } 366cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek}; 3671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 368cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 369cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// BugReporter and friends. 370cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 371cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 372c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekclass BugReporterData { 373c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekpublic: 374c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~BugReporterData(); 375d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie virtual DiagnosticsEngine& getDiagnostic() = 0; 376c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek virtual ArrayRef<PathDiagnosticConsumer*> getPathDiagnosticConsumers() = 0; 3779c378f705405d37f49795d5e915989de774fe11fTed Kremenek virtual ASTContext &getASTContext() = 0; 378c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual SourceManager& getSourceManager() = 0; 379d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks virtual AnalyzerOptions& getAnalyzerOptions() = 0; 380c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek}; 3811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 38238ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// BugReporter is a utility class for generating PathDiagnostics for analysis. 38338ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// It collects the BugReports and BugTypes and knows how to generate 38438ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// and flush the corresponding diagnostics. 38561f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekclass BugReporter { 386c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekpublic: 387c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek enum Kind { BaseBRKind, GRBugReporterKind }; 388c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 389cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekprivate: 390cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek typedef llvm::ImmutableSet<BugType*> BugTypesTy; 391cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugTypesTy::Factory F; 392cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugTypesTy BugTypes; 393cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 3941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const Kind kind; 395c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek BugReporterData& D; 3961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 39738ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// Generate and flush the diagnostics for the given bug report. 398cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void FlushReport(BugReportEquivClass& EQ); 399cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 400c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// Generate and flush the diagnostics for the given bug report 401c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// and PathDiagnosticConsumer. 402c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek void FlushReport(BugReport *exampleReport, 403c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticConsumer &PD, 404c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<BugReport*> BugReports); 405c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 40638ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// The set of bug reports tracked by the BugReporter. 407404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::FoldingSet<BugReportEquivClass> EQClasses; 4083b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks /// A vector of BugReports for tracking the allocated pointers and cleanup. 4093b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks std::vector<BugReportEquivClass *> EQClassesVector; 410404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 411cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekprotected: 4123baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugReporter(BugReporterData& d, Kind k) : BugTypes(F.getEmptySet()), kind(k), 413212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care D(d) {} 414cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 41561f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekpublic: 4163baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugReporter(BugReporterData& d) : BugTypes(F.getEmptySet()), kind(BaseBRKind), 417212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care D(d) {} 418c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~BugReporter(); 4191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 42038ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Generate and flush diagnostics for all bug reports. 421cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void FlushReports(); 4221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 423c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek Kind getKind() const { return kind; } 4241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 425d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine& getDiagnostic() { 426c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return D.getDiagnostic(); 427c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 4281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 429c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<PathDiagnosticConsumer*> getPathDiagnosticConsumers() { 430c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek return D.getPathDiagnosticConsumers(); 431c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 4321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 43338ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Iterator over the set of BugTypes tracked by the BugReporter. 4343aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek typedef BugTypesTy::iterator iterator; 4353aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek iterator begin() { return BugTypes.begin(); } 4363aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek iterator end() { return BugTypes.end(); } 4371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 43838ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Iterator over the set of BugReports tracked by the BugReporter. 439404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis typedef llvm::FoldingSet<BugReportEquivClass>::iterator EQClasses_iterator; 440404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis EQClasses_iterator EQClasses_begin() { return EQClasses.begin(); } 441404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis EQClasses_iterator EQClasses_end() { return EQClasses.end(); } 442404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 4439c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &getContext() { return D.getASTContext(); } 4441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 445cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek SourceManager& getSourceManager() { return D.getSourceManager(); } 4461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 447d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks AnalyzerOptions& getAnalyzerOptions() { return D.getAnalyzerOptions(); } 448d95b70175646829c26344d5f0bda1ec3009f2a5bAnna Zaks 4498347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose virtual bool generatePathDiagnostic(PathDiagnostic& pathDiagnostic, 450c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticConsumer &PC, 4518347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose ArrayRef<BugReport *> &bugReports) { 4528347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose return true; 4538347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose } 45461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 455afa7cae15b117c4b75794c6c32424953d94b4359Jordan Rose bool RemoveUnneededCalls(PathPieces &pieces, BugReport *R); 45680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 457cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void Register(BugType *BT); 4581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 45938ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Add the given report to the set of reports tracked by BugReporter. 46038ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 46138ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// The reports are usually generated by the checkers. Further, they are 46238ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// folded based on the profile value, which is done to coalesce similar 46338ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// reports. 464785950e59424dca7ce0081bebf13c0acd2c4fff6Jordan Rose void emitReport(BugReport *R); 4651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 46607189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void EmitBasicReport(const Decl *DeclWithIssue, 46707189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek StringRef BugName, StringRef BugCategory, 468590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef BugStr, PathDiagnosticLocation Loc, 4698c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek SourceRange* RangeBeg, unsigned NumRanges); 4701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 47107189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void EmitBasicReport(const Decl *DeclWithIssue, 47207189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek StringRef BugName, StringRef BugCategory, 473590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef BugStr, PathDiagnosticLocation Loc) { 47407189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek EmitBasicReport(DeclWithIssue, BugName, BugCategory, BugStr, Loc, 0, 0); 47562059e809596a419e6fc3e751b2f0b57b7cc51e7Ted Kremenek } 4761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 47707189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void EmitBasicReport(const Decl *DeclWithIssue, 47807189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek StringRef BugName, StringRef Category, 479590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef BugStr, PathDiagnosticLocation Loc, 480f0171732efb4647772ad2a45c0f31978b0e34f71Benjamin Kramer SourceRange R) { 48107189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek EmitBasicReport(DeclWithIssue, BugName, Category, BugStr, Loc, &R, 1); 4828c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek } 4831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 484404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidisprivate: 485404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::StringMap<BugType *> StrBugTypes; 486404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 487404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis /// \brief Returns a BugType that is associated with the given name and 488404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis /// category. 489686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugType *getBugTypeForName(StringRef name, StringRef category); 490c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek}; 4918966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek 492cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// FIXME: Get rid of GRBugReporter. It's the wrong abstraction. 493c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekclass GRBugReporter : public BugReporter { 494d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis ExprEngine& Eng; 4951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 496d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis GRBugReporter(BugReporterData& d, ExprEngine& eng) 497c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek : BugReporter(d, GRBugReporterKind), Eng(eng) {} 4981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 499c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~GRBugReporter(); 5001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 501cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getEngine - Return the analysis engine used to analyze a given 502cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// function or method. 503d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis ExprEngine &getEngine() { return Eng; } 504c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 505cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getGraph - Get the exploded graph created by the analysis engine 506cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// for the analyzed method or function. 50738b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu ExplodedGraph &getGraph(); 5081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 509cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getStateManager - Return the state manager used by the analysis 510cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// engine. 51118c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ProgramStateManager &getStateManager(); 5121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5138347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// Generates a path corresponding to one of the given bug reports. 5148347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// 5158347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// Which report is used for path generation is not specified. The 5168347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// bug reporter will try to pick the shortest path, but this is not 5178347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// guaranteed. 5188347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// 5198347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// \return True if the report was valid and a path was generated, 5208347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose /// false if the reports should be considered invalid. 5218347d3d45e6f128bba19821f0d2f54cadd4d49bbJordan Rose virtual bool generatePathDiagnostic(PathDiagnostic &PD, 522c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticConsumer &PC, 523c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<BugReport*> &bugReports); 524c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 525cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// classof - Used by isa<>, cast<>, and dyn_cast<>. 526c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek static bool classof(const BugReporter* R) { 527c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return R->getKind() == GRBugReporterKind; 528c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 52961f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek}; 5301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5318966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenekclass BugReporterContext { 53299ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 5338966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek GRBugReporter &BR; 5348966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenekpublic: 5358e6431adab313e283a992698f6fc7afe62420999Anna Zaks BugReporterContext(GRBugReporter& br) : BR(br) {} 5361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5378e6431adab313e283a992698f6fc7afe62420999Anna Zaks virtual ~BugReporterContext() {} 5381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump GRBugReporter& getBugReporter() { return BR; } 5401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 54138b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu ExplodedGraph &getGraph() { return BR.getGraph(); } 5421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 54318c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ProgramStateManager& getStateManager() { 5448966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getStateManager(); 5458966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 5461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 547c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek SValBuilder& getSValBuilder() { 548c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek return getStateManager().getSValBuilder(); 549dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 5501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5519c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &getASTContext() { 5528966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getContext(); 5538966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 5541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5558966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek SourceManager& getSourceManager() { 5568966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getSourceManager(); 5578966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 5581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump virtual BugReport::NodeResolver& getNodeResolver() = 0; 5608966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek}; 561e207558e9dbed963eebf5cf31fdb02616f1545a3Ted Kremenek 5625a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis} // end GR namespace 5635a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 56461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek} // end clang namespace 56561f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 56661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek#endif 567