BugReporter.h revision c4bac8e376b98d633bb00ee5f510d5e58449753c
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 84c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// A (stack of) a set of symbols that are registered with this 85c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// report as being "interesting", and thus used to help decide which 86c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// diagnostics to include when constructing the final path diagnostic. 87c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// The stack is largely used by BugReporter when generating PathDiagnostics 88c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// for multiple PathDiagnosticConsumers. 89c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek llvm::SmallVector<Symbols *, 2> interestingSymbols; 90c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 91c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// A (stack of) set of regions that are registered with this report as being 9276aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek /// "interesting", and thus used to help decide which diagnostics 9376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek /// to include when constructing the final path diagnostic. 94c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// The stack is largely used by BugReporter when generating PathDiagnostics 95c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// for multiple PathDiagnosticConsumers. 96c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek llvm::SmallVector<Regions *, 2> interestingRegions; 978e6431adab313e283a992698f6fc7afe62420999Anna Zaks 983bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// A set of custom visitors which generate "event" diagnostics at 993bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// interesting points in the path. 1003bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose VisitorList Callbacks; 1013bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 1023bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// Used for ensuring the visitors are only added once. 1038e6431adab313e283a992698f6fc7afe62420999Anna Zaks llvm::FoldingSet<BugReporterVisitor> CallbacksSet; 104cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 1053bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// Used for clients to tell if the report's configuration has changed 1063bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose /// since the last time they checked. 1073bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose unsigned ConfigurationChangeToken; 108ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek 109ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// When set, this flag disables all callstack pruning from a diagnostic 110ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// path. This is useful for some reports that want maximum fidelty 111ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// when reporting an issue. 112ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek bool DoNotPrunePath; 1133bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 114c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenekprivate: 115c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek // Used internally by BugReporter. 116c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek Symbols &getInterestingSymbols(); 117c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek Regions &getInterestingRegions(); 118c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 119c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek void lazyInitializeInterestingSets(); 120c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek void pushInterestingSymbolsAndRegions(); 121c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek void popInterestingSymbolsAndRegions(); 122c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 123e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zakspublic: 124686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugReport(BugType& bt, StringRef desc, const ExplodedNode *errornode) 12507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek : BT(bt), DeclWithIssue(0), Description(desc), ErrorNode(errornode), 126ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek ConfigurationChangeToken(0), DoNotPrunePath(false) {} 1271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 128686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugReport(BugType& bt, StringRef shortDesc, StringRef desc, 129212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care const ExplodedNode *errornode) 13007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek : BT(bt), DeclWithIssue(0), ShortDescription(shortDesc), Description(desc), 131ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek ErrorNode(errornode), ConfigurationChangeToken(0), 132ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek DoNotPrunePath(false) {} 133d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek 134590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks BugReport(BugType& bt, StringRef desc, PathDiagnosticLocation l) 13507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek : BT(bt), DeclWithIssue(0), Description(desc), Location(l), ErrorNode(0), 136ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek ConfigurationChangeToken(0), 137ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek DoNotPrunePath(false) {} 138b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks 139ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// \brief Create a BugReport with a custom uniqueing location. 140ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// 141ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// The reports that have the same report location, description, bug type, and 142ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// ranges are uniqued - only one of the equivalent reports will be presented 143ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// to the user. This method allows to rest the location which should be used 144ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// for uniquing reports. For example, memory leaks checker, could set this to 145ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks /// the allocation site, rather then the location where the bug is reported. 146ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks BugReport(BugType& bt, StringRef desc, const ExplodedNode *errornode, 147ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks PathDiagnosticLocation LocationToUnique) 14807189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek : BT(bt), DeclWithIssue(0), Description(desc), 14907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek UniqueingLocation(LocationToUnique), 1503bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose ErrorNode(errornode), ConfigurationChangeToken(0) {} 151ca8e36eb637e232475ef31c3f22d5da907390917Anna Zaks 15250a6d0ce344c02782e0207574005c3b2aaa5077cTed Kremenek virtual ~BugReport(); 1531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 154cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek const BugType& getBugType() const { return BT; } 155cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugType& getBugType() { return BT; } 1561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1579c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *getErrorNode() const { return ErrorNode; } 1581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 159686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const StringRef getDescription() const { return Description; } 160d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek 161686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const StringRef getShortDescription() const { 162d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek return ShortDescription.empty() ? Description : ShortDescription; 163d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek } 1641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 165ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// Indicates whether or not any path pruning should take place 166ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// when generating a PathDiagnostic from this BugReport. 167ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek bool shouldPrunePath() const { return !DoNotPrunePath; } 168ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek 169ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek /// Disable all path pruning when generating a PathDiagnostic. 170ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek void disablePathPruning() { DoNotPrunePath = true; } 171ed7948b55fa4b2505f240cc5287137f451172b4cTed Kremenek 17276aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek void markInteresting(SymbolRef sym); 17376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek void markInteresting(const MemRegion *R); 17476aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek void markInteresting(SVal V); 17576aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 176c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek bool isInteresting(SymbolRef sym); 177c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek bool isInteresting(const MemRegion *R); 178c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek bool isInteresting(SVal V); 1793bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose 1803bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose unsigned getConfigurationChangeToken() const { 1813bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose return ConfigurationChangeToken; 1823bc75ca0a636efdc93471c9b6bad43085a22bf3aJordy Rose } 18376aadc346c3a4c363238a1e1232f324c3355d9e0Ted Kremenek 18407189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek /// Return the canonical declaration, be it a method or class, where 18507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek /// this issue semantically occurred. 18607189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek const Decl *getDeclWithIssue() const; 18707189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek 18807189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek /// Specifically set the Decl where an issue occurred. This isn't necessary 18907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek /// for BugReports that cover a path as it will be automatically inferred. 19007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void setDeclWithIssue(const Decl *declWithIssue) { 19107189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek DeclWithIssue = declWithIssue; 19207189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek } 19307189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek 194e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief This allows for addition of meta data to the diagnostic. 19538ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 19638ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// Currently, only the HTMLDiagnosticClient knows how to display it. 1977f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks void addExtraText(StringRef S) { 1987f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks ExtraText.push_back(S); 1997f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks } 2007f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks 2017f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks virtual const ExtraTextList &getExtraText() { 2027f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks return ExtraText; 203072192bcbb05a0fee7ec3061750b27e8d2004952Ted Kremenek } 2041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 20538ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Return the "definitive" location of the reported bug. 20638ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 207cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek /// While a bug can span an entire path, usually there is a specific 208fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner /// location that can be used to identify where the key issue occurred. 209cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek /// This location is used by clients rendering diagnostics. 210590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks virtual PathDiagnosticLocation getLocation(const SourceManager &SM) const; 2111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21223f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const Stmt *getStmt() const; 21323f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 214e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Add a range to a bug report. 215e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// 216e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// Ranges are used to highlight regions of interest in the source code. 217e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// They should be at the same source code line as the BugReport location. 21814924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks /// By default, the source range of the statement corresponding to the error 21914924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks /// node will be used; add a single invalid range to specify absence of 22014924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks /// ranges. 221e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks void addRange(SourceRange R) { 22214924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks assert((R.isValid() || Ranges.empty()) && "Invalid range can only be used " 22314924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks "to specify that the report does not have a range."); 224e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks Ranges.push_back(R); 225e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks } 226640ccf071076e684713cc3c3276bb51982bff607Argyrios Kyrtzidis 227e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Get the SourceRanges associated with the report. 228e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual std::pair<ranges_iterator, ranges_iterator> getRanges(); 229e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 230e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Add custom or predefined bug report visitors to this report. 231e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// 232e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// The visitors should be used when the default trace is not sufficient. 233e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// For example, they allow constructing a more elaborate trace. 234e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \sa registerConditionVisitor(), registerTrackNullOrUndefValue(), 235e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// registerFindLastStore(), registerNilReceiverVisitor(), and 236e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// registerVarDeclsLastStore(). 23750bbc165b063155cc23c360deb7b865502e068e2Anna Zaks void addVisitor(BugReporterVisitor *visitor); 2388e6431adab313e283a992698f6fc7afe62420999Anna Zaks 2398e6431adab313e283a992698f6fc7afe62420999Anna Zaks /// Iterators through the custom diagnostic visitors. 2408e6431adab313e283a992698f6fc7afe62420999Anna Zaks visitor_iterator visitor_begin() { return Callbacks.begin(); } 2418e6431adab313e283a992698f6fc7afe62420999Anna Zaks visitor_iterator visitor_end() { return Callbacks.end(); } 2424522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks 2434522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks /// Profile to identify equivalent bug reports for error report coalescing. 2444522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks /// Reports are uniqued to ensure that we do not emit multiple diagnostics 2454522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks /// for each bug. 2464522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks virtual void Profile(llvm::FoldingSetNodeID& hash) const; 2476837faa083bebad39aa342f84c2b450fb6410eafTed Kremenek}; 248cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 2494a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer} // end ento namespace 2504a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer} // end clang namespace 2514a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer 2524a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramernamespace llvm { 2534a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer template<> struct ilist_traits<clang::ento::BugReport> 2544a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer : public ilist_default_traits<clang::ento::BugReport> { 2554a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer clang::ento::BugReport *createSentinel() const { 2564a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer return static_cast<clang::ento::BugReport *>(&Sentinel); 2574a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer } 2584a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer void destroySentinel(clang::ento::BugReport *) const {} 2594a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer 2604a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer clang::ento::BugReport *provideInitialHead() const { 2614a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer return createSentinel(); 2624a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer } 2634a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer clang::ento::BugReport *ensureHead(clang::ento::BugReport *) const { 2644a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer return createSentinel(); 2654a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer } 2664a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer private: 2674a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer mutable ilist_half_node<clang::ento::BugReport> Sentinel; 2684a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer }; 2694a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer} 2704a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer 2714a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramernamespace clang { 2724a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramernamespace ento { 2734a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer 274cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 275cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// BugTypes (collections of related reports). 276cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 2771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 278cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekclass BugReportEquivClass : public llvm::FoldingSetNode { 27938ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// List of *owned* BugReport objects. 2804a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer llvm::ilist<BugReport> Reports; 2811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 282cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek friend class BugReporter; 283cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void AddReport(BugReport* R) { Reports.push_back(R); } 284cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekpublic: 285cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugReportEquivClass(BugReport* R) { Reports.push_back(R); } 286cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek ~BugReportEquivClass(); 287cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 288cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void Profile(llvm::FoldingSetNodeID& ID) const { 289cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek assert(!Reports.empty()); 2904a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer Reports.front().Profile(ID); 291cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek } 292cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 2934a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer typedef llvm::ilist<BugReport>::iterator iterator; 2944a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer typedef llvm::ilist<BugReport>::const_iterator const_iterator; 2951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2964a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer iterator begin() { return Reports.begin(); } 2974a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer iterator end() { return Reports.end(); } 2981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2994a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer const_iterator begin() const { return Reports.begin(); } 3004a5f724538cbc275370c9504e8169ce92503256cBenjamin Kramer const_iterator end() const { return Reports.end(); } 301cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek}; 3021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 303cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 304cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// BugReporter and friends. 305cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 306cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 307c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekclass BugReporterData { 308c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekpublic: 309c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~BugReporterData(); 310d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie virtual DiagnosticsEngine& getDiagnostic() = 0; 311c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek virtual ArrayRef<PathDiagnosticConsumer*> getPathDiagnosticConsumers() = 0; 3129c378f705405d37f49795d5e915989de774fe11fTed Kremenek virtual ASTContext &getASTContext() = 0; 313c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual SourceManager& getSourceManager() = 0; 314c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek}; 3151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 31638ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// BugReporter is a utility class for generating PathDiagnostics for analysis. 31738ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// It collects the BugReports and BugTypes and knows how to generate 31838ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// and flush the corresponding diagnostics. 31961f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekclass BugReporter { 320c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekpublic: 321c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek enum Kind { BaseBRKind, GRBugReporterKind }; 322c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 323cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekprivate: 324cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek typedef llvm::ImmutableSet<BugType*> BugTypesTy; 325cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugTypesTy::Factory F; 326cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugTypesTy BugTypes; 327cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 3281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const Kind kind; 329c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek BugReporterData& D; 3301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 33138ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// Generate and flush the diagnostics for the given bug report. 332cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void FlushReport(BugReportEquivClass& EQ); 333cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 334c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// Generate and flush the diagnostics for the given bug report 335c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek /// and PathDiagnosticConsumer. 336c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek void FlushReport(BugReport *exampleReport, 337c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticConsumer &PD, 338c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<BugReport*> BugReports); 339c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek 34038ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// The set of bug reports tracked by the BugReporter. 341404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::FoldingSet<BugReportEquivClass> EQClasses; 3423b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks /// A vector of BugReports for tracking the allocated pointers and cleanup. 3433b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks std::vector<BugReportEquivClass *> EQClassesVector; 344404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 345cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekprotected: 3463baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugReporter(BugReporterData& d, Kind k) : BugTypes(F.getEmptySet()), kind(k), 347212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care D(d) {} 348cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 34961f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekpublic: 3503baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugReporter(BugReporterData& d) : BugTypes(F.getEmptySet()), kind(BaseBRKind), 351212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care D(d) {} 352c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~BugReporter(); 3531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 35438ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Generate and flush diagnostics for all bug reports. 355cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void FlushReports(); 3561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 357c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek Kind getKind() const { return kind; } 3581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 359d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine& getDiagnostic() { 360c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return D.getDiagnostic(); 361c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 3621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 363c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<PathDiagnosticConsumer*> getPathDiagnosticConsumers() { 364c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek return D.getPathDiagnosticConsumers(); 365c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 3661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 36738ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Iterator over the set of BugTypes tracked by the BugReporter. 3683aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek typedef BugTypesTy::iterator iterator; 3693aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek iterator begin() { return BugTypes.begin(); } 3703aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek iterator end() { return BugTypes.end(); } 3711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 37238ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Iterator over the set of BugReports tracked by the BugReporter. 373404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis typedef llvm::FoldingSet<BugReportEquivClass>::iterator EQClasses_iterator; 374404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis EQClasses_iterator EQClasses_begin() { return EQClasses.begin(); } 375404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis EQClasses_iterator EQClasses_end() { return EQClasses.end(); } 376404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 3779c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &getContext() { return D.getASTContext(); } 3781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 379cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek SourceManager& getSourceManager() { return D.getSourceManager(); } 3801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 38140406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek virtual void GeneratePathDiagnostic(PathDiagnostic& pathDiagnostic, 382c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticConsumer &PC, 383c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<BugReport *> &bugReports) {} 38461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 385cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void Register(BugType *BT); 3861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 38738ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Add the given report to the set of reports tracked by BugReporter. 38838ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 38938ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// The reports are usually generated by the checkers. Further, they are 39038ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// folded based on the profile value, which is done to coalesce similar 39138ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// reports. 392cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void EmitReport(BugReport *R); 3931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 39407189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void EmitBasicReport(const Decl *DeclWithIssue, 39507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek StringRef BugName, StringRef BugCategory, 396590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef BugStr, PathDiagnosticLocation Loc, 3978c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek SourceRange* RangeBeg, unsigned NumRanges); 3981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 39907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void EmitBasicReport(const Decl *DeclWithIssue, 40007189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek StringRef BugName, StringRef BugCategory, 401590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef BugStr, PathDiagnosticLocation Loc) { 40207189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek EmitBasicReport(DeclWithIssue, BugName, BugCategory, BugStr, Loc, 0, 0); 40362059e809596a419e6fc3e751b2f0b57b7cc51e7Ted Kremenek } 4041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 40507189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek void EmitBasicReport(const Decl *DeclWithIssue, 40607189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek StringRef BugName, StringRef Category, 407590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef BugStr, PathDiagnosticLocation Loc, 408f0171732efb4647772ad2a45c0f31978b0e34f71Benjamin Kramer SourceRange R) { 40907189521a15d9c088216b943649cb9fe231cbb57Ted Kremenek EmitBasicReport(DeclWithIssue, BugName, Category, BugStr, Loc, &R, 1); 4108c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek } 4111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 412c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek static bool classof(const BugReporter* R) { return true; } 413404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 414404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidisprivate: 415404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::StringMap<BugType *> StrBugTypes; 416404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 417404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis /// \brief Returns a BugType that is associated with the given name and 418404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis /// category. 419686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugType *getBugTypeForName(StringRef name, StringRef category); 420c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek}; 4218966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek 422cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// FIXME: Get rid of GRBugReporter. It's the wrong abstraction. 423c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekclass GRBugReporter : public BugReporter { 424d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis ExprEngine& Eng; 4251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 426d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis GRBugReporter(BugReporterData& d, ExprEngine& eng) 427c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek : BugReporter(d, GRBugReporterKind), Eng(eng) {} 4281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 429c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~GRBugReporter(); 4301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 431cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getEngine - Return the analysis engine used to analyze a given 432cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// function or method. 433d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis ExprEngine &getEngine() { return Eng; } 434c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 435cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getGraph - Get the exploded graph created by the analysis engine 436cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// for the analyzed method or function. 43738b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu ExplodedGraph &getGraph(); 4381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 439cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getStateManager - Return the state manager used by the analysis 440cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// engine. 44118c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ProgramStateManager &getStateManager(); 4421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 44340406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek virtual void GeneratePathDiagnostic(PathDiagnostic &pathDiagnostic, 444c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek PathDiagnosticConsumer &PC, 445c4bac8e376b98d633bb00ee5f510d5e58449753cTed Kremenek ArrayRef<BugReport*> &bugReports); 446c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 447cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// classof - Used by isa<>, cast<>, and dyn_cast<>. 448c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek static bool classof(const BugReporter* R) { 449c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return R->getKind() == GRBugReporterKind; 450c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 45161f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek}; 4521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4538966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenekclass BugReporterContext { 45499ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 4558966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek GRBugReporter &BR; 4568966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenekpublic: 4578e6431adab313e283a992698f6fc7afe62420999Anna Zaks BugReporterContext(GRBugReporter& br) : BR(br) {} 4581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4598e6431adab313e283a992698f6fc7afe62420999Anna Zaks virtual ~BugReporterContext() {} 4601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump GRBugReporter& getBugReporter() { return BR; } 4621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 46338b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu ExplodedGraph &getGraph() { return BR.getGraph(); } 4641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 46518c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ProgramStateManager& getStateManager() { 4668966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getStateManager(); 4678966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 4681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 469c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek SValBuilder& getSValBuilder() { 470c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek return getStateManager().getSValBuilder(); 471dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 4721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4739c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &getASTContext() { 4748966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getContext(); 4758966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 4761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4778966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek SourceManager& getSourceManager() { 4788966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getSourceManager(); 4798966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 4801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump virtual BugReport::NodeResolver& getNodeResolver() = 0; 4828966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek}; 483e207558e9dbed963eebf5cf31fdb02616f1545a3Ted Kremenek 4845a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis} // end GR namespace 4855a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 48661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek} // end clang namespace 48761f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 48861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek#endif 489