BugReporter.h revision 590dd8e0959d8df5621827768987c4792b74fc06
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" 231b431023814196f87515a540ebcb9e9f1a9176a1Ted Kremenek#include "llvm/ADT/ImmutableList.h" 241b431023814196f87515a540ebcb9e9f1a9176a1Ted Kremenek#include "llvm/ADT/ImmutableSet.h" 25f377fc85488f4799ced714ac60e65a0e3f8f69cbTed Kremenek#include "llvm/ADT/SmallSet.h" 26e207558e9dbed963eebf5cf31fdb02616f1545a3Ted Kremenek#include <list> 27e207558e9dbed963eebf5cf31fdb02616f1545a3Ted Kremenek 2861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremeneknamespace clang { 291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 305a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidisclass ASTContext; 315a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidisclass Diagnostic; 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. 52dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaksclass BugReport { 53e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zakspublic: 54e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks class NodeResolver { 55e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks public: 56e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual ~NodeResolver() {} 57e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual const ExplodedNode* 58e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks getOriginalNode(const ExplodedNode *N) = 0; 59e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks }; 60e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 61e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks typedef const SourceRange *ranges_iterator; 628e6431adab313e283a992698f6fc7afe62420999Anna Zaks typedef llvm::ImmutableList<BugReporterVisitor*>::iterator visitor_iterator; 637f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks typedef SmallVector<StringRef, 2> ExtraTextList; 64e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 657a9bb52171f962d51ab13c1e012d2236feb9558dTed Kremenekprotected: 66e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks friend class BugReporter; 67e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks friend class BugReportEquivClass; 68e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 69cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugType& BT; 70d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek std::string ShortDescription; 71cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek std::string Description; 72590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticLocation Location; 73212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care const ExplodedNode *ErrorNode; 74e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks SmallVector<SourceRange, 4> Ranges; 757f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks ExtraTextList ExtraText; 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 83e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zakspublic: 84686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugReport(BugType& bt, StringRef desc, const ExplodedNode *errornode) 858e6431adab313e283a992698f6fc7afe62420999Anna Zaks : BT(bt), Description(desc), ErrorNode(errornode), 86dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks Callbacks(F.getEmptyList()) {} 871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 88686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugReport(BugType& bt, StringRef shortDesc, StringRef desc, 89212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care const ExplodedNode *errornode) 908e6431adab313e283a992698f6fc7afe62420999Anna Zaks : BT(bt), ShortDescription(shortDesc), Description(desc), 91dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks ErrorNode(errornode), Callbacks(F.getEmptyList()) {} 92d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek 93590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks BugReport(BugType& bt, StringRef desc, PathDiagnosticLocation l) 948e6431adab313e283a992698f6fc7afe62420999Anna Zaks : BT(bt), Description(desc), Location(l), ErrorNode(0), 95dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks Callbacks(F.getEmptyList()) {} 96b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks 9750a6d0ce344c02782e0207574005c3b2aaa5077cTed Kremenek virtual ~BugReport(); 981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 99cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek const BugType& getBugType() const { return BT; } 100cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugType& getBugType() { return BT; } 1011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1029c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *getErrorNode() const { return ErrorNode; } 1031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 104686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const StringRef getDescription() const { return Description; } 105d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek 106686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const StringRef getShortDescription() const { 107d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek return ShortDescription.empty() ? Description : ShortDescription; 108d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek } 1091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 110e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief This allows for addition of meta data to the diagnostic. 11138ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 11238ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// Currently, only the HTMLDiagnosticClient knows how to display it. 1137f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks void addExtraText(StringRef S) { 1147f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks ExtraText.push_back(S); 1157f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks } 1167f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks 1177f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks virtual const ExtraTextList &getExtraText() { 1187f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks return ExtraText; 119072192bcbb05a0fee7ec3061750b27e8d2004952Ted Kremenek } 1201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12138ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Return the "definitive" location of the reported bug. 12238ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 123cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek /// While a bug can span an entire path, usually there is a specific 124fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner /// location that can be used to identify where the key issue occurred. 125cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek /// This location is used by clients rendering diagnostics. 126590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks virtual PathDiagnosticLocation getLocation(const SourceManager &SM) const; 1271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12823f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const Stmt *getStmt() const; 12923f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 130e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Add a range to a bug report. 131e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// 132e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// Ranges are used to highlight regions of interest in the source code. 133e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// They should be at the same source code line as the BugReport location. 13414924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks /// By default, the source range of the statement corresponding to the error 13514924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks /// node will be used; add a single invalid range to specify absence of 13614924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks /// ranges. 137e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks void addRange(SourceRange R) { 13814924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks assert((R.isValid() || Ranges.empty()) && "Invalid range can only be used " 13914924267950e75c6c1f6fcea39fa507b7168bc39Anna Zaks "to specify that the report does not have a range."); 140e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks Ranges.push_back(R); 141e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks } 142640ccf071076e684713cc3c3276bb51982bff607Argyrios Kyrtzidis 143e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Get the SourceRanges associated with the report. 144e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual std::pair<ranges_iterator, ranges_iterator> getRanges(); 145e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 146e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Add custom or predefined bug report visitors to this report. 147e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// 148e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// The visitors should be used when the default trace is not sufficient. 149e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// For example, they allow constructing a more elaborate trace. 150e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \sa registerConditionVisitor(), registerTrackNullOrUndefValue(), 151e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// registerFindLastStore(), registerNilReceiverVisitor(), and 152e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// registerVarDeclsLastStore(). 15350bbc165b063155cc23c360deb7b865502e068e2Anna Zaks void addVisitor(BugReporterVisitor *visitor); 1548e6431adab313e283a992698f6fc7afe62420999Anna Zaks 1558e6431adab313e283a992698f6fc7afe62420999Anna Zaks /// Iterators through the custom diagnostic visitors. 1568e6431adab313e283a992698f6fc7afe62420999Anna Zaks visitor_iterator visitor_begin() { return Callbacks.begin(); } 1578e6431adab313e283a992698f6fc7afe62420999Anna Zaks visitor_iterator visitor_end() { return Callbacks.end(); } 1584522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks 1594522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks /// Profile to identify equivalent bug reports for error report coalescing. 1604522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks /// Reports are uniqued to ensure that we do not emit multiple diagnostics 1614522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks /// for each bug. 1624522e2a9e7fa0313e8e5a388d8f0ab66feccc6afAnna Zaks virtual void Profile(llvm::FoldingSetNodeID& hash) const; 1636837faa083bebad39aa342f84c2b450fb6410eafTed Kremenek}; 164cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 165cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 166cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// BugTypes (collections of related reports). 167cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 1681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 169cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekclass BugReportEquivClass : public llvm::FoldingSetNode { 17038ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// List of *owned* BugReport objects. 171cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek std::list<BugReport*> Reports; 1721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 173cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek friend class BugReporter; 174cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void AddReport(BugReport* R) { Reports.push_back(R); } 175cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekpublic: 176cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugReportEquivClass(BugReport* R) { Reports.push_back(R); } 177cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek ~BugReportEquivClass(); 178cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 179cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void Profile(llvm::FoldingSetNodeID& ID) const { 180cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek assert(!Reports.empty()); 181cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek (*Reports.begin())->Profile(ID); 182cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek } 183cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 184cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek class iterator { 185cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek std::list<BugReport*>::iterator impl; 186cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek public: 187cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek iterator(std::list<BugReport*>::iterator i) : impl(i) {} 1889c378f705405d37f49795d5e915989de774fe11fTed Kremenek iterator &operator++() { ++impl; return *this; } 1899c378f705405d37f49795d5e915989de774fe11fTed Kremenek bool operator==(const iterator &I) const { return I.impl == impl; } 1909c378f705405d37f49795d5e915989de774fe11fTed Kremenek bool operator!=(const iterator &I) const { return I.impl != impl; } 191cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugReport* operator*() const { return *impl; } 192cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugReport* operator->() const { return *impl; } 193cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek }; 1941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1953aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek class const_iterator { 1963aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek std::list<BugReport*>::const_iterator impl; 1973aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek public: 1983aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek const_iterator(std::list<BugReport*>::const_iterator i) : impl(i) {} 1999c378f705405d37f49795d5e915989de774fe11fTed Kremenek const_iterator &operator++() { ++impl; return *this; } 2009c378f705405d37f49795d5e915989de774fe11fTed Kremenek bool operator==(const const_iterator &I) const { return I.impl == impl; } 2019c378f705405d37f49795d5e915989de774fe11fTed Kremenek bool operator!=(const const_iterator &I) const { return I.impl != impl; } 2023aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek const BugReport* operator*() const { return *impl; } 2033aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek const BugReport* operator->() const { return *impl; } 2043aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek }; 2051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 206cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek iterator begin() { return iterator(Reports.begin()); } 207cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek iterator end() { return iterator(Reports.end()); } 2081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2093aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek const_iterator begin() const { return const_iterator(Reports.begin()); } 2103aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek const_iterator end() const { return const_iterator(Reports.end()); } 211cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek}; 2121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 213cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 214cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// BugReporter and friends. 215cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 216cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 217c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekclass BugReporterData { 218c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekpublic: 219c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~BugReporterData(); 2201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump virtual Diagnostic& getDiagnostic() = 0; 2211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump virtual PathDiagnosticClient* getPathDiagnosticClient() = 0; 2229c378f705405d37f49795d5e915989de774fe11fTed Kremenek virtual ASTContext &getASTContext() = 0; 223c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual SourceManager& getSourceManager() = 0; 224c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek}; 2251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 22638ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// BugReporter is a utility class for generating PathDiagnostics for analysis. 22738ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// It collects the BugReports and BugTypes and knows how to generate 22838ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// and flush the corresponding diagnostics. 22961f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekclass BugReporter { 230c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekpublic: 231c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek enum Kind { BaseBRKind, GRBugReporterKind }; 232c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 233cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekprivate: 234cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek typedef llvm::ImmutableSet<BugType*> BugTypesTy; 235cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugTypesTy::Factory F; 236cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugTypesTy BugTypes; 237cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 2381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const Kind kind; 239c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek BugReporterData& D; 2401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 24138ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// Generate and flush the diagnostics for the given bug report. 242cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void FlushReport(BugReportEquivClass& EQ); 243cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 24438ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// The set of bug reports tracked by the BugReporter. 245404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::FoldingSet<BugReportEquivClass> EQClasses; 2463b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks /// A vector of BugReports for tracking the allocated pointers and cleanup. 2473b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks std::vector<BugReportEquivClass *> EQClassesVector; 248404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 249cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekprotected: 2503baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugReporter(BugReporterData& d, Kind k) : BugTypes(F.getEmptySet()), kind(k), 251212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care D(d) {} 252cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 25361f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekpublic: 2543baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugReporter(BugReporterData& d) : BugTypes(F.getEmptySet()), kind(BaseBRKind), 255212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care D(d) {} 256c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~BugReporter(); 2571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 25838ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Generate and flush diagnostics for all bug reports. 259cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void FlushReports(); 2601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 261c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek Kind getKind() const { return kind; } 2621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 263c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek Diagnostic& getDiagnostic() { 264c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return D.getDiagnostic(); 265c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 2661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 267c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek PathDiagnosticClient* getPathDiagnosticClient() { 268c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return D.getPathDiagnosticClient(); 269c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 2701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 27138ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Iterator over the set of BugTypes tracked by the BugReporter. 2723aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek typedef BugTypesTy::iterator iterator; 2733aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek iterator begin() { return BugTypes.begin(); } 2743aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek iterator end() { return BugTypes.end(); } 2751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 27638ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Iterator over the set of BugReports tracked by the BugReporter. 277404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis typedef llvm::FoldingSet<BugReportEquivClass>::iterator EQClasses_iterator; 278404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis EQClasses_iterator EQClasses_begin() { return EQClasses.begin(); } 279404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis EQClasses_iterator EQClasses_end() { return EQClasses.end(); } 280404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 2819c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &getContext() { return D.getASTContext(); } 2821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 283cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek SourceManager& getSourceManager() { return D.getSourceManager(); } 2841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28540406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek virtual void GeneratePathDiagnostic(PathDiagnostic& pathDiagnostic, 286686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<BugReport *> &bugReports) {} 28761f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 288cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void Register(BugType *BT); 2891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29038ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Add the given report to the set of reports tracked by BugReporter. 29138ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 29238ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// The reports are usually generated by the checkers. Further, they are 29338ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// folded based on the profile value, which is done to coalesce similar 29438ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// reports. 295cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void EmitReport(BugReport *R); 2961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 297686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void EmitBasicReport(StringRef BugName, StringRef BugStr, 298590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticLocation Loc, 2998f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek SourceRange* RangeBeg, unsigned NumRanges); 3008f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek 301686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void EmitBasicReport(StringRef BugName, StringRef BugCategory, 302590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef BugStr, PathDiagnosticLocation Loc, 3038c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek SourceRange* RangeBeg, unsigned NumRanges); 3041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 306686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void EmitBasicReport(StringRef BugName, StringRef BugStr, 307590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticLocation Loc) { 3088f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek EmitBasicReport(BugName, BugStr, Loc, 0, 0); 3098f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek } 3101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 311686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void EmitBasicReport(StringRef BugName, StringRef BugCategory, 312590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef BugStr, PathDiagnosticLocation Loc) { 31362059e809596a419e6fc3e751b2f0b57b7cc51e7Ted Kremenek EmitBasicReport(BugName, BugCategory, BugStr, Loc, 0, 0); 31462059e809596a419e6fc3e751b2f0b57b7cc51e7Ted Kremenek } 3151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 316686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void EmitBasicReport(StringRef BugName, StringRef BugStr, 317590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks PathDiagnosticLocation Loc, SourceRange R) { 3188f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek EmitBasicReport(BugName, BugStr, Loc, &R, 1); 3198f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek } 3201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 321686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void EmitBasicReport(StringRef BugName, StringRef Category, 322590dd8e0959d8df5621827768987c4792b74fc06Anna Zaks StringRef BugStr, PathDiagnosticLocation Loc, 323f0171732efb4647772ad2a45c0f31978b0e34f71Benjamin Kramer SourceRange R) { 3248c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek EmitBasicReport(BugName, Category, BugStr, Loc, &R, 1); 3258c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek } 3261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 327c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek static bool classof(const BugReporter* R) { return true; } 328404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 329404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidisprivate: 330404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::StringMap<BugType *> StrBugTypes; 331404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 332404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis /// \brief Returns a BugType that is associated with the given name and 333404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis /// category. 334686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugType *getBugTypeForName(StringRef name, StringRef category); 335c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek}; 3368966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek 337cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// FIXME: Get rid of GRBugReporter. It's the wrong abstraction. 338c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekclass GRBugReporter : public BugReporter { 339d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis ExprEngine& Eng; 3402dabd4372c50019fa00aae223ce634e0e754a3f2Ted Kremenek llvm::SmallSet<SymbolRef, 10> NotableSymbols; 3411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 342d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis GRBugReporter(BugReporterData& d, ExprEngine& eng) 343c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek : BugReporter(d, GRBugReporterKind), Eng(eng) {} 3441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 345c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~GRBugReporter(); 3461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 347cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getEngine - Return the analysis engine used to analyze a given 348cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// function or method. 349d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis ExprEngine &getEngine() { return Eng; } 350c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 351cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getGraph - Get the exploded graph created by the analysis engine 352cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// for the analyzed method or function. 35338b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu ExplodedGraph &getGraph(); 3541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 355cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getStateManager - Return the state manager used by the analysis 356cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// engine. 35718c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ProgramStateManager &getStateManager(); 3581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 35940406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek virtual void GeneratePathDiagnostic(PathDiagnostic &pathDiagnostic, 360686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<BugReport*> &bugReports); 361c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 3622dabd4372c50019fa00aae223ce634e0e754a3f2Ted Kremenek void addNotableSymbol(SymbolRef Sym) { 363c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek NotableSymbols.insert(Sym); 364c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 3651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3662dabd4372c50019fa00aae223ce634e0e754a3f2Ted Kremenek bool isNotable(SymbolRef Sym) const { 367c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return (bool) NotableSymbols.count(Sym); 368c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 3691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 370cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// classof - Used by isa<>, cast<>, and dyn_cast<>. 371c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek static bool classof(const BugReporter* R) { 372c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return R->getKind() == GRBugReporterKind; 373c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 37461f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek}; 3751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3768966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenekclass BugReporterContext { 3778966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek GRBugReporter &BR; 3788966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenekpublic: 3798e6431adab313e283a992698f6fc7afe62420999Anna Zaks BugReporterContext(GRBugReporter& br) : BR(br) {} 3801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3818e6431adab313e283a992698f6fc7afe62420999Anna Zaks virtual ~BugReporterContext() {} 3821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump GRBugReporter& getBugReporter() { return BR; } 3841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 38538b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu ExplodedGraph &getGraph() { return BR.getGraph(); } 3861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3878966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek void addNotableSymbol(SymbolRef Sym) { 3888966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // FIXME: For now forward to GRBugReporter. 3898966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek BR.addNotableSymbol(Sym); 3908966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 3911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3928966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek bool isNotable(SymbolRef Sym) const { 3938966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // FIXME: For now forward to GRBugReporter. 3948966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.isNotable(Sym); 3958966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 3961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 39718c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ProgramStateManager& getStateManager() { 3988966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getStateManager(); 3998966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 4001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 401c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek SValBuilder& getSValBuilder() { 402c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek return getStateManager().getSValBuilder(); 403dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 4041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4059c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &getASTContext() { 4068966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getContext(); 4078966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 4081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4098966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek SourceManager& getSourceManager() { 4108966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getSourceManager(); 4118966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 4121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump virtual BugReport::NodeResolver& getNodeResolver() = 0; 4148966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek}; 415e207558e9dbed963eebf5cf31fdb02616f1545a3Ted Kremenek 4165a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis} // end GR namespace 4175a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 41861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek} // end clang namespace 41961f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 42061f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek#endif 421