BugReporter.h revision 50bbc165b063155cc23c360deb7b865502e068e2
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" 2018c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState.h" 211b431023814196f87515a540ebcb9e9f1a9176a1Ted Kremenek#include "llvm/ADT/FoldingSet.h" 221b431023814196f87515a540ebcb9e9f1a9176a1Ted Kremenek#include "llvm/ADT/ImmutableList.h" 231b431023814196f87515a540ebcb9e9f1a9176a1Ted Kremenek#include "llvm/ADT/ImmutableSet.h" 24f377fc85488f4799ced714ac60e65a0e3f8f69cbTed Kremenek#include "llvm/ADT/SmallSet.h" 25e207558e9dbed963eebf5cf31fdb02616f1545a3Ted Kremenek#include <list> 26e207558e9dbed963eebf5cf31fdb02616f1545a3Ted Kremenek 2761f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremeneknamespace clang { 281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 295a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidisclass ASTContext; 305a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidisclass Diagnostic; 315a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidisclass Stmt; 325a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidisclass ParentMap; 335a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 349ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremeneknamespace ento { 355a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 3661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekclass PathDiagnostic; 3761f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekclass PathDiagnosticPiece; 3861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekclass PathDiagnosticClient; 395e2d2c2ee3cf410643e0f9a5701708e51409d973Benjamin Kramerclass ExplodedNode; 405e2d2c2ee3cf410643e0f9a5701708e51409d973Benjamin Kramerclass ExplodedGraph; 418e6431adab313e283a992698f6fc7afe62420999Anna Zaksclass BugReport; 4250a6d0ce344c02782e0207574005c3b2aaa5077cTed Kremenekclass BugReporter; 438966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenekclass BugReporterContext; 44d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidisclass ExprEngine; 4518c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenekclass ProgramState; 46cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekclass BugType; 471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 48cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 49cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// Interface for individual bug reports. 50cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 518966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek 52e7c4c4ccc6a51c82332382267b84e9d72f229b5eAnna Zaks/// This class provides an interface through which checkers can create 53e7c4c4ccc6a51c82332382267b84e9d72f229b5eAnna Zaks/// individual bug reports. 548966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenekclass BugReport : public BugReporterVisitor { 55e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zakspublic: 56e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks class NodeResolver { 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; 648e6431adab313e283a992698f6fc7afe62420999Anna Zaks typedef llvm::ImmutableList<BugReporterVisitor*>::iterator visitor_iterator; 65e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 667a9bb52171f962d51ab13c1e012d2236feb9558dTed Kremenekprotected: 67e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks friend class BugReporter; 68e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks friend class BugReportEquivClass; 69e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 70cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugType& BT; 71d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek std::string ShortDescription; 72cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek std::string Description; 73b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks FullSourceLoc Location; 74212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care const ExplodedNode *ErrorNode; 75e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks SmallVector<SourceRange, 4> Ranges; 768e6431adab313e283a992698f6fc7afe62420999Anna Zaks 778e6431adab313e283a992698f6fc7afe62420999Anna Zaks // Not the most efficient data structure, but we use an ImmutableList for the 788e6431adab313e283a992698f6fc7afe62420999Anna Zaks // Callbacks because it is safe to make additions to list during iteration. 798e6431adab313e283a992698f6fc7afe62420999Anna Zaks llvm::ImmutableList<BugReporterVisitor*>::Factory F; 808e6431adab313e283a992698f6fc7afe62420999Anna Zaks llvm::ImmutableList<BugReporterVisitor*> Callbacks; 818e6431adab313e283a992698f6fc7afe62420999Anna Zaks llvm::FoldingSet<BugReporterVisitor> CallbacksSet; 82cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 8338ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// Profile to identify equivalent bug reports for error report coalescing. 84e7c4c4ccc6a51c82332382267b84e9d72f229b5eAnna Zaks /// Reports are uniqued to ensure that we do not emit multiple diagnostics 85e7c4c4ccc6a51c82332382267b84e9d72f229b5eAnna Zaks /// for each bug. 86e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual void Profile(llvm::FoldingSetNodeID& hash) const; 871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 88e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks const Stmt *getStmt() const; 891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 90e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zakspublic: 91686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugReport(BugType& bt, StringRef desc, const ExplodedNode *errornode) 928e6431adab313e283a992698f6fc7afe62420999Anna Zaks : BT(bt), Description(desc), ErrorNode(errornode), 938e6431adab313e283a992698f6fc7afe62420999Anna Zaks Callbacks(F.getEmptyList()) { 948e6431adab313e283a992698f6fc7afe62420999Anna Zaks addVisitor(this); 958e6431adab313e283a992698f6fc7afe62420999Anna Zaks } 961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 97686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugReport(BugType& bt, StringRef shortDesc, StringRef desc, 98212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care const ExplodedNode *errornode) 998e6431adab313e283a992698f6fc7afe62420999Anna Zaks : BT(bt), ShortDescription(shortDesc), Description(desc), 1008e6431adab313e283a992698f6fc7afe62420999Anna Zaks ErrorNode(errornode), Callbacks(F.getEmptyList()) { 1018e6431adab313e283a992698f6fc7afe62420999Anna Zaks addVisitor(this); 1028e6431adab313e283a992698f6fc7afe62420999Anna Zaks } 103d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek 104b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks BugReport(BugType& bt, StringRef desc, FullSourceLoc l) 1058e6431adab313e283a992698f6fc7afe62420999Anna Zaks : BT(bt), Description(desc), Location(l), ErrorNode(0), 1068e6431adab313e283a992698f6fc7afe62420999Anna Zaks Callbacks(F.getEmptyList()) { 1078e6431adab313e283a992698f6fc7afe62420999Anna Zaks addVisitor(this); 1088e6431adab313e283a992698f6fc7afe62420999Anna Zaks } 109b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks 11050a6d0ce344c02782e0207574005c3b2aaa5077cTed Kremenek virtual ~BugReport(); 1111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1123b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks virtual bool isOwnedByReporterContext() { return false; } 113cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 114cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek const BugType& getBugType() const { return BT; } 115cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugType& getBugType() { return BT; } 1161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1179c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *getErrorNode() const { return ErrorNode; } 1181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 119686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const StringRef getDescription() const { return Description; } 120d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek 121686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const StringRef getShortDescription() const { 122d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek return ShortDescription.empty() ? Description : ShortDescription; 123d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek } 1241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 125e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief This allows for addition of meta data to the diagnostic. 12638ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 12738ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// Currently, only the HTMLDiagnosticClient knows how to display it. 128072192bcbb05a0fee7ec3061750b27e8d2004952Ted Kremenek virtual std::pair<const char**,const char**> getExtraDescriptiveText() { 129cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek return std::make_pair((const char**)0,(const char**)0); 130072192bcbb05a0fee7ec3061750b27e8d2004952Ted Kremenek } 1311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13238ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// Provide custom definition for the last diagnostic piece on the path. 1339c378f705405d37f49795d5e915989de774fe11fTed Kremenek virtual PathDiagnosticPiece *getEndPath(BugReporterContext &BRC, 1349c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *N); 1351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13638ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Return the "definitive" location of the reported bug. 13738ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 138cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek /// While a bug can span an entire path, usually there is a specific 139fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner /// location that can be used to identify where the key issue occurred. 140cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek /// This location is used by clients rendering diagnostics. 141cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek virtual SourceLocation getLocation() const; 1421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 143e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Add a range to a bug report. 144e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// 145e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// Ranges are used to highlight regions of interest in the source code. 146e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// They should be at the same source code line as the BugReport location. 147e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks void addRange(SourceRange R) { 148e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks assert(R.isValid()); 149e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks Ranges.push_back(R); 150e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks } 151640ccf071076e684713cc3c3276bb51982bff607Argyrios Kyrtzidis 152e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Get the SourceRanges associated with the report. 153e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual std::pair<ranges_iterator, ranges_iterator> getRanges(); 154e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 155e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Add custom or predefined bug report visitors to this report. 156e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// 157e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// The visitors should be used when the default trace is not sufficient. 158e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// For example, they allow constructing a more elaborate trace. 159e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \sa registerConditionVisitor(), registerTrackNullOrUndefValue(), 160e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// registerFindLastStore(), registerNilReceiverVisitor(), and 161e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// registerVarDeclsLastStore(). 16250bbc165b063155cc23c360deb7b865502e068e2Anna Zaks void addVisitor(BugReporterVisitor *visitor); 1638e6431adab313e283a992698f6fc7afe62420999Anna Zaks 1648e6431adab313e283a992698f6fc7afe62420999Anna Zaks /// Iterators through the custom diagnostic visitors. 1658e6431adab313e283a992698f6fc7afe62420999Anna Zaks visitor_iterator visitor_begin() { return Callbacks.begin(); } 1668e6431adab313e283a992698f6fc7afe62420999Anna Zaks visitor_iterator visitor_end() { return Callbacks.end(); } 1678e6431adab313e283a992698f6fc7afe62420999Anna Zaks 1689c378f705405d37f49795d5e915989de774fe11fTed Kremenek virtual PathDiagnosticPiece *VisitNode(const ExplodedNode *N, 1699c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *PrevN, 1708e6431adab313e283a992698f6fc7afe62420999Anna Zaks BugReporterContext &BRC, 1718e6431adab313e283a992698f6fc7afe62420999Anna Zaks BugReport &BR); 1726837faa083bebad39aa342f84c2b450fb6410eafTed Kremenek}; 173cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 174cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 175cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// BugTypes (collections of related reports). 176cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 1771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 178cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekclass BugReportEquivClass : public llvm::FoldingSetNode { 17938ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// List of *owned* BugReport objects. 180cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek std::list<BugReport*> Reports; 1811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 182cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek friend class BugReporter; 183cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void AddReport(BugReport* R) { Reports.push_back(R); } 184cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekpublic: 185cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugReportEquivClass(BugReport* R) { Reports.push_back(R); } 186cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek ~BugReportEquivClass(); 187cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 188cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void Profile(llvm::FoldingSetNodeID& ID) const { 189cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek assert(!Reports.empty()); 190cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek (*Reports.begin())->Profile(ID); 191cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek } 192cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 193cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek class iterator { 194cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek std::list<BugReport*>::iterator impl; 195cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek public: 196cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek iterator(std::list<BugReport*>::iterator i) : impl(i) {} 1979c378f705405d37f49795d5e915989de774fe11fTed Kremenek iterator &operator++() { ++impl; return *this; } 1989c378f705405d37f49795d5e915989de774fe11fTed Kremenek bool operator==(const iterator &I) const { return I.impl == impl; } 1999c378f705405d37f49795d5e915989de774fe11fTed Kremenek bool operator!=(const iterator &I) const { return I.impl != impl; } 200cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugReport* operator*() const { return *impl; } 201cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugReport* operator->() const { return *impl; } 202cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek }; 2031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2043aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek class const_iterator { 2053aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek std::list<BugReport*>::const_iterator impl; 2063aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek public: 2073aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek const_iterator(std::list<BugReport*>::const_iterator i) : impl(i) {} 2089c378f705405d37f49795d5e915989de774fe11fTed Kremenek const_iterator &operator++() { ++impl; return *this; } 2099c378f705405d37f49795d5e915989de774fe11fTed Kremenek bool operator==(const const_iterator &I) const { return I.impl == impl; } 2109c378f705405d37f49795d5e915989de774fe11fTed Kremenek bool operator!=(const const_iterator &I) const { return I.impl != impl; } 2113aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek const BugReport* operator*() const { return *impl; } 2123aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek const BugReport* operator->() const { return *impl; } 2133aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek }; 2141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 215cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek iterator begin() { return iterator(Reports.begin()); } 216cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek iterator end() { return iterator(Reports.end()); } 2171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2183aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek const_iterator begin() const { return const_iterator(Reports.begin()); } 2193aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek const_iterator end() const { return const_iterator(Reports.end()); } 220cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek}; 2211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 222cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 223cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// BugReporter and friends. 224cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 225cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 226c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekclass BugReporterData { 227c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekpublic: 228c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~BugReporterData(); 2291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump virtual Diagnostic& getDiagnostic() = 0; 2301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump virtual PathDiagnosticClient* getPathDiagnosticClient() = 0; 2319c378f705405d37f49795d5e915989de774fe11fTed Kremenek virtual ASTContext &getASTContext() = 0; 232c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual SourceManager& getSourceManager() = 0; 233c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek}; 2341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 23538ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// BugReporter is a utility class for generating PathDiagnostics for analysis. 23638ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// It collects the BugReports and BugTypes and knows how to generate 23738ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// and flush the corresponding diagnostics. 23861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekclass BugReporter { 239c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekpublic: 240c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek enum Kind { BaseBRKind, GRBugReporterKind }; 241c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 242cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekprivate: 243cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek typedef llvm::ImmutableSet<BugType*> BugTypesTy; 244cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugTypesTy::Factory F; 245cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugTypesTy BugTypes; 246cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 2471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const Kind kind; 248c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek BugReporterData& D; 2491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 25038ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// Generate and flush the diagnostics for the given bug report. 251cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void FlushReport(BugReportEquivClass& EQ); 252cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 25338ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// The set of bug reports tracked by the BugReporter. 254404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::FoldingSet<BugReportEquivClass> EQClasses; 2553b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks /// A vector of BugReports for tracking the allocated pointers and cleanup. 2563b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks std::vector<BugReportEquivClass *> EQClassesVector; 257404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 258cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekprotected: 2593baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugReporter(BugReporterData& d, Kind k) : BugTypes(F.getEmptySet()), kind(k), 260212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care D(d) {} 261cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 26261f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekpublic: 2633baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugReporter(BugReporterData& d) : BugTypes(F.getEmptySet()), kind(BaseBRKind), 264212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care D(d) {} 265c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~BugReporter(); 2661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 26738ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Generate and flush diagnostics for all bug reports. 268cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void FlushReports(); 2691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 270c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek Kind getKind() const { return kind; } 2711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 272c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek Diagnostic& getDiagnostic() { 273c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return D.getDiagnostic(); 274c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 2751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 276c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek PathDiagnosticClient* getPathDiagnosticClient() { 277c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return D.getPathDiagnosticClient(); 278c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 2791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28038ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Iterator over the set of BugTypes tracked by the BugReporter. 2813aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek typedef BugTypesTy::iterator iterator; 2823aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek iterator begin() { return BugTypes.begin(); } 2833aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek iterator end() { return BugTypes.end(); } 2841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28538ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Iterator over the set of BugReports tracked by the BugReporter. 286404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis typedef llvm::FoldingSet<BugReportEquivClass>::iterator EQClasses_iterator; 287404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis EQClasses_iterator EQClasses_begin() { return EQClasses.begin(); } 288404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis EQClasses_iterator EQClasses_end() { return EQClasses.end(); } 289404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 2909c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &getContext() { return D.getASTContext(); } 2911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 292cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek SourceManager& getSourceManager() { return D.getSourceManager(); } 2931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29440406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek virtual void GeneratePathDiagnostic(PathDiagnostic& pathDiagnostic, 295686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<BugReport *> &bugReports) {} 29661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 297cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void Register(BugType *BT); 2981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29938ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Add the given report to the set of reports tracked by BugReporter. 30038ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 30138ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// The reports are usually generated by the checkers. Further, they are 30238ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// folded based on the profile value, which is done to coalesce similar 30338ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// reports. 304cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void EmitReport(BugReport *R); 3051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 306686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void EmitBasicReport(StringRef BugName, StringRef BugStr, 3078f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek SourceLocation Loc, 3088f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek SourceRange* RangeBeg, unsigned NumRanges); 3098f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek 310686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void EmitBasicReport(StringRef BugName, StringRef BugCategory, 311686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef BugStr, SourceLocation Loc, 3128c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek SourceRange* RangeBeg, unsigned NumRanges); 3131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 315686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void EmitBasicReport(StringRef BugName, StringRef BugStr, 3168f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek SourceLocation Loc) { 3178f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek EmitBasicReport(BugName, BugStr, Loc, 0, 0); 3188f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek } 3191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 320686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void EmitBasicReport(StringRef BugName, StringRef BugCategory, 321686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef BugStr, SourceLocation Loc) { 32262059e809596a419e6fc3e751b2f0b57b7cc51e7Ted Kremenek EmitBasicReport(BugName, BugCategory, BugStr, Loc, 0, 0); 32362059e809596a419e6fc3e751b2f0b57b7cc51e7Ted Kremenek } 3241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 325686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void EmitBasicReport(StringRef BugName, StringRef BugStr, 3268f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek SourceLocation Loc, SourceRange R) { 3278f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek EmitBasicReport(BugName, BugStr, Loc, &R, 1); 3288f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek } 3291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 330686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void EmitBasicReport(StringRef BugName, StringRef Category, 331686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef BugStr, SourceLocation Loc, 332f0171732efb4647772ad2a45c0f31978b0e34f71Benjamin Kramer SourceRange R) { 3338c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek EmitBasicReport(BugName, Category, BugStr, Loc, &R, 1); 3348c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek } 3351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 336c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek static bool classof(const BugReporter* R) { return true; } 337404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 338404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidisprivate: 339404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::StringMap<BugType *> StrBugTypes; 340404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 341404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis /// \brief Returns a BugType that is associated with the given name and 342404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis /// category. 343686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugType *getBugTypeForName(StringRef name, StringRef category); 344c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek}; 3458966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek 346cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// FIXME: Get rid of GRBugReporter. It's the wrong abstraction. 347c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekclass GRBugReporter : public BugReporter { 348d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis ExprEngine& Eng; 3492dabd4372c50019fa00aae223ce634e0e754a3f2Ted Kremenek llvm::SmallSet<SymbolRef, 10> NotableSymbols; 3501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 351d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis GRBugReporter(BugReporterData& d, ExprEngine& eng) 352c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek : BugReporter(d, GRBugReporterKind), Eng(eng) {} 3531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 354c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~GRBugReporter(); 3551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 356cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getEngine - Return the analysis engine used to analyze a given 357cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// function or method. 358d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis ExprEngine &getEngine() { return Eng; } 359c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 360cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getGraph - Get the exploded graph created by the analysis engine 361cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// for the analyzed method or function. 36238b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu ExplodedGraph &getGraph(); 3631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 364cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getStateManager - Return the state manager used by the analysis 365cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// engine. 36618c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ProgramStateManager &getStateManager(); 3671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 36840406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek virtual void GeneratePathDiagnostic(PathDiagnostic &pathDiagnostic, 369686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<BugReport*> &bugReports); 370c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 3712dabd4372c50019fa00aae223ce634e0e754a3f2Ted Kremenek void addNotableSymbol(SymbolRef Sym) { 372c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek NotableSymbols.insert(Sym); 373c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 3741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3752dabd4372c50019fa00aae223ce634e0e754a3f2Ted Kremenek bool isNotable(SymbolRef Sym) const { 376c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return (bool) NotableSymbols.count(Sym); 377c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 3781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 379cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// classof - Used by isa<>, cast<>, and dyn_cast<>. 380c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek static bool classof(const BugReporter* R) { 381c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return R->getKind() == GRBugReporterKind; 382c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 38361f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek}; 3841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3858966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenekclass BugReporterContext { 3868966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek GRBugReporter &BR; 3878966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenekpublic: 3888e6431adab313e283a992698f6fc7afe62420999Anna Zaks BugReporterContext(GRBugReporter& br) : BR(br) {} 3891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3908e6431adab313e283a992698f6fc7afe62420999Anna Zaks virtual ~BugReporterContext() {} 3911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump GRBugReporter& getBugReporter() { return BR; } 3931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 39438b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu ExplodedGraph &getGraph() { return BR.getGraph(); } 3951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3968966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek void addNotableSymbol(SymbolRef Sym) { 3978966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // FIXME: For now forward to GRBugReporter. 3988966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek BR.addNotableSymbol(Sym); 3998966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 4001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4018966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek bool isNotable(SymbolRef Sym) const { 4028966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // FIXME: For now forward to GRBugReporter. 4038966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.isNotable(Sym); 4048966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 4051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 40618c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ProgramStateManager& getStateManager() { 4078966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getStateManager(); 4088966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 4091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 410c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek SValBuilder& getSValBuilder() { 411c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek return getStateManager().getSValBuilder(); 412dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 4131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4149c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &getASTContext() { 4158966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getContext(); 4168966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 4171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4188966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek SourceManager& getSourceManager() { 4198966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getSourceManager(); 4208966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 4211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump virtual BugReport::NodeResolver& getNodeResolver() = 0; 4238966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek}; 424e207558e9dbed963eebf5cf31fdb02616f1545a3Ted Kremenek 4255a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis} // end GR namespace 4265a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 42761f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek} // end clang namespace 42861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 42961f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek#endif 430