BugReporter.h revision 07189521a15d9c088216b943649cb9fe231cbb57
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" 27e207558e9dbed963eebf5cf31fdb02616f1545a3Ted Kremenek 2861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremeneknamespace clang { 291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 305a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidisclass ASTContext; 31d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieclass DiagnosticsEngine; 325a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidisclass Stmt; 335a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidisclass ParentMap; 345a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 359ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremeneknamespace ento { 365a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 3761f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekclass PathDiagnostic; 385e2d2c2ee3cf410643e0f9a5701708e51409d973Benjamin Kramerclass ExplodedNode; 395e2d2c2ee3cf410643e0f9a5701708e51409d973Benjamin Kramerclass ExplodedGraph; 408e6431adab313e283a992698f6fc7afe62420999Anna Zaksclass BugReport; 4150a6d0ce344c02782e0207574005c3b2aaa5077cTed Kremenekclass BugReporter; 428966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenekclass BugReporterContext; 43d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidisclass ExprEngine; 44cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekclass BugType; 451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 46cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 47cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// Interface for individual bug reports. 48cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 498966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek 50e7c4c4ccc6a51c82332382267b84e9d72f229b5eAnna Zaks/// This class provides an interface through which checkers can create 51e7c4c4ccc6a51c82332382267b84e9d72f229b5eAnna Zaks/// individual bug reports. 524a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramerclass BugReport : public llvm::ilist_node<BugReport> { 5376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenekpublic: 54e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks class NodeResolver { 5599ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 56e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks public: 57e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual ~NodeResolver() {} 58e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual const ExplodedNode* 59e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks getOriginalNode(const ExplodedNode *N) = 0; 60e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks }; 61e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 62e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks typedef const SourceRange *ranges_iterator; 633bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose typedef SmallVector<BugReporterVisitor *, 8> VisitorList; 643bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose typedef VisitorList::iterator visitor_iterator; 657f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks typedef SmallVector<StringRef, 2> ExtraTextList; 66e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 677a9bb52171f962d51ab13c1e012d2236feb9558dTed Kremenekprotected: 68e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks friend class BugReporter; 69e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks friend class BugReportEquivClass; 70e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 71cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugType& BT; 7207189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek const Decl *DeclWithIssue; 73d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek std::string ShortDescription; 74cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek std::string Description; 75590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticLocation Location; 76ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks PathDiagnosticLocation UniqueingLocation; 77212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care const ExplodedNode *ErrorNode; 78e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks SmallVector<SourceRange, 4> Ranges; 797f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks ExtraTextList ExtraText; 8076aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 8176aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek typedef llvm::DenseSet<SymbolRef> Symbols; 8276aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek typedef llvm::DenseSet<const MemRegion *> Regions; 8376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 8476aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek /// A set of symbols that are registered with this report as being 8576aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek /// "interesting", and thus used to help decide which diagnostics 8676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek /// to include when constructing the final path diagnostic. 8776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek Symbols interestingSymbols; 8876aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 8976aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek /// A set of regions that are registered with this report as being 9076aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek /// "interesting", and thus used to help decide which diagnostics 9176aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek /// to include when constructing the final path diagnostic. 9276aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek Regions interestingRegions; 938e6431adab313e283a992698f6fc7afe62420999Anna Zaks 943bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// A set of custom visitors which generate "event" diagnostics at 953bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// interesting points in the path. 963bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose VisitorList Callbacks; 973bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 983bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// Used for ensuring the visitors are only added once. 998e6431adab313e283a992698f6fc7afe62420999Anna Zaks llvm::FoldingSet<BugReporterVisitor> CallbacksSet; 100cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 1013bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// Used for clients to tell if the report's configuration has changed 1023bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// since the last time they checked. 1033bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose unsigned ConfigurationChangeToken; 1043bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 105e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zakspublic: 106686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugReport(BugType& bt, StringRef desc, const ExplodedNode *errornode) 10707189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek : BT(bt), DeclWithIssue(0), Description(desc), ErrorNode(errornode), 1083bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ConfigurationChangeToken(0) {} 1091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 110686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugReport(BugType& bt, StringRef shortDesc, StringRef desc, 111212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care const ExplodedNode *errornode) 11207189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek : BT(bt), DeclWithIssue(0), ShortDescription(shortDesc), Description(desc), 1133bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ErrorNode(errornode), ConfigurationChangeToken(0) {} 114d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek 115590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks BugReport(BugType& bt, StringRef desc, PathDiagnosticLocation l) 11607189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek : BT(bt), DeclWithIssue(0), Description(desc), Location(l), ErrorNode(0), 1173bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ConfigurationChangeToken(0) {} 118b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks 119ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// \brief Create a BugReport with a custom uniqueing location. 120ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// 121ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// The reports that have the same report location, description, bug type, and 122ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// ranges are uniqued - only one of the equivalent reports will be presented 123ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// to the user. This method allows to rest the location which should be used 124ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// for uniquing reports. For example, memory leaks checker, could set this to 125ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// the allocation site, rather then the location where the bug is reported. 126ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks BugReport(BugType& bt, StringRef desc, const ExplodedNode *errornode, 127ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks PathDiagnosticLocation LocationToUnique) 12807189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek : BT(bt), DeclWithIssue(0), Description(desc), 12907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek UniqueingLocation(LocationToUnique), 1303bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ErrorNode(errornode), ConfigurationChangeToken(0) {} 131ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks 13250a6d0ce344c02782e0207574005c3b2aaa5077cTed Kremenek virtual ~BugReport(); 1331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 134cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek const BugType& getBugType() const { return BT; } 135cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugType& getBugType() { return BT; } 1361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1379c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *getErrorNode() const { return ErrorNode; } 1381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 139686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const StringRef getDescription() const { return Description; } 140d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek 141686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const StringRef getShortDescription() const { 142d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek return ShortDescription.empty() ? Description : ShortDescription; 143d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek } 1441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14576aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek void markInteresting(SymbolRef sym); 14676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek void markInteresting(const MemRegion *R); 14776aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek void markInteresting(SVal V); 14876aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 14976aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek bool isInteresting(SymbolRef sym) const; 15076aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek bool isInteresting(const MemRegion *R) const; 15176aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek bool isInteresting(SVal V) const; 1523bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 1533bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose unsigned getConfigurationChangeToken() const { 1543bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose return ConfigurationChangeToken; 1553bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose } 15676aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 15707189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek /// Return the canonical declaration, be it a method or class, where 15807189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek /// this issue semantically occurred. 15907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek const Decl *getDeclWithIssue() const; 16007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek 16107189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek /// Specifically set the Decl where an issue occurred. This isn't necessary 16207189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek /// for BugReports that cover a path as it will be automatically inferred. 16307189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void setDeclWithIssue(const Decl *declWithIssue) { 16407189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek DeclWithIssue = declWithIssue; 16507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek } 16607189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek 167e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief This allows for addition of meta data to the diagnostic. 16838ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 16938ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// Currently, only the HTMLDiagnosticClient knows how to display it. 1707f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks void addExtraText(StringRef S) { 1717f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks ExtraText.push_back(S); 1727f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks } 1737f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks 1747f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks virtual const ExtraTextList &getExtraText() { 1757f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks return ExtraText; 176072192bcbb05a0fee7ec3061750b27e8d2004952Ted Kremenek } 1771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 17838ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Return the "definitive" location of the reported bug. 17938ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 180cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek /// While a bug can span an entire path, usually there is a specific 181fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner /// location that can be used to identify where the key issue occurred. 182cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek /// This location is used by clients rendering diagnostics. 183590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks virtual PathDiagnosticLocation getLocation(const SourceManager &SM) const; 1841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const Stmt *getStmt() const; 18623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 187e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Add a range to a bug report. 188e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// 189e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// Ranges are used to highlight regions of interest in the source code. 190e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// They should be at the same source code line as the BugReport location. 19114924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks /// By default, the source range of the statement corresponding to the error 19214924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks /// node will be used; add a single invalid range to specify absence of 19314924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks /// ranges. 194e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks void addRange(SourceRange R) { 19514924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks assert((R.isValid() || Ranges.empty()) && "Invalid range can only be used " 19614924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks "to specify that the report does not have a range."); 197e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks Ranges.push_back(R); 198e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks } 199640ccf071076e684713cc3c3276bb51982bff607Argyrios Kyrtzidis 200e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Get the SourceRanges associated with the report. 201e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual std::pair<ranges_iterator, ranges_iterator> getRanges(); 202e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 203e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Add custom or predefined bug report visitors to this report. 204e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// 205e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// The visitors should be used when the default trace is not sufficient. 206e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// For example, they allow constructing a more elaborate trace. 207e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \sa registerConditionVisitor(), registerTrackNullOrUndefValue(), 208e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// registerFindLastStore(), registerNilReceiverVisitor(), and 209e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// registerVarDeclsLastStore(). 21050bbc165b063155cc23c360deb7b865502e068e2Anna Zaks void addVisitor(BugReporterVisitor *visitor); 2118e6431adab313e283a992698f6fc7afe62420999Anna Zaks 2128e6431adab313e283a992698f6fc7afe62420999Anna Zaks /// Iterators through the custom diagnostic visitors. 2138e6431adab313e283a992698f6fc7afe62420999Anna Zaks visitor_iterator visitor_begin() { return Callbacks.begin(); } 2148e6431adab313e283a992698f6fc7afe62420999Anna Zaks visitor_iterator visitor_end() { return Callbacks.end(); } 2154522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks 2164522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks /// Profile to identify equivalent bug reports for error report coalescing. 2174522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks /// Reports are uniqued to ensure that we do not emit multiple diagnostics 2184522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks /// for each bug. 2194522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks virtual void Profile(llvm::FoldingSetNodeID& hash) const; 2206837faa083bebad39aa342f84c2b450fb6410eafTed Kremenek}; 221cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 2224a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer} // end ento namespace 2234a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer} // end clang namespace 2244a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer 2254a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramernamespace llvm { 2264a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer template<> struct ilist_traits<clang::ento::BugReport> 2274a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer : public ilist_default_traits<clang::ento::BugReport> { 2284a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer clang::ento::BugReport *createSentinel() const { 2294a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer return static_cast<clang::ento::BugReport *>(&Sentinel); 2304a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer } 2314a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer void destroySentinel(clang::ento::BugReport *) const {} 2324a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer 2334a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer clang::ento::BugReport *provideInitialHead() const { 2344a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer return createSentinel(); 2354a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer } 2364a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer clang::ento::BugReport *ensureHead(clang::ento::BugReport *) const { 2374a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer return createSentinel(); 2384a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer } 2394a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer private: 2404a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer mutable ilist_half_node<clang::ento::BugReport> Sentinel; 2414a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer }; 2424a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer} 2434a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer 2444a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramernamespace clang { 2454a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramernamespace ento { 2464a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer 247cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 248cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// BugTypes (collections of related reports). 249cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 2501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 251cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekclass BugReportEquivClass : public llvm::FoldingSetNode { 25238ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// List of *owned* BugReport objects. 2534a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer llvm::ilist<BugReport> Reports; 2541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 255cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek friend class BugReporter; 256cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void AddReport(BugReport* R) { Reports.push_back(R); } 257cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekpublic: 258cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugReportEquivClass(BugReport* R) { Reports.push_back(R); } 259cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek ~BugReportEquivClass(); 260cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 261cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void Profile(llvm::FoldingSetNodeID& ID) const { 262cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek assert(!Reports.empty()); 2634a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer Reports.front().Profile(ID); 264cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek } 265cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 2664a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer typedef llvm::ilist<BugReport>::iterator iterator; 2674a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer typedef llvm::ilist<BugReport>::const_iterator const_iterator; 2681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2694a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer iterator begin() { return Reports.begin(); } 2704a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer iterator end() { return Reports.end(); } 2711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2724a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer const_iterator begin() const { return Reports.begin(); } 2734a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer const_iterator end() const { return Reports.end(); } 274cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek}; 2751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 276cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 277cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// BugReporter and friends. 278cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 279cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 280c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekclass BugReporterData { 281c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekpublic: 282c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~BugReporterData(); 283d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie virtual DiagnosticsEngine& getDiagnostic() = 0; 284ef3643fbbbf66247c5e205497fae0f46e240c143David Blaikie virtual PathDiagnosticConsumer* getPathDiagnosticConsumer() = 0; 2859c378f705405d37f49795d5e915989de774fe11fTed Kremenek virtual ASTContext &getASTContext() = 0; 286c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual SourceManager& getSourceManager() = 0; 287c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek}; 2881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28938ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// BugReporter is a utility class for generating PathDiagnostics for analysis. 29038ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// It collects the BugReports and BugTypes and knows how to generate 29138ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// and flush the corresponding diagnostics. 29261f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekclass BugReporter { 293c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekpublic: 294c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek enum Kind { BaseBRKind, GRBugReporterKind }; 295c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 296cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekprivate: 297cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek typedef llvm::ImmutableSet<BugType*> BugTypesTy; 298cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugTypesTy::Factory F; 299cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugTypesTy BugTypes; 300cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 3011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const Kind kind; 302c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek BugReporterData& D; 3031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 30438ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// Generate and flush the diagnostics for the given bug report. 305cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void FlushReport(BugReportEquivClass& EQ); 306cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 30738ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// The set of bug reports tracked by the BugReporter. 308404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::FoldingSet<BugReportEquivClass> EQClasses; 3093b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks /// A vector of BugReports for tracking the allocated pointers and cleanup. 3103b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks std::vector<BugReportEquivClass *> EQClassesVector; 311404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 312cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekprotected: 3133baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugReporter(BugReporterData& d, Kind k) : BugTypes(F.getEmptySet()), kind(k), 314212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care D(d) {} 315cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 31661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekpublic: 3173baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugReporter(BugReporterData& d) : BugTypes(F.getEmptySet()), kind(BaseBRKind), 318212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care D(d) {} 319c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~BugReporter(); 3201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 32138ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Generate and flush diagnostics for all bug reports. 322cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void FlushReports(); 3231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 324c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek Kind getKind() const { return kind; } 3251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 326d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine& getDiagnostic() { 327c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return D.getDiagnostic(); 328c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 3291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 330ef3643fbbbf66247c5e205497fae0f46e240c143David Blaikie PathDiagnosticConsumer* getPathDiagnosticConsumer() { 331ef3643fbbbf66247c5e205497fae0f46e240c143David Blaikie return D.getPathDiagnosticConsumer(); 332c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 3331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 33438ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Iterator over the set of BugTypes tracked by the BugReporter. 3353aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek typedef BugTypesTy::iterator iterator; 3363aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek iterator begin() { return BugTypes.begin(); } 3373aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek iterator end() { return BugTypes.end(); } 3381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 33938ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Iterator over the set of BugReports tracked by the BugReporter. 340404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis typedef llvm::FoldingSet<BugReportEquivClass>::iterator EQClasses_iterator; 341404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis EQClasses_iterator EQClasses_begin() { return EQClasses.begin(); } 342404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis EQClasses_iterator EQClasses_end() { return EQClasses.end(); } 343404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 3449c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &getContext() { return D.getASTContext(); } 3451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 346cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek SourceManager& getSourceManager() { return D.getSourceManager(); } 3471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 34840406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek virtual void GeneratePathDiagnostic(PathDiagnostic& pathDiagnostic, 349686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<BugReport *> &bugReports) {} 35061f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 351cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void Register(BugType *BT); 3521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 35338ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Add the given report to the set of reports tracked by BugReporter. 35438ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 35538ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// The reports are usually generated by the checkers. Further, they are 35638ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// folded based on the profile value, which is done to coalesce similar 35738ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// reports. 358cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void EmitReport(BugReport *R); 3591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 36007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void EmitBasicReport(const Decl *DeclWithIssue, 36107189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek StringRef BugName, StringRef BugStr, 362590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticLocation Loc, 3638f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek SourceRange* RangeBeg, unsigned NumRanges); 3648f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek 36507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void EmitBasicReport(const Decl *DeclWithIssue, 36607189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek StringRef BugName, StringRef BugCategory, 367590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef BugStr, PathDiagnosticLocation Loc, 3688c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek SourceRange* RangeBeg, unsigned NumRanges); 3691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 37107189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void EmitBasicReport(const Decl *DeclWithIssue, 37207189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek StringRef BugName, StringRef BugStr, 373590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticLocation Loc) { 37407189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek EmitBasicReport(DeclWithIssue, BugName, BugStr, Loc, 0, 0); 3758f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek } 3761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 37707189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void EmitBasicReport(const Decl *DeclWithIssue, 37807189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek StringRef BugName, StringRef BugCategory, 379590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef BugStr, PathDiagnosticLocation Loc) { 38007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek EmitBasicReport(DeclWithIssue, BugName, BugCategory, BugStr, Loc, 0, 0); 38162059e809596a419e6fc3e751b2f0b57b7cc51e7Ted Kremenek } 3821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 38307189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void EmitBasicReport(const Decl *DeclWithIssue, 38407189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek StringRef BugName, StringRef BugStr, 38507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek PathDiagnosticLocation Loc, 38607189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek SourceRange R) { 38707189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek EmitBasicReport(DeclWithIssue, BugName, BugStr, Loc, &R, 1); 3888f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek } 3891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 39007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void EmitBasicReport(const Decl *DeclWithIssue, 39107189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek StringRef BugName, StringRef Category, 392590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef BugStr, PathDiagnosticLocation Loc, 393f0171732efb4647772ad2a45c0f31978b0e34f71Benjamin Kramer SourceRange R) { 39407189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek EmitBasicReport(DeclWithIssue, BugName, Category, BugStr, Loc, &R, 1); 3958c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek } 3961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 397c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek static bool classof(const BugReporter* R) { return true; } 398404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 399404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidisprivate: 400404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::StringMap<BugType *> StrBugTypes; 401404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 402404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis /// \brief Returns a BugType that is associated with the given name and 403404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis /// category. 404686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugType *getBugTypeForName(StringRef name, StringRef category); 405c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek}; 4068966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek 407cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// FIXME: Get rid of GRBugReporter. It's the wrong abstraction. 408c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekclass GRBugReporter : public BugReporter { 409d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis ExprEngine& Eng; 4101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 411d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis GRBugReporter(BugReporterData& d, ExprEngine& eng) 412c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek : BugReporter(d, GRBugReporterKind), Eng(eng) {} 4131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 414c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~GRBugReporter(); 4151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 416cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getEngine - Return the analysis engine used to analyze a given 417cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// function or method. 418d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis ExprEngine &getEngine() { return Eng; } 419c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 420cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getGraph - Get the exploded graph created by the analysis engine 421cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// for the analyzed method or function. 42238b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu ExplodedGraph &getGraph(); 4231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 424cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getStateManager - Return the state manager used by the analysis 425cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// engine. 42618c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ProgramStateManager &getStateManager(); 4271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 42840406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek virtual void GeneratePathDiagnostic(PathDiagnostic &pathDiagnostic, 429686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<BugReport*> &bugReports); 430c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 431cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// classof - Used by isa<>, cast<>, and dyn_cast<>. 432c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek static bool classof(const BugReporter* R) { 433c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return R->getKind() == GRBugReporterKind; 434c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 43561f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek}; 4361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4378966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenekclass BugReporterContext { 43899ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 4398966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek GRBugReporter &BR; 4408966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenekpublic: 4418e6431adab313e283a992698f6fc7afe62420999Anna Zaks BugReporterContext(GRBugReporter& br) : BR(br) {} 4421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4438e6431adab313e283a992698f6fc7afe62420999Anna Zaks virtual ~BugReporterContext() {} 4441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump GRBugReporter& getBugReporter() { return BR; } 4461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 44738b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu ExplodedGraph &getGraph() { return BR.getGraph(); } 4481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 44918c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ProgramStateManager& getStateManager() { 4508966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getStateManager(); 4518966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 4521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 453c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek SValBuilder& getSValBuilder() { 454c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek return getStateManager().getSValBuilder(); 455dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 4561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4579c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &getASTContext() { 4588966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getContext(); 4598966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 4601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4618966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek SourceManager& getSourceManager() { 4628966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getSourceManager(); 4638966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 4641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump virtual BugReport::NodeResolver& getNodeResolver() = 0; 4668966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek}; 467e207558e9dbed963eebf5cf31fdb02616f1545a3Ted Kremenek 4685a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis} // end GR namespace 4695a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 47061f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek} // end clang namespace 47161f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 47261f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek#endif 473