BugReporter.h revision 80de487e03dd0f44e4572e2122ebc1aa6a3961f5
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" 221b431023814196f87515a540ebcb9e9f1a9176a1Ted Kremenek#include "llvm/ADT/FoldingSet.h" 234a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer#include "llvm/ADT/ilist.h" 244a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer#include "llvm/ADT/ilist_node.h" 251b431023814196f87515a540ebcb9e9f1a9176a1Ted Kremenek#include "llvm/ADT/ImmutableSet.h" 2676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek#include "llvm/ADT/DenseSet.h" 2780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks#include "llvm/ADT/SmallSet.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; 78212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care const ExplodedNode *ErrorNode; 79e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks SmallVector<SourceRange, 4> Ranges; 807f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks ExtraTextList ExtraText; 8176aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 8276aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek typedef llvm::DenseSet<SymbolRef> Symbols; 8376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek typedef llvm::DenseSet<const MemRegion *> Regions; 8476aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 85c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// A (stack of) a set of symbols that are registered with this 86c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// report as being "interesting", and thus used to help decide which 87c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// diagnostics to include when constructing the final path diagnostic. 88c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// The stack is largely used by BugReporter when generating PathDiagnostics 89c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// for multiple PathDiagnosticConsumers. 90c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek llvm::SmallVector<Symbols *, 2> interestingSymbols; 91c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 92c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// A (stack of) set of regions that are registered with this report as being 9376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek /// "interesting", and thus used to help decide which diagnostics 9476aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek /// to include when constructing the final path diagnostic. 95c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// The stack is largely used by BugReporter when generating PathDiagnostics 96c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// for multiple PathDiagnosticConsumers. 97c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek llvm::SmallVector<Regions *, 2> interestingRegions; 988e6431adab313e283a992698f6fc7afe62420999Anna Zaks 9980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks /// A set of location contexts that correspoind to call sites which should be 10080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks /// considered "interesting". 10180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks llvm::SmallSet<const LocationContext *, 2> InterestingLocationContexts; 10280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 1033bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// A set of custom visitors which generate "event" diagnostics at 1043bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// interesting points in the path. 1053bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose VisitorList Callbacks; 1063bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 1073bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// Used for ensuring the visitors are only added once. 1088e6431adab313e283a992698f6fc7afe62420999Anna Zaks llvm::FoldingSet<BugReporterVisitor> CallbacksSet; 109cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 1103bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// Used for clients to tell if the report's configuration has changed 1113bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// since the last time they checked. 1123bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose unsigned ConfigurationChangeToken; 113ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek 114ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// When set, this flag disables all callstack pruning from a diagnostic 115ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// path. This is useful for some reports that want maximum fidelty 116ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// when reporting an issue. 117ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek bool DoNotPrunePath; 1183bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 119c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekprivate: 120c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek // Used internally by BugReporter. 121c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek Symbols &getInterestingSymbols(); 122c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek Regions &getInterestingRegions(); 123c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 124c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek void lazyInitializeInterestingSets(); 125c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek void pushInterestingSymbolsAndRegions(); 126c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek void popInterestingSymbolsAndRegions(); 127c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 128e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zakspublic: 129686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugReport(BugType& bt, StringRef desc, const ExplodedNode *errornode) 13007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek : BT(bt), DeclWithIssue(0), Description(desc), ErrorNode(errornode), 131ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek ConfigurationChangeToken(0), DoNotPrunePath(false) {} 1321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 133686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugReport(BugType& bt, StringRef shortDesc, StringRef desc, 134212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care const ExplodedNode *errornode) 13507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek : BT(bt), DeclWithIssue(0), ShortDescription(shortDesc), Description(desc), 136ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek ErrorNode(errornode), ConfigurationChangeToken(0), 137ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek DoNotPrunePath(false) {} 138d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek 139590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks BugReport(BugType& bt, StringRef desc, PathDiagnosticLocation l) 14007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek : BT(bt), DeclWithIssue(0), Description(desc), Location(l), ErrorNode(0), 141ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek ConfigurationChangeToken(0), 142ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek DoNotPrunePath(false) {} 143b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks 144ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// \brief Create a BugReport with a custom uniqueing location. 145ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// 146ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// The reports that have the same report location, description, bug type, and 147ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// ranges are uniqued - only one of the equivalent reports will be presented 148ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// to the user. This method allows to rest the location which should be used 149ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// for uniquing reports. For example, memory leaks checker, could set this to 150ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// the allocation site, rather then the location where the bug is reported. 151ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks BugReport(BugType& bt, StringRef desc, const ExplodedNode *errornode, 152ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks PathDiagnosticLocation LocationToUnique) 15307189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek : BT(bt), DeclWithIssue(0), Description(desc), 15407189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek UniqueingLocation(LocationToUnique), 1553bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ErrorNode(errornode), ConfigurationChangeToken(0) {} 156ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks 15750a6d0ce344c02782e0207574005c3b2aaa5077cTed Kremenek virtual ~BugReport(); 1581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 159cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek const BugType& getBugType() const { return BT; } 160cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugType& getBugType() { return BT; } 1611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1629c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *getErrorNode() const { return ErrorNode; } 1631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 164686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const StringRef getDescription() const { return Description; } 165d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek 166686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const StringRef getShortDescription() const { 167d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek return ShortDescription.empty() ? Description : ShortDescription; 168d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek } 1691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 170ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// Indicates whether or not any path pruning should take place 171ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// when generating a PathDiagnostic from this BugReport. 172ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek bool shouldPrunePath() const { return !DoNotPrunePath; } 173ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek 174ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// Disable all path pruning when generating a PathDiagnostic. 175ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek void disablePathPruning() { DoNotPrunePath = true; } 176ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek 17776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek void markInteresting(SymbolRef sym); 17876aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek void markInteresting(const MemRegion *R); 17976aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek void markInteresting(SVal V); 18080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks void markInteresting(const LocationContext *LC); 18176aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 182c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek bool isInteresting(SymbolRef sym); 183c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek bool isInteresting(const MemRegion *R); 184c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek bool isInteresting(SVal V); 18580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks bool isInteresting(const LocationContext *LC); 1863bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 1873bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose unsigned getConfigurationChangeToken() const { 1883bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose return ConfigurationChangeToken; 1893bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose } 19076aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 19107189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek /// Return the canonical declaration, be it a method or class, where 19207189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek /// this issue semantically occurred. 19307189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek const Decl *getDeclWithIssue() const; 19407189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek 19507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek /// Specifically set the Decl where an issue occurred. This isn't necessary 19607189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek /// for BugReports that cover a path as it will be automatically inferred. 19707189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void setDeclWithIssue(const Decl *declWithIssue) { 19807189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek DeclWithIssue = declWithIssue; 19907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek } 20007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek 201e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief This allows for addition of meta data to the diagnostic. 20238ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 20338ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// Currently, only the HTMLDiagnosticClient knows how to display it. 2047f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks void addExtraText(StringRef S) { 2057f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks ExtraText.push_back(S); 2067f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks } 2077f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks 2087f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks virtual const ExtraTextList &getExtraText() { 2097f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks return ExtraText; 210072192bcbb05a0fee7ec3061750b27e8d2004952Ted Kremenek } 2111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21238ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Return the "definitive" location of the reported bug. 21338ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 214cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek /// While a bug can span an entire path, usually there is a specific 215fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner /// location that can be used to identify where the key issue occurred. 216cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek /// This location is used by clients rendering diagnostics. 217590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks virtual PathDiagnosticLocation getLocation(const SourceManager &SM) const; 2181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const Stmt *getStmt() const; 22023f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 221e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Add a range to a bug report. 222e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// 223e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// Ranges are used to highlight regions of interest in the source code. 224e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// They should be at the same source code line as the BugReport location. 22514924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks /// By default, the source range of the statement corresponding to the error 22614924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks /// node will be used; add a single invalid range to specify absence of 22714924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks /// ranges. 228e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks void addRange(SourceRange R) { 22914924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks assert((R.isValid() || Ranges.empty()) && "Invalid range can only be used " 23014924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks "to specify that the report does not have a range."); 231e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks Ranges.push_back(R); 232e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks } 233640ccf071076e684713cc3c3276bb51982bff607Argyrios Kyrtzidis 234e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Get the SourceRanges associated with the report. 235e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual std::pair<ranges_iterator, ranges_iterator> getRanges(); 236e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 237e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Add custom or predefined bug report visitors to this report. 238e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// 239e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// The visitors should be used when the default trace is not sufficient. 240e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// For example, they allow constructing a more elaborate trace. 241e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \sa registerConditionVisitor(), registerTrackNullOrUndefValue(), 242e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// registerFindLastStore(), registerNilReceiverVisitor(), and 243e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// registerVarDeclsLastStore(). 24450bbc165b063155cc23c360deb7b865502e068e2Anna Zaks void addVisitor(BugReporterVisitor *visitor); 2458e6431adab313e283a992698f6fc7afe62420999Anna Zaks 2468e6431adab313e283a992698f6fc7afe62420999Anna Zaks /// Iterators through the custom diagnostic visitors. 2478e6431adab313e283a992698f6fc7afe62420999Anna Zaks visitor_iterator visitor_begin() { return Callbacks.begin(); } 2488e6431adab313e283a992698f6fc7afe62420999Anna Zaks visitor_iterator visitor_end() { return Callbacks.end(); } 2494522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks 2504522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks /// Profile to identify equivalent bug reports for error report coalescing. 2514522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks /// Reports are uniqued to ensure that we do not emit multiple diagnostics 2524522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks /// for each bug. 2534522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks virtual void Profile(llvm::FoldingSetNodeID& hash) const; 2546837faa083bebad39aa342f84c2b450fb6410eafTed Kremenek}; 255cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 2564a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer} // end ento namespace 2574a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer} // end clang namespace 2584a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer 2594a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramernamespace llvm { 2604a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer template<> struct ilist_traits<clang::ento::BugReport> 2614a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer : public ilist_default_traits<clang::ento::BugReport> { 2624a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer clang::ento::BugReport *createSentinel() const { 2634a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer return static_cast<clang::ento::BugReport *>(&Sentinel); 2644a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer } 2654a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer void destroySentinel(clang::ento::BugReport *) const {} 2664a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer 2674a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer clang::ento::BugReport *provideInitialHead() const { 2684a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer return createSentinel(); 2694a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer } 2704a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer clang::ento::BugReport *ensureHead(clang::ento::BugReport *) const { 2714a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer return createSentinel(); 2724a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer } 2734a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer private: 2744a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer mutable ilist_half_node<clang::ento::BugReport> Sentinel; 2754a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer }; 2764a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer} 2774a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer 2784a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramernamespace clang { 2794a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramernamespace ento { 2804a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer 281cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 282cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// BugTypes (collections of related reports). 283cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 2841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 285cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekclass BugReportEquivClass : public llvm::FoldingSetNode { 28638ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// List of *owned* BugReport objects. 2874a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer llvm::ilist<BugReport> Reports; 2881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 289cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek friend class BugReporter; 290cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void AddReport(BugReport* R) { Reports.push_back(R); } 291cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekpublic: 292cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugReportEquivClass(BugReport* R) { Reports.push_back(R); } 293cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek ~BugReportEquivClass(); 294cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 295cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void Profile(llvm::FoldingSetNodeID& ID) const { 296cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek assert(!Reports.empty()); 2974a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer Reports.front().Profile(ID); 298cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek } 299cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 3004a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer typedef llvm::ilist<BugReport>::iterator iterator; 3014a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer typedef llvm::ilist<BugReport>::const_iterator const_iterator; 3021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3034a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer iterator begin() { return Reports.begin(); } 3044a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer iterator end() { return Reports.end(); } 3051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3064a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer const_iterator begin() const { return Reports.begin(); } 3074a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer const_iterator end() const { return Reports.end(); } 308cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek}; 3091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 310cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 311cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// BugReporter and friends. 312cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 313cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 314c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekclass BugReporterData { 315c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekpublic: 316c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~BugReporterData(); 317d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie virtual DiagnosticsEngine& getDiagnostic() = 0; 318c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek virtual ArrayRef<PathDiagnosticConsumer*> getPathDiagnosticConsumers() = 0; 3199c378f705405d37f49795d5e915989de774fe11fTed Kremenek virtual ASTContext &getASTContext() = 0; 320c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual SourceManager& getSourceManager() = 0; 321c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek}; 3221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 32338ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// BugReporter is a utility class for generating PathDiagnostics for analysis. 32438ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// It collects the BugReports and BugTypes and knows how to generate 32538ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// and flush the corresponding diagnostics. 32661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekclass BugReporter { 327c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekpublic: 328c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek enum Kind { BaseBRKind, GRBugReporterKind }; 329c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 330cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekprivate: 331cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek typedef llvm::ImmutableSet<BugType*> BugTypesTy; 332cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugTypesTy::Factory F; 333cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugTypesTy BugTypes; 334cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 3351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const Kind kind; 336c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek BugReporterData& D; 3371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 33838ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// Generate and flush the diagnostics for the given bug report. 339cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void FlushReport(BugReportEquivClass& EQ); 340cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 341c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// Generate and flush the diagnostics for the given bug report 342c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// and PathDiagnosticConsumer. 343c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek void FlushReport(BugReport *exampleReport, 344c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticConsumer &PD, 345c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<BugReport*> BugReports); 346c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 34738ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// The set of bug reports tracked by the BugReporter. 348404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::FoldingSet<BugReportEquivClass> EQClasses; 3493b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks /// A vector of BugReports for tracking the allocated pointers and cleanup. 3503b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks std::vector<BugReportEquivClass *> EQClassesVector; 351404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 35280de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks /// A map from PathDiagnosticPiece to the LocationContext of the inlined 35380de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks /// function call it represents. 35480de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks llvm::DenseMap<const PathDiagnosticCallPiece*, 35580de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const LocationContext*> LocationContextMap; 35680de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 357cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekprotected: 3583baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugReporter(BugReporterData& d, Kind k) : BugTypes(F.getEmptySet()), kind(k), 359212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care D(d) {} 360cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 36161f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekpublic: 3623baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugReporter(BugReporterData& d) : BugTypes(F.getEmptySet()), kind(BaseBRKind), 363212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care D(d) {} 364c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~BugReporter(); 3651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 36638ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Generate and flush diagnostics for all bug reports. 367cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void FlushReports(); 3681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 369c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek Kind getKind() const { return kind; } 3701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 371d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine& getDiagnostic() { 372c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return D.getDiagnostic(); 373c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 3741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 375c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<PathDiagnosticConsumer*> getPathDiagnosticConsumers() { 376c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek return D.getPathDiagnosticConsumers(); 377c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 3781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 37938ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Iterator over the set of BugTypes tracked by the BugReporter. 3803aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek typedef BugTypesTy::iterator iterator; 3813aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek iterator begin() { return BugTypes.begin(); } 3823aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek iterator end() { return BugTypes.end(); } 3831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 38438ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Iterator over the set of BugReports tracked by the BugReporter. 385404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis typedef llvm::FoldingSet<BugReportEquivClass>::iterator EQClasses_iterator; 386404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis EQClasses_iterator EQClasses_begin() { return EQClasses.begin(); } 387404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis EQClasses_iterator EQClasses_end() { return EQClasses.end(); } 388404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 3899c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &getContext() { return D.getASTContext(); } 3901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 391cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek SourceManager& getSourceManager() { return D.getSourceManager(); } 3921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 39340406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek virtual void GeneratePathDiagnostic(PathDiagnostic& pathDiagnostic, 394c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticConsumer &PC, 395c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<BugReport *> &bugReports) {} 39661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 39780de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks bool RemoveUneededCalls(PathPieces &pieces, BugReport *R); 39880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks 399cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void Register(BugType *BT); 4001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 40138ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Add the given report to the set of reports tracked by BugReporter. 40238ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 40338ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// The reports are usually generated by the checkers. Further, they are 40438ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// folded based on the profile value, which is done to coalesce similar 40538ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// reports. 406cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void EmitReport(BugReport *R); 4071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 40807189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void EmitBasicReport(const Decl *DeclWithIssue, 40907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek StringRef BugName, StringRef BugCategory, 410590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef BugStr, PathDiagnosticLocation Loc, 4118c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek SourceRange* RangeBeg, unsigned NumRanges); 4121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 41307189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void EmitBasicReport(const Decl *DeclWithIssue, 41407189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek StringRef BugName, StringRef BugCategory, 415590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef BugStr, PathDiagnosticLocation Loc) { 41607189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek EmitBasicReport(DeclWithIssue, BugName, BugCategory, BugStr, Loc, 0, 0); 41762059e809596a419e6fc3e751b2f0b57b7cc51e7Ted Kremenek } 4181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 41907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void EmitBasicReport(const Decl *DeclWithIssue, 42007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek StringRef BugName, StringRef Category, 421590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef BugStr, PathDiagnosticLocation Loc, 422f0171732efb4647772ad2a45c0f31978b0e34f71Benjamin Kramer SourceRange R) { 42307189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek EmitBasicReport(DeclWithIssue, BugName, Category, BugStr, Loc, &R, 1); 4248c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek } 4251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 426c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek static bool classof(const BugReporter* R) { return true; } 427404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 42880de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks void addCallPieceLocationContextPair(const PathDiagnosticCallPiece *C, 42980de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks const LocationContext *LC) { 43080de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks LocationContextMap[C] = LC; 43180de487e03dd0f44e4572e2122ebc1aa6a3961f5Anna Zaks } 432404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidisprivate: 433404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::StringMap<BugType *> StrBugTypes; 434404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 435404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis /// \brief Returns a BugType that is associated with the given name and 436404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis /// category. 437686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugType *getBugTypeForName(StringRef name, StringRef category); 438c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek}; 4398966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek 440cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// FIXME: Get rid of GRBugReporter. It's the wrong abstraction. 441c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekclass GRBugReporter : public BugReporter { 442d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis ExprEngine& Eng; 4431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 444d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis GRBugReporter(BugReporterData& d, ExprEngine& eng) 445c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek : BugReporter(d, GRBugReporterKind), Eng(eng) {} 4461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 447c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~GRBugReporter(); 4481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 449cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getEngine - Return the analysis engine used to analyze a given 450cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// function or method. 451d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis ExprEngine &getEngine() { return Eng; } 452c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 453cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getGraph - Get the exploded graph created by the analysis engine 454cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// for the analyzed method or function. 45538b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu ExplodedGraph &getGraph(); 4561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 457cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getStateManager - Return the state manager used by the analysis 458cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// engine. 45918c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ProgramStateManager &getStateManager(); 4601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 46140406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek virtual void GeneratePathDiagnostic(PathDiagnostic &pathDiagnostic, 462c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticConsumer &PC, 463c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<BugReport*> &bugReports); 464c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 465cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// classof - Used by isa<>, cast<>, and dyn_cast<>. 466c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek static bool classof(const BugReporter* R) { 467c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return R->getKind() == GRBugReporterKind; 468c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 46961f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek}; 4701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4718966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenekclass BugReporterContext { 47299ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 4738966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek GRBugReporter &BR; 4748966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenekpublic: 4758e6431adab313e283a992698f6fc7afe62420999Anna Zaks BugReporterContext(GRBugReporter& br) : BR(br) {} 4761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4778e6431adab313e283a992698f6fc7afe62420999Anna Zaks virtual ~BugReporterContext() {} 4781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump GRBugReporter& getBugReporter() { return BR; } 4801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 48138b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu ExplodedGraph &getGraph() { return BR.getGraph(); } 4821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 48318c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ProgramStateManager& getStateManager() { 4848966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getStateManager(); 4858966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 4861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 487c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek SValBuilder& getSValBuilder() { 488c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek return getStateManager().getSValBuilder(); 489dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 4901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4919c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &getASTContext() { 4928966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getContext(); 4938966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 4941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4958966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek SourceManager& getSourceManager() { 4968966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getSourceManager(); 4978966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 4981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump virtual BugReport::NodeResolver& getNodeResolver() = 0; 5008966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek}; 501e207558e9dbed963eebf5cf31fdb02616f1545a3Ted Kremenek 5025a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis} // end GR namespace 5035a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 50461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek} // end clang namespace 50561f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 50661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek#endif 507