#include "RetainCountDiagnostics.h"
#include "RetainCountChecker.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/SmallVector.h"
#include <optional>

Classes
class	clang::ento::retaincountchecker::RefCountReportVisitor

class	clang::ento::retaincountchecker::RefLeakReportVisitor

Namespaces
namespace	clang
	The JSON file list parser is used to communicate input to InstallAPI.

namespace	clang::ento

namespace	clang::ento::retaincountchecker

Typedefs
using	Bindings = llvm::SmallVector< std::pair< const MemRegion *, SVal >, 4 >

Functions
static bool	isNumericLiteralExpression (const Expr *E)

static std::string	getPrettyTypeName (QualType QT)
	If type represents a pointer to CXXRecordDecl, and is not a typedef, return the decl name.

static bool	shouldGenerateNote (llvm::raw_string_ostream &os, const RefVal *PrevT, const RefVal &CurrV, bool DeallocSent)
	Write information about the type state change to `os`, return whether the note should be generated.

static std::optional< unsigned >	findArgIdxOfSymbol (ProgramStateRef CurrSt, const LocationContext *LCtx, SymbolRef &Sym, std::optional< CallEventRef<> > CE)
	Finds argument index of the out paramter in the call `S` corresponding to the symbol `Sym`.

static std::optional< std::string >	findMetaClassAlloc (const Expr *Callee)

static std::string	findAllocatedObjectName (const Stmt *S, QualType QT)

static void	generateDiagnosticsForCallLike (ProgramStateRef CurrSt, const LocationContext LCtx, const RefVal &CurrV, SymbolRef &Sym, const Stmt S, llvm::raw_string_ostream &os)

static const ExplodedNode *	getCalleeNode (const ExplodedNode *Pred)
	Find the first node with the parent stack frame.

static std::shared_ptr< PathDiagnosticEventPiece >	annotateConsumedSummaryMismatch (const ExplodedNode *N, CallExitBegin &CallExitLoc, const SourceManager &SM, CallEventManager &CEMgr)
	Insert a diagnostic piece at function exit if a function parameter is annotated as "os_consumed", but it does not actually consume the reference.

static std::shared_ptr< PathDiagnosticEventPiece >	annotateStartParameter (const ExplodedNode *N, SymbolRef Sym, const SourceManager &SM)
	Annotate the parameter at the analysis entry point.

static std::optional< std::string >	describeRegion (const MemRegion *MR)

Bindings	getAllVarBindingsForSymbol (ProgramStateManager &Manager, const ExplodedNode *Node, SymbolRef Sym)

static AllocationInfo	GetAllocationSite (ProgramStateManager &StateMgr, const ExplodedNode *N, SymbolRef Sym)

Typedef Documentation

◆ Bindings

using Bindings = llvm::SmallVector<std::pair<const MemRegion *, SVal>, 4>

Examples: /home/buildbot/as-worker-4/publish-doxygen-docs/llvm-project/clang/lib/StaticAnalyzer/Core/RegionStore.cpp.

Definition at line 613 of file RetainCountDiagnostics.cpp.

Function Documentation

◆ annotateConsumedSummaryMismatch()

static std::shared_ptr< PathDiagnosticEventPiece > annotateConsumedSummaryMismatch	(	const ExplodedNode *	N,
		CallExitBegin &	CallExitLoc,
		const SourceManager &	SM,
		CallEventManager &	CEMgr
	)

static

Insert a diagnostic piece at function exit if a function parameter is annotated as "os_consumed", but it does not actually consume the reference.

Definition at line 373 of file RetainCountDiagnostics.cpp.

References clang::Call, clang::ento::PathDiagnosticLocation::create(), clang::Decl::getASTContext(), getCalleeNode(), clang::ento::CallEventManager::getCaller(), clang::ento::retaincountchecker::RefVal::getCount(), clang::NamedDecl::getNameForDiagnostic(), clang::ASTContext::getPrintingPolicy(), clang::ento::retaincountchecker::getRefBinding(), clang::ento::ExplodedNode::getStackFrame(), clang::ento::ExplodedNode::getState(), clang::Decl::hasAttr(), and SM.

Referenced by clang::ento::retaincountchecker::RefCountReportVisitor::VisitNode().

◆ annotateStartParameter()

static std::shared_ptr< PathDiagnosticEventPiece > annotateStartParameter	(	const ExplodedNode *	N,
		SymbolRef	Sym,
		const SourceManager &	SM
	)

static

Annotate the parameter at the analysis entry point.

Definition at line 423 of file RetainCountDiagnostics.cpp.

References clang::ento::retaincountchecker::RefVal::getCount(), clang::CFG::getEntry(), clang::ento::ExplodedNode::getFirstPred(), clang::ento::ExplodedNode::getLocationAs(), clang::CFGBlock::getParent(), clang::ento::retaincountchecker::getRefBinding(), getRegion(), clang::ento::ExplodedNode::getState(), s, and SM.

Referenced by clang::ento::retaincountchecker::RefCountReportVisitor::VisitNode().

◆ describeRegion()

static std::optional< std::string > describeRegion ( const MemRegion * MR )

static

Definition at line 605 of file RetainCountDiagnostics.cpp.

Referenced by clang::ento::retaincountchecker::RefLeakReportVisitor::getEndPath().

◆ findAllocatedObjectName()

static std::string findAllocatedObjectName	(	const Stmt *	S,
		QualType	QT
	)

static

Definition at line 203 of file RetainCountDiagnostics.cpp.

References findMetaClassAlloc(), and getPrettyTypeName().

Referenced by generateDiagnosticsForCallLike().

◆ findArgIdxOfSymbol()

static std::optional< unsigned > findArgIdxOfSymbol	(	ProgramStateRef	CurrSt,
		const LocationContext *	LCtx,
		SymbolRef &	Sym,
		std::optional< CallEventRef<> >	CE
	)

static

Finds argument index of the out paramter in the call S corresponding to the symbol Sym.

If none found, returns std::nullopt.

Definition at line 171 of file RetainCountDiagnostics.cpp.

Referenced by generateDiagnosticsForCallLike().

◆ findMetaClassAlloc()

static std::optional< std::string > findMetaClassAlloc ( const Expr * Callee )

static

Definition at line 185 of file RetainCountDiagnostics.cpp.

References clang::Decl::getDeclContext(), and clang::NamedDecl::getNameAsString().

Referenced by findAllocatedObjectName().

◆ generateDiagnosticsForCallLike()

static void generateDiagnosticsForCallLike	(	ProgramStateRef	CurrSt,
		const LocationContext *	LCtx,
		const RefVal &	CurrV,
		SymbolRef &	Sym,
		const Stmt *	S,
		llvm::raw_string_ostream &	os
	)