BugReporter.h revision 7f2531cb41448852ec78de90fc1d3c0149c95d7d
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. 54dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaksclass BugReport { 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; 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; 72d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek std::string ShortDescription; 73cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek std::string Description; 74b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks FullSourceLoc Location; 75212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care const ExplodedNode *ErrorNode; 76e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks SmallVector<SourceRange, 4> Ranges; 777f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks ExtraTextList ExtraText; 788e6431adab313e283a992698f6fc7afe62420999Anna Zaks 798e6431adab313e283a992698f6fc7afe62420999Anna Zaks // Not the most efficient data structure, but we use an ImmutableList for the 808e6431adab313e283a992698f6fc7afe62420999Anna Zaks // Callbacks because it is safe to make additions to list during iteration. 818e6431adab313e283a992698f6fc7afe62420999Anna Zaks llvm::ImmutableList<BugReporterVisitor*>::Factory F; 828e6431adab313e283a992698f6fc7afe62420999Anna Zaks llvm::ImmutableList<BugReporterVisitor*> Callbacks; 838e6431adab313e283a992698f6fc7afe62420999Anna Zaks llvm::FoldingSet<BugReporterVisitor> CallbacksSet; 84cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 8538ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// Profile to identify equivalent bug reports for error report coalescing. 86e7c4c4ccc6a51c82332382267b84e9d72f229b5eAnna Zaks /// Reports are uniqued to ensure that we do not emit multiple diagnostics 87e7c4c4ccc6a51c82332382267b84e9d72f229b5eAnna Zaks /// for each bug. 88e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual void Profile(llvm::FoldingSetNodeID& hash) const; 891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 90e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zakspublic: 91686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugReport(BugType& bt, StringRef desc, const ExplodedNode *errornode) 928e6431adab313e283a992698f6fc7afe62420999Anna Zaks : BT(bt), Description(desc), ErrorNode(errornode), 93dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks Callbacks(F.getEmptyList()) {} 941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 95686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugReport(BugType& bt, StringRef shortDesc, StringRef desc, 96212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care const ExplodedNode *errornode) 978e6431adab313e283a992698f6fc7afe62420999Anna Zaks : BT(bt), ShortDescription(shortDesc), Description(desc), 98dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks ErrorNode(errornode), Callbacks(F.getEmptyList()) {} 99d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek 100b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks BugReport(BugType& bt, StringRef desc, FullSourceLoc l) 1018e6431adab313e283a992698f6fc7afe62420999Anna Zaks : BT(bt), Description(desc), Location(l), ErrorNode(0), 102dc757b049796949e4b11646445a6598f0bdabd7aAnna Zaks Callbacks(F.getEmptyList()) {} 103b7530a4ca9a7ef62350682bbb374a06de6fdaa9fAnna Zaks 10450a6d0ce344c02782e0207574005c3b2aaa5077cTed Kremenek virtual ~BugReport(); 1051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 106cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek const BugType& getBugType() const { return BT; } 107cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugType& getBugType() { return BT; } 1081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1099c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ExplodedNode *getErrorNode() const { return ErrorNode; } 1101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 111686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const StringRef getDescription() const { return Description; } 112d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek 113686775deca8b8685eb90801495880e3abdd844c2Chris Lattner const StringRef getShortDescription() const { 114d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek return ShortDescription.empty() ? Description : ShortDescription; 115d49967f8764135ae65658e354b6d38e3637c9de3Ted Kremenek } 1161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 117e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief This allows for addition of meta data to the diagnostic. 11838ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 11938ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// Currently, only the HTMLDiagnosticClient knows how to display it. 1207f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks void addExtraText(StringRef S) { 1217f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks ExtraText.push_back(S); 1227f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks } 1237f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks 1247f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks virtual const ExtraTextList &getExtraText() { 1257f2531cb41448852ec78de90fc1d3c0149c95d7dAnna Zaks return ExtraText; 126072192bcbb05a0fee7ec3061750b27e8d2004952Ted Kremenek } 1271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12838ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Return the "definitive" location of the reported bug. 12938ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 130cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek /// While a bug can span an entire path, usually there is a specific 131fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner /// location that can be used to identify where the key issue occurred. 132cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek /// This location is used by clients rendering diagnostics. 133cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek virtual SourceLocation getLocation() const; 1341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 13523f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks const Stmt *getStmt() const; 13623f395ee1bf4e4aa76b310d896a951799eaca94aAnna Zaks 137e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Add a range to a bug report. 138e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// 139e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// Ranges are used to highlight regions of interest in the source code. 140e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// They should be at the same source code line as the BugReport location. 141e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks void addRange(SourceRange R) { 142e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks assert(R.isValid()); 143e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks Ranges.push_back(R); 144e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks } 145640ccf071076e684713cc3c3276bb51982bff607Argyrios Kyrtzidis 146e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Get the SourceRanges associated with the report. 147e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks virtual std::pair<ranges_iterator, ranges_iterator> getRanges(); 148e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks 149e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \brief Add custom or predefined bug report visitors to this report. 150e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// 151e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// The visitors should be used when the default trace is not sufficient. 152e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// For example, they allow constructing a more elaborate trace. 153e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// \sa registerConditionVisitor(), registerTrackNullOrUndefValue(), 154e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// registerFindLastStore(), registerNilReceiverVisitor(), and 155e172e8b9e7fc67d7d03589af7e92fe777afcf33aAnna Zaks /// registerVarDeclsLastStore(). 15650bbc165b063155cc23c360deb7b865502e068e2Anna Zaks void addVisitor(BugReporterVisitor *visitor); 1578e6431adab313e283a992698f6fc7afe62420999Anna Zaks 1588e6431adab313e283a992698f6fc7afe62420999Anna Zaks /// Iterators through the custom diagnostic visitors. 1598e6431adab313e283a992698f6fc7afe62420999Anna Zaks visitor_iterator visitor_begin() { return Callbacks.begin(); } 1608e6431adab313e283a992698f6fc7afe62420999Anna Zaks visitor_iterator visitor_end() { return Callbacks.end(); } 1616837faa083bebad39aa342f84c2b450fb6410eafTed Kremenek}; 162cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 163cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 164cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// BugTypes (collections of related reports). 165cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 1661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 167cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekclass BugReportEquivClass : public llvm::FoldingSetNode { 16838ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// List of *owned* BugReport objects. 169cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek std::list<BugReport*> Reports; 1701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 171cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek friend class BugReporter; 172cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void AddReport(BugReport* R) { Reports.push_back(R); } 173cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekpublic: 174cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugReportEquivClass(BugReport* R) { Reports.push_back(R); } 175cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek ~BugReportEquivClass(); 176cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 177cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void Profile(llvm::FoldingSetNodeID& ID) const { 178cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek assert(!Reports.empty()); 179cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek (*Reports.begin())->Profile(ID); 180cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek } 181cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 182cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek class iterator { 183cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek std::list<BugReport*>::iterator impl; 184cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek public: 185cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek iterator(std::list<BugReport*>::iterator i) : impl(i) {} 1869c378f705405d37f49795d5e915989de774fe11fTed Kremenek iterator &operator++() { ++impl; return *this; } 1879c378f705405d37f49795d5e915989de774fe11fTed Kremenek bool operator==(const iterator &I) const { return I.impl == impl; } 1889c378f705405d37f49795d5e915989de774fe11fTed Kremenek bool operator!=(const iterator &I) const { return I.impl != impl; } 189cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugReport* operator*() const { return *impl; } 190cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugReport* operator->() const { return *impl; } 191cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek }; 1921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1933aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek class const_iterator { 1943aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek std::list<BugReport*>::const_iterator impl; 1953aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek public: 1963aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek const_iterator(std::list<BugReport*>::const_iterator i) : impl(i) {} 1979c378f705405d37f49795d5e915989de774fe11fTed Kremenek const_iterator &operator++() { ++impl; return *this; } 1989c378f705405d37f49795d5e915989de774fe11fTed Kremenek bool operator==(const const_iterator &I) const { return I.impl == impl; } 1999c378f705405d37f49795d5e915989de774fe11fTed Kremenek bool operator!=(const const_iterator &I) const { return I.impl != impl; } 2003aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek const BugReport* operator*() const { return *impl; } 2013aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek const BugReport* operator->() const { return *impl; } 2023aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek }; 2031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 204cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek iterator begin() { return iterator(Reports.begin()); } 205cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek iterator end() { return iterator(Reports.end()); } 2061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2073aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek const_iterator begin() const { return const_iterator(Reports.begin()); } 2083aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek const_iterator end() const { return const_iterator(Reports.end()); } 209cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek}; 2101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 211cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 212cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// BugReporter and friends. 213cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 214cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 215c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekclass BugReporterData { 216c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekpublic: 217c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~BugReporterData(); 2181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump virtual Diagnostic& getDiagnostic() = 0; 2191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump virtual PathDiagnosticClient* getPathDiagnosticClient() = 0; 2209c378f705405d37f49795d5e915989de774fe11fTed Kremenek virtual ASTContext &getASTContext() = 0; 221c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual SourceManager& getSourceManager() = 0; 222c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek}; 2231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 22438ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// BugReporter is a utility class for generating PathDiagnostics for analysis. 22538ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// It collects the BugReports and BugTypes and knows how to generate 22638ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks/// and flush the corresponding diagnostics. 22761f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekclass BugReporter { 228c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekpublic: 229c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek enum Kind { BaseBRKind, GRBugReporterKind }; 230c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 231cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekprivate: 232cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek typedef llvm::ImmutableSet<BugType*> BugTypesTy; 233cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugTypesTy::Factory F; 234cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek BugTypesTy BugTypes; 235cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 2361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const Kind kind; 237c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek BugReporterData& D; 2381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 23938ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// Generate and flush the diagnostics for the given bug report. 240cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void FlushReport(BugReportEquivClass& EQ); 241cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 24238ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// The set of bug reports tracked by the BugReporter. 243404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::FoldingSet<BugReportEquivClass> EQClasses; 2443b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks /// A vector of BugReports for tracking the allocated pointers and cleanup. 2453b030a28cda2b953758507769c1d436bec5ec45eAnna Zaks std::vector<BugReportEquivClass *> EQClassesVector; 246404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 247cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenekprotected: 2483baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugReporter(BugReporterData& d, Kind k) : BugTypes(F.getEmptySet()), kind(k), 249212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care D(d) {} 250cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 25161f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenekpublic: 2523baf672378f105602d2b12f03f00277ae1936fe9Ted Kremenek BugReporter(BugReporterData& d) : BugTypes(F.getEmptySet()), kind(BaseBRKind), 253212f6d3b5fb3fa55ba1e40671cfc336430abc8ddTom Care D(d) {} 254c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~BugReporter(); 2551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 25638ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Generate and flush diagnostics for all bug reports. 257cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void FlushReports(); 2581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 259c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek Kind getKind() const { return kind; } 2601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 261c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek Diagnostic& getDiagnostic() { 262c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return D.getDiagnostic(); 263c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 2641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 265c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek PathDiagnosticClient* getPathDiagnosticClient() { 266c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return D.getPathDiagnosticClient(); 267c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 2681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 26938ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Iterator over the set of BugTypes tracked by the BugReporter. 2703aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek typedef BugTypesTy::iterator iterator; 2713aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek iterator begin() { return BugTypes.begin(); } 2723aa1ab27c14d16c853ccb61f17a4a75d8e366806Ted Kremenek iterator end() { return BugTypes.end(); } 2731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 27438ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Iterator over the set of BugReports tracked by the BugReporter. 275404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis typedef llvm::FoldingSet<BugReportEquivClass>::iterator EQClasses_iterator; 276404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis EQClasses_iterator EQClasses_begin() { return EQClasses.begin(); } 277404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis EQClasses_iterator EQClasses_end() { return EQClasses.end(); } 278404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 2799c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &getContext() { return D.getASTContext(); } 2801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 281cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek SourceManager& getSourceManager() { return D.getSourceManager(); } 2821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28340406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek virtual void GeneratePathDiagnostic(PathDiagnostic& pathDiagnostic, 284686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<BugReport *> &bugReports) {} 28561f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 286cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void Register(BugType *BT); 2871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28838ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// \brief Add the given report to the set of reports tracked by BugReporter. 28938ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// 29038ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// The reports are usually generated by the checkers. Further, they are 29138ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// folded based on the profile value, which is done to coalesce similar 29238ca02ed9495a3c708fafc7d8b7d87a8cfcfe8f3Anna Zaks /// reports. 293cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek void EmitReport(BugReport *R); 2941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 295686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void EmitBasicReport(StringRef BugName, StringRef BugStr, 2968f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek SourceLocation Loc, 2978f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek SourceRange* RangeBeg, unsigned NumRanges); 2988f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek 299686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void EmitBasicReport(StringRef BugName, StringRef BugCategory, 300686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef BugStr, SourceLocation Loc, 3018c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek SourceRange* RangeBeg, unsigned NumRanges); 3021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 304686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void EmitBasicReport(StringRef BugName, StringRef BugStr, 3058f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek SourceLocation Loc) { 3068f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek EmitBasicReport(BugName, BugStr, Loc, 0, 0); 3078f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek } 3081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 309686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void EmitBasicReport(StringRef BugName, StringRef BugCategory, 310686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef BugStr, SourceLocation Loc) { 31162059e809596a419e6fc3e751b2f0b57b7cc51e7Ted Kremenek EmitBasicReport(BugName, BugCategory, BugStr, Loc, 0, 0); 31262059e809596a419e6fc3e751b2f0b57b7cc51e7Ted Kremenek } 3131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 314686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void EmitBasicReport(StringRef BugName, StringRef BugStr, 3158f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek SourceLocation Loc, SourceRange R) { 3168f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek EmitBasicReport(BugName, BugStr, Loc, &R, 1); 3178f2698621f5090db1dea691059bd0ebd79fb7f14Ted Kremenek } 3181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 319686775deca8b8685eb90801495880e3abdd844c2Chris Lattner void EmitBasicReport(StringRef BugName, StringRef Category, 320686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef BugStr, SourceLocation Loc, 321f0171732efb4647772ad2a45c0f31978b0e34f71Benjamin Kramer SourceRange R) { 3228c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek EmitBasicReport(BugName, Category, BugStr, Loc, &R, 1); 3238c036c7f77d69f96df49219ed0bdbade200d52ebTed Kremenek } 3241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 325c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek static bool classof(const BugReporter* R) { return true; } 326404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 327404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidisprivate: 328404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis llvm::StringMap<BugType *> StrBugTypes; 329404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis 330404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis /// \brief Returns a BugType that is associated with the given name and 331404fc3ad6bd844bf8ce70cbf9974ab297704a122Argyrios Kyrtzidis /// category. 332686775deca8b8685eb90801495880e3abdd844c2Chris Lattner BugType *getBugTypeForName(StringRef name, StringRef category); 333c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek}; 3348966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek 335cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// FIXME: Get rid of GRBugReporter. It's the wrong abstraction. 336c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenekclass GRBugReporter : public BugReporter { 337d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis ExprEngine& Eng; 3382dabd4372c50019fa00aae223ce634e0e754a3f2Ted Kremenek llvm::SmallSet<SymbolRef, 10> NotableSymbols; 3391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 340d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis GRBugReporter(BugReporterData& d, ExprEngine& eng) 341c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek : BugReporter(d, GRBugReporterKind), Eng(eng) {} 3421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 343c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek virtual ~GRBugReporter(); 3441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 345cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getEngine - Return the analysis engine used to analyze a given 346cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// function or method. 347d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis ExprEngine &getEngine() { return Eng; } 348c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 349cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getGraph - Get the exploded graph created by the analysis engine 350cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// for the analyzed method or function. 35138b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu ExplodedGraph &getGraph(); 3521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 353cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// getStateManager - Return the state manager used by the analysis 354cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// engine. 35518c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ProgramStateManager &getStateManager(); 3561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 35740406fe63df2b932d6e9fd021f77f097f9d33afbTed Kremenek virtual void GeneratePathDiagnostic(PathDiagnostic &pathDiagnostic, 358686775deca8b8685eb90801495880e3abdd844c2Chris Lattner SmallVectorImpl<BugReport*> &bugReports); 359c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek 3602dabd4372c50019fa00aae223ce634e0e754a3f2Ted Kremenek void addNotableSymbol(SymbolRef Sym) { 361c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek NotableSymbols.insert(Sym); 362c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 3631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3642dabd4372c50019fa00aae223ce634e0e754a3f2Ted Kremenek bool isNotable(SymbolRef Sym) const { 365c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return (bool) NotableSymbols.count(Sym); 366c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 3671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 368cfdf9b4edf1172728be97d1ae2d95171975f812bTed Kremenek /// classof - Used by isa<>, cast<>, and dyn_cast<>. 369c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek static bool classof(const BugReporter* R) { 370c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek return R->getKind() == GRBugReporterKind; 371c095997b853270d8adb6fe55209a4dbc42803d16Ted Kremenek } 37261f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek}; 3731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3748966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenekclass BugReporterContext { 3758966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek GRBugReporter &BR; 3768966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenekpublic: 3778e6431adab313e283a992698f6fc7afe62420999Anna Zaks BugReporterContext(GRBugReporter& br) : BR(br) {} 3781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3798e6431adab313e283a992698f6fc7afe62420999Anna Zaks virtual ~BugReporterContext() {} 3801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump GRBugReporter& getBugReporter() { return BR; } 3821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 38338b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu ExplodedGraph &getGraph() { return BR.getGraph(); } 3841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3858966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek void addNotableSymbol(SymbolRef Sym) { 3868966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // FIXME: For now forward to GRBugReporter. 3878966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek BR.addNotableSymbol(Sym); 3888966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 3891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3908966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek bool isNotable(SymbolRef Sym) const { 3918966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek // FIXME: For now forward to GRBugReporter. 3928966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.isNotable(Sym); 3938966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 3941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 39518c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ProgramStateManager& getStateManager() { 3968966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getStateManager(); 3978966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 3981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 399c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek SValBuilder& getSValBuilder() { 400c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek return getStateManager().getSValBuilder(); 401dd986cc9989f665370cef0917ba8ba3b4871e3e6Ted Kremenek } 4021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4039c378f705405d37f49795d5e915989de774fe11fTed Kremenek ASTContext &getASTContext() { 4048966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getContext(); 4058966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 4061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4078966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek SourceManager& getSourceManager() { 4088966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek return BR.getSourceManager(); 4098966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek } 4101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump virtual BugReport::NodeResolver& getNodeResolver() = 0; 4128966bc1c8ce271c09936c0eaf6c841aef4a0af1bTed Kremenek}; 413e207558e9dbed963eebf5cf31fdb02616f1545a3Ted Kremenek 4145a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis} // end GR namespace 4155a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 41661f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek} // end clang namespace 41761f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek 41861f3e058056ab519d249aa67e3d52b0ead57c63eTed Kremenek#endif 419