#include "clang/StaticAnalyzer/Core/CheckerManager.h"

Public Types
using	CheckerRef = CheckerBase *

using	CheckerTag = const void *

using	CheckerDtor = CheckerFn< void()>

using	CheckDeclFunc = CheckerFn< void(const Decl *, AnalysisManager &, BugReporter &)>

using	HandlesDeclFunc = bool()(const Decl D)

using	CheckStmtFunc = CheckerFn< void(const Stmt *, CheckerContext &)>

using	CheckObjCMessageFunc = CheckerFn< void(const ObjCMethodCall &, CheckerContext &)>

using	CheckCallFunc = CheckerFn< void(const CallEvent &, CheckerContext &)>

using	CheckLocationFunc = CheckerFn< void(SVal location, bool isLoad, const Stmt *S, CheckerContext &)>

using	CheckBindFunc = CheckerFn< void(SVal location, SVal val, const Stmt *S, CheckerContext &)>

using	CheckEndAnalysisFunc = CheckerFn< void(ExplodedGraph &, BugReporter &, ExprEngine &)>

using	CheckBeginFunctionFunc = CheckerFn< void(CheckerContext &)>

using	CheckEndFunctionFunc = CheckerFn< void(const ReturnStmt *, CheckerContext &)>

using	CheckBranchConditionFunc = CheckerFn< void(const Stmt *, CheckerContext &)>

using	CheckNewAllocatorFunc = CheckerFn< void(const CXXAllocatorCall &Call, CheckerContext &)>

using	CheckDeadSymbolsFunc = CheckerFn< void(SymbolReaper &, CheckerContext &)>

using	CheckLiveSymbolsFunc = CheckerFn< void(ProgramStateRef, SymbolReaper &)>

using	CheckRegionChangesFunc = CheckerFn< ProgramStateRef(ProgramStateRef, const InvalidatedSymbols symbols, ArrayRef< const MemRegion > ExplicitRegions, ArrayRef< const MemRegion * > Regions, const LocationContext LCtx, const CallEvent Call)>

using	CheckPointerEscapeFunc = CheckerFn< ProgramStateRef(ProgramStateRef, const InvalidatedSymbols &Escaped, const CallEvent Call, PointerEscapeKind Kind, RegionAndSymbolInvalidationTraits ITraits)>

using	EvalAssumeFunc = CheckerFn< ProgramStateRef(ProgramStateRef, SVal cond, bool assumption)>

using	EvalCallFunc = CheckerFn< bool(const CallEvent &, CheckerContext &)>

using	CheckEndOfTranslationUnit = CheckerFn< void(const TranslationUnitDecl *, AnalysisManager &, BugReporter &)>

using	HandlesStmtFunc = bool()(const Stmt D)

using	EventTag = void *

using	CheckEventFunc = CheckerFn< void(const void *event)>

Public Member Functions
	CheckerManager (ASTContext &Context, AnalyzerOptions &AOptions, const Preprocessor &PP, ArrayRef< std::string > plugins, ArrayRef< std::function< void(CheckerRegistry &)> > checkerRegistrationFns)

	CheckerManager (ASTContext &Context, AnalyzerOptions &AOptions, const Preprocessor &PP)
	Constructs a CheckerManager that ignores all non TblGen-generated checkers.

	CheckerManager (AnalyzerOptions &AOptions, const LangOptions &LangOpts, DiagnosticsEngine &Diags, ArrayRef< std::string > plugins)
	Constructs a CheckerManager without requiring an AST.

	~CheckerManager ()

void	setCurrentCheckerName (CheckerNameRef name)

CheckerNameRef	getCurrentCheckerName () const

bool	hasPathSensitiveCheckers () const

const LangOptions &	getLangOpts () const

const AnalyzerOptions &	getAnalyzerOptions () const

const Preprocessor &	getPreprocessor () const

const CheckerRegistryData &	getCheckerRegistryData () const

DiagnosticsEngine &	getDiagnostics () const

ASTContext &	getASTContext () const

void	reportInvalidCheckerOptionValue (const CheckerBase *C, StringRef OptionName, StringRef ExpectedValueDesc) const
	Emits an error through a DiagnosticsEngine about an invalid user supplied checker option value.

template<typename CHECKER , typename... AT>
CHECKER *	registerChecker (AT &&... Args)
	Used to register checkers.

template<typename CHECKER >
CHECKER *	getChecker ()

template<typename CHECKER >
bool	isRegisteredChecker ()

void	runCheckersOnASTDecl (const Decl *D, AnalysisManager &mgr, BugReporter &BR)
	Run checkers handling Decls.

void	runCheckersOnASTBody (const Decl *D, AnalysisManager &mgr, BugReporter &BR)
	Run checkers handling Decls containing a Stmt body.

void	runCheckersForPreStmt (ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, const Stmt *S, ExprEngine &Eng)
	Run checkers for pre-visiting Stmts.

void	runCheckersForPostStmt (ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, const Stmt *S, ExprEngine &Eng, bool wasInlined=false)
	Run checkers for post-visiting Stmts.

void	runCheckersForStmt (bool isPreVisit, ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, const Stmt *S, ExprEngine &Eng, bool wasInlined=false)
	Run checkers for visiting Stmts.

void	runCheckersForPreObjCMessage (ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, const ObjCMethodCall &msg, ExprEngine &Eng)
	Run checkers for pre-visiting obj-c messages.

void	runCheckersForPostObjCMessage (ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, const ObjCMethodCall &msg, ExprEngine &Eng, bool wasInlined=false)
	Run checkers for post-visiting obj-c messages.

void	runCheckersForObjCMessageNil (ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, const ObjCMethodCall &msg, ExprEngine &Eng)
	Run checkers for visiting an obj-c message to nil.

void	runCheckersForObjCMessage (ObjCMessageVisitKind visitKind, ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, const ObjCMethodCall &msg, ExprEngine &Eng, bool wasInlined=false)
	Run checkers for visiting obj-c messages.

void	runCheckersForPreCall (ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, const CallEvent &Call, ExprEngine &Eng)
	Run checkers for pre-visiting obj-c messages.

void	runCheckersForPostCall (ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, const CallEvent &Call, ExprEngine &Eng, bool wasInlined=false)
	Run checkers for post-visiting obj-c messages.

void	runCheckersForCallEvent (bool isPreVisit, ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, const CallEvent &Call, ExprEngine &Eng, bool wasInlined=false)
	Run checkers for visiting obj-c messages.

void	runCheckersForLocation (ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, SVal location, bool isLoad, const Stmt NodeEx, const Stmt BoundEx, ExprEngine &Eng)
	Run checkers for load/store of a location.

void	runCheckersForBind (ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, SVal location, SVal val, const Stmt *S, ExprEngine &Eng, const ProgramPoint &PP)
	Run checkers for binding of a value to a location.

void	runCheckersForEndAnalysis (ExplodedGraph &G, BugReporter &BR, ExprEngine &Eng)
	Run checkers for end of analysis.

void	runCheckersForBeginFunction (ExplodedNodeSet &Dst, const BlockEdge &L, ExplodedNode *Pred, ExprEngine &Eng)
	Run checkers on beginning of function.

void	runCheckersForEndFunction (NodeBuilderContext &BC, ExplodedNodeSet &Dst, ExplodedNode Pred, ExprEngine &Eng, const ReturnStmt RS)
	Run checkers on end of function.

void	runCheckersForBranchCondition (const Stmt condition, ExplodedNodeSet &Dst, ExplodedNode Pred, ExprEngine &Eng)
	Run checkers for branch condition.

void	runCheckersForNewAllocator (const CXXAllocatorCall &Call, ExplodedNodeSet &Dst, ExplodedNode *Pred, ExprEngine &Eng, bool wasInlined=false)
	Run checkers between C++ operator new and constructor calls.

void	runCheckersForLiveSymbols (ProgramStateRef state, SymbolReaper &SymReaper)
	Run checkers for live symbols.

void	runCheckersForDeadSymbols (ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, SymbolReaper &SymReaper, const Stmt *S, ExprEngine &Eng, ProgramPoint::Kind K)
	Run checkers for dead symbols.

ProgramStateRef	runCheckersForRegionChanges (ProgramStateRef state, const InvalidatedSymbols invalidated, ArrayRef< const MemRegion > ExplicitRegions, ArrayRef< const MemRegion * > Regions, const LocationContext LCtx, const CallEvent Call)
	Run checkers for region changes.

ProgramStateRef	runCheckersForPointerEscape (ProgramStateRef State, const InvalidatedSymbols &Escaped, const CallEvent Call, PointerEscapeKind Kind, RegionAndSymbolInvalidationTraits ITraits)
	Run checkers when pointers escape.

ProgramStateRef	runCheckersForEvalAssume (ProgramStateRef state, SVal Cond, bool Assumption)
	Run checkers for handling assumptions on symbolic values.

void	runCheckersForEvalCall (ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, const CallEvent &CE, ExprEngine &Eng, const EvalCallOptions &CallOpts)
	Run checkers for evaluating a call.

void	runCheckersOnEndOfTranslationUnit (const TranslationUnitDecl *TU, AnalysisManager &mgr, BugReporter &BR)
	Run checkers for the entire Translation Unit.

void	runCheckersForPrintStateJson (raw_ostream &Out, ProgramStateRef State, const char *NL="\n", unsigned int Space=0, bool IsDot=false) const
	Run checkers for debug-printing a ProgramState.

void	_registerForDecl (CheckDeclFunc checkfn, HandlesDeclFunc isForDeclFn)

void	_registerForBody (CheckDeclFunc checkfn)

void	_registerForPreStmt (CheckStmtFunc checkfn, HandlesStmtFunc isForStmtFn)

void	_registerForPostStmt (CheckStmtFunc checkfn, HandlesStmtFunc isForStmtFn)

void	_registerForPreObjCMessage (CheckObjCMessageFunc checkfn)

void	_registerForPostObjCMessage (CheckObjCMessageFunc checkfn)

void	_registerForObjCMessageNil (CheckObjCMessageFunc checkfn)

void	_registerForPreCall (CheckCallFunc checkfn)

void	_registerForPostCall (CheckCallFunc checkfn)

void	_registerForLocation (CheckLocationFunc checkfn)

void	_registerForBind (CheckBindFunc checkfn)

void	_registerForEndAnalysis (CheckEndAnalysisFunc checkfn)

void	_registerForBeginFunction (CheckBeginFunctionFunc checkfn)

void	_registerForEndFunction (CheckEndFunctionFunc checkfn)

void	_registerForBranchCondition (CheckBranchConditionFunc checkfn)

void	_registerForNewAllocator (CheckNewAllocatorFunc checkfn)

void	_registerForLiveSymbols (CheckLiveSymbolsFunc checkfn)

void	_registerForDeadSymbols (CheckDeadSymbolsFunc checkfn)

void	_registerForRegionChanges (CheckRegionChangesFunc checkfn)

void	_registerForPointerEscape (CheckPointerEscapeFunc checkfn)

void	_registerForConstPointerEscape (CheckPointerEscapeFunc checkfn)

void	_registerForEvalAssume (EvalAssumeFunc checkfn)

void	_registerForEvalCall (EvalCallFunc checkfn)

void	_registerForEndOfTranslationUnit (CheckEndOfTranslationUnit checkfn)

template<typename EVENT >
void	_registerListenerForEvent (CheckEventFunc checkfn)

template<typename EVENT >
void	_registerDispatcherForEvent ()

template<typename EVENT >
void	_dispatchEvent (const EVENT &event) const

Detailed Description

Definition at line 126 of file CheckerManager.h.

Member Typedef Documentation

◆ CheckBeginFunctionFunc

using clang::ento::CheckerManager::CheckBeginFunctionFunc = CheckerFn<void (CheckerContext &)>

Definition at line 502 of file CheckerManager.h.

◆ CheckBindFunc

using clang::ento::CheckerManager::CheckBindFunc = CheckerFn<void(SVal location, SVal val, const Stmt *S, CheckerContext &)>

Definition at line 496 of file CheckerManager.h.

◆ CheckBranchConditionFunc

using clang::ento::CheckerManager::CheckBranchConditionFunc = CheckerFn<void (const Stmt *, CheckerContext &)>

Definition at line 507 of file CheckerManager.h.

◆ CheckCallFunc

using clang::ento::CheckerManager::CheckCallFunc = CheckerFn<void (const CallEvent &, CheckerContext &)>

Definition at line 490 of file CheckerManager.h.

◆ CheckDeadSymbolsFunc

using clang::ento::CheckerManager::CheckDeadSymbolsFunc = CheckerFn<void (SymbolReaper &, CheckerContext &)>

Definition at line 513 of file CheckerManager.h.

◆ CheckDeclFunc

using clang::ento::CheckerManager::CheckDeclFunc = CheckerFn<void (const Decl *, AnalysisManager&, BugReporter &)>

Definition at line 472 of file CheckerManager.h.

◆ CheckEndAnalysisFunc

using clang::ento::CheckerManager::CheckEndAnalysisFunc = CheckerFn<void (ExplodedGraph &, BugReporter &, ExprEngine &)>

Definition at line 499 of file CheckerManager.h.

◆ CheckEndFunctionFunc

using clang::ento::CheckerManager::CheckEndFunctionFunc = CheckerFn<void (const ReturnStmt *, CheckerContext &)>

Definition at line 504 of file CheckerManager.h.

◆ CheckEndOfTranslationUnit

using clang::ento::CheckerManager::CheckEndOfTranslationUnit = CheckerFn<void (const TranslationUnitDecl *, AnalysisManager &, BugReporter &)>

Definition at line 537 of file CheckerManager.h.

◆ CheckerDtor

using clang::ento::CheckerManager::CheckerDtor = CheckerFn<void ()>

Definition at line 190 of file CheckerManager.h.

◆ CheckerRef

using clang::ento::CheckerManager::CheckerRef = CheckerBase *

Definition at line 188 of file CheckerManager.h.

◆ CheckerTag

using clang::ento::CheckerManager::CheckerTag = const void *

Definition at line 189 of file CheckerManager.h.

◆ CheckEventFunc

using clang::ento::CheckerManager::CheckEventFunc = CheckerFn<void (const void *event)>

Definition at line 590 of file CheckerManager.h.

◆ CheckLiveSymbolsFunc

using clang::ento::CheckerManager::CheckLiveSymbolsFunc = CheckerFn<void (ProgramStateRef,SymbolReaper &)>

Definition at line 516 of file CheckerManager.h.

◆ CheckLocationFunc

using clang::ento::CheckerManager::CheckLocationFunc = CheckerFn<void(SVal location, bool isLoad, const Stmt *S, CheckerContext &)>

Definition at line 493 of file CheckerManager.h.

◆ CheckNewAllocatorFunc

using clang::ento::CheckerManager::CheckNewAllocatorFunc = CheckerFn<void(const CXXAllocatorCall &Call, CheckerContext &)>

Definition at line 510 of file CheckerManager.h.

◆ CheckObjCMessageFunc

using clang::ento::CheckerManager::CheckObjCMessageFunc = CheckerFn<void (const ObjCMethodCall &, CheckerContext &)>

Definition at line 487 of file CheckerManager.h.

◆ CheckPointerEscapeFunc

using clang::ento::CheckerManager::CheckPointerEscapeFunc = CheckerFn<ProgramStateRef (ProgramStateRef, const InvalidatedSymbols &Escaped, const CallEvent *Call, PointerEscapeKind Kind, RegionAndSymbolInvalidationTraits *ITraits)>

Definition at line 526 of file CheckerManager.h.

◆ CheckRegionChangesFunc

using clang::ento::CheckerManager::CheckRegionChangesFunc = CheckerFn<ProgramStateRef (ProgramStateRef, const InvalidatedSymbols *symbols, ArrayRef<const MemRegion *> ExplicitRegions, ArrayRef<const MemRegion *> Regions, const LocationContext *LCtx, const CallEvent *Call)>

Definition at line 518 of file CheckerManager.h.

◆ CheckStmtFunc

using clang::ento::CheckerManager::CheckStmtFunc = CheckerFn<void (const Stmt *, CheckerContext &)>

Definition at line 485 of file CheckerManager.h.

◆ EvalAssumeFunc

using clang::ento::CheckerManager::EvalAssumeFunc = CheckerFn<ProgramStateRef(ProgramStateRef, SVal cond, bool assumption)>

Definition at line 532 of file CheckerManager.h.

◆ EvalCallFunc

using clang::ento::CheckerManager::EvalCallFunc = CheckerFn<bool (const CallEvent &, CheckerContext &)>

Definition at line 535 of file CheckerManager.h.

◆ EventTag

using clang::ento::CheckerManager::EventTag = void *

Definition at line 589 of file CheckerManager.h.

◆ HandlesDeclFunc

using clang::ento::CheckerManager::HandlesDeclFunc = bool (*)(const Decl *D)

Definition at line 475 of file CheckerManager.h.

◆ HandlesStmtFunc

using clang::ento::CheckerManager::HandlesStmtFunc = bool (*)(const Stmt *D)

Definition at line 541 of file CheckerManager.h.

Constructor & Destructor Documentation

◆ CheckerManager() [1/3]

clang::ento::CheckerManager::CheckerManager	(	ASTContext &	Context,
		AnalyzerOptions &	AOptions,
		const Preprocessor &	PP,
		ArrayRef< std::string >	plugins,
		ArrayRef< std::function< void(CheckerRegistry &)> >	checkerRegistrationFns
	)

Definition at line 20 of file CreateCheckerManager.cpp.

References clang::ento::CheckerRegistry::initializeRegistry().

◆ CheckerManager() [2/3]

clang::ento::CheckerManager::CheckerManager	(	ASTContext &	Context,
		AnalyzerOptions &	AOptions,
		const Preprocessor &	PP
	)

inline

Constructs a CheckerManager that ignores all non TblGen-generated checkers.

Useful for unit testing, unless the checker infrastructure itself is tested.

Definition at line 150 of file CheckerManager.h.

◆ CheckerManager() [3/3]

clang::ento::CheckerManager::CheckerManager	(	AnalyzerOptions &	AOptions,
		const LangOptions &	LangOpts,
		DiagnosticsEngine &	Diags,
		ArrayRef< std::string >	plugins
	)

Constructs a CheckerManager without requiring an AST.

No checker registration will take place. Only useful when one needs to print the help flags through CheckerRegistryData, and the AST is unavailable.

Definition at line 33 of file CreateCheckerManager.cpp.

References clang::ento::CheckerRegistry::initializeRegistry().

◆ ~CheckerManager()

clang::ento::CheckerManager::~CheckerManager ( )

Definition at line 43 of file CreateCheckerManager.cpp.

Member Function Documentation

◆ _dispatchEvent()

template<typename EVENT >

void clang::ento::CheckerManager::_dispatchEvent ( const EVENT & event ) const

inline

Definition at line 605 of file CheckerManager.h.

Referenced by clang::ento::EventDispatcher< EVENT >::dispatchEvent().

◆ _registerDispatcherForEvent()

template<typename EVENT >

void clang::ento::CheckerManager::_registerDispatcherForEvent ( )

inline

Definition at line 599 of file CheckerManager.h.

Referenced by clang::ento::EventDispatcher< EVENT >::_register().

◆ _registerForBeginFunction()

void CheckerManager::_registerForBeginFunction ( CheckBeginFunctionFunc checkfn )

Definition at line 836 of file CheckerManager.cpp.

Referenced by clang::ento::check::BeginFunction::_register().

◆ _registerForBind()

void CheckerManager::_registerForBind ( CheckBindFunc checkfn )

Definition at line 828 of file CheckerManager.cpp.

Referenced by clang::ento::check::Bind::_register().

◆ _registerForBody()

void CheckerManager::_registerForBody ( CheckDeclFunc checkfn )

Definition at line 785 of file CheckerManager.cpp.

Referenced by clang::ento::check::ASTCodeBody::_register().

◆ _registerForBranchCondition()

void CheckerManager::_registerForBranchCondition ( CheckBranchConditionFunc checkfn )

Definition at line 844 of file CheckerManager.cpp.

Referenced by clang::ento::check::BranchCondition::_register().

◆ _registerForConstPointerEscape()

void CheckerManager::_registerForConstPointerEscape ( CheckPointerEscapeFunc checkfn )

Definition at line 869 of file CheckerManager.cpp.

◆ _registerForDeadSymbols()

void CheckerManager::_registerForDeadSymbols ( CheckDeadSymbolsFunc checkfn )

Definition at line 857 of file CheckerManager.cpp.

Referenced by clang::ento::check::DeadSymbols::_register().

◆ _registerForDecl()

void CheckerManager::_registerForDecl	(	CheckDeclFunc	checkfn,
		HandlesDeclFunc	isForDeclFn
	)

Definition at line 779 of file CheckerManager.cpp.

Referenced by clang::ento::check::ASTDecl< DECL >::_register().

◆ _registerForEndAnalysis()

void CheckerManager::_registerForEndAnalysis ( CheckEndAnalysisFunc checkfn )

Definition at line 832 of file CheckerManager.cpp.

Referenced by clang::ento::check::EndAnalysis::_register().

◆ _registerForEndFunction()

void CheckerManager::_registerForEndFunction ( CheckEndFunctionFunc checkfn )

Definition at line 840 of file CheckerManager.cpp.

Referenced by clang::ento::check::EndFunction::_register().

◆ _registerForEndOfTranslationUnit()

void CheckerManager::_registerForEndOfTranslationUnit ( CheckEndOfTranslationUnit checkfn )

Definition at line 882 of file CheckerManager.cpp.

Referenced by clang::ento::check::EndOfTranslationUnit::_register().

◆ _registerForEvalAssume()

void CheckerManager::_registerForEvalAssume ( EvalAssumeFunc checkfn )

Definition at line 874 of file CheckerManager.cpp.

Referenced by clang::ento::eval::Assume::_register().

◆ _registerForEvalCall()

void CheckerManager::_registerForEvalCall ( EvalCallFunc checkfn )

Definition at line 878 of file CheckerManager.cpp.

Referenced by clang::ento::eval::Call::_register().

◆ _registerForLiveSymbols()

void CheckerManager::_registerForLiveSymbols ( CheckLiveSymbolsFunc checkfn )

Definition at line 853 of file CheckerManager.cpp.

Referenced by clang::ento::check::LiveSymbols::_register().

◆ _registerForLocation()

void CheckerManager::_registerForLocation ( CheckLocationFunc checkfn )

Definition at line 824 of file CheckerManager.cpp.

Referenced by clang::ento::check::Location::_register().

◆ _registerForNewAllocator()

void CheckerManager::_registerForNewAllocator ( CheckNewAllocatorFunc checkfn )

Definition at line 849 of file CheckerManager.cpp.

Referenced by clang::ento::check::NewAllocator::_register().

◆ _registerForObjCMessageNil()

void CheckerManager::_registerForObjCMessageNil ( CheckObjCMessageFunc checkfn )

Definition at line 809 of file CheckerManager.cpp.

Referenced by clang::ento::check::ObjCMessageNil::_register().

◆ _registerForPointerEscape()

void CheckerManager::_registerForPointerEscape ( CheckPointerEscapeFunc checkfn )

Definition at line 865 of file CheckerManager.cpp.

Referenced by clang::ento::check::PointerEscape::_register(), and clang::ento::check::ConstPointerEscape::_register().

◆ _registerForPostCall()

void CheckerManager::_registerForPostCall ( CheckCallFunc checkfn )

Definition at line 820 of file CheckerManager.cpp.

Referenced by clang::ento::check::PostCall::_register().

◆ _registerForPostObjCMessage()

void CheckerManager::_registerForPostObjCMessage ( CheckObjCMessageFunc checkfn )

Definition at line 813 of file CheckerManager.cpp.

Referenced by clang::ento::check::PostObjCMessage::_register().

◆ _registerForPostStmt()

void CheckerManager::_registerForPostStmt	(	CheckStmtFunc	checkfn,
		HandlesStmtFunc	isForStmtFn
	)

Definition at line 799 of file CheckerManager.cpp.

Referenced by clang::ento::check::PostStmt< STMT >::_register().

◆ _registerForPreCall()

void CheckerManager::_registerForPreCall ( CheckCallFunc checkfn )

Definition at line 817 of file CheckerManager.cpp.

Referenced by clang::ento::check::PreCall::_register().

◆ _registerForPreObjCMessage()

void CheckerManager::_registerForPreObjCMessage ( CheckObjCMessageFunc checkfn )

Definition at line 805 of file CheckerManager.cpp.

Referenced by clang::ento::check::PreObjCMessage::_register().

◆ _registerForPreStmt()

void CheckerManager::_registerForPreStmt	(	CheckStmtFunc	checkfn,
		HandlesStmtFunc	isForStmtFn
	)

Definition at line 793 of file CheckerManager.cpp.

Referenced by clang::ento::check::PreStmt< STMT >::_register().

◆ _registerForRegionChanges()

void CheckerManager::_registerForRegionChanges ( CheckRegionChangesFunc checkfn )

Definition at line 861 of file CheckerManager.cpp.

Referenced by clang::ento::check::RegionChanges::_register().

◆ _registerListenerForEvent()

template<typename EVENT >

void clang::ento::CheckerManager::_registerListenerForEvent ( CheckEventFunc checkfn )

inline

Definition at line 593 of file CheckerManager.h.

Referenced by clang::ento::check::Event< EVENT >::_register().

◆ getAnalyzerOptions()

const AnalyzerOptions & clang::ento::CheckerManager::getAnalyzerOptions ( ) const

inline

Definition at line 168 of file CheckerManager.h.

◆ getASTContext()

ASTContext & clang::ento::CheckerManager::getASTContext ( ) const

inline

Definition at line 177 of file CheckerManager.h.

◆ getChecker()

template<typename CHECKER >

CHECKER * clang::ento::CheckerManager::getChecker ( )

inline

Definition at line 216 of file CheckerManager.h.

References CHECKER.

Referenced by clang::ento::registerInnerPointerCheckerAux().

◆ getCheckerRegistryData()

const CheckerRegistryData & clang::ento::CheckerManager::getCheckerRegistryData ( ) const

inline

Definition at line 173 of file CheckerManager.h.

◆ getCurrentCheckerName()

CheckerNameRef clang::ento::CheckerManager::getCurrentCheckerName ( ) const

inline

Definition at line 163 of file CheckerManager.h.

Referenced by clang::ento::registerInnerPointerCheckerAux().

◆ getDiagnostics()

DiagnosticsEngine & clang::ento::CheckerManager::getDiagnostics ( ) const

inline

Definition at line 176 of file CheckerManager.h.

Referenced by reportInvalidCheckerOptionValue().

◆ getLangOpts()

const LangOptions & clang::ento::CheckerManager::getLangOpts ( ) const

inline

Definition at line 167 of file CheckerManager.h.

◆ getPreprocessor()

const Preprocessor & clang::ento::CheckerManager::getPreprocessor ( ) const

inline

Definition at line 169 of file CheckerManager.h.

◆ hasPathSensitiveCheckers()

bool CheckerManager::hasPathSensitiveCheckers ( ) const

Definition at line 37 of file CheckerManager.cpp.

◆ isRegisteredChecker()

template<typename CHECKER >

bool clang::ento::CheckerManager::isRegisteredChecker ( )

inline

Definition at line 224 of file CheckerManager.h.

◆ registerChecker()

template<typename CHECKER , typename... AT>

CHECKER * clang::ento::CheckerManager::registerChecker ( AT &&... Args )

inline

Used to register checkers.

All arguments are automatically passed through to the checker constructor.

Returns: a pointer to the checker object.

Definition at line 202 of file CheckerManager.h.

References CHECKER.

Referenced by clang::ento::registerCheckerDocumentationChecker().

◆ reportInvalidCheckerOptionValue()

void CheckerManager::reportInvalidCheckerOptionValue	(	const CheckerBase *	C,
		StringRef	OptionName,
		StringRef	ExpectedValueDesc
	)		const

Emits an error through a DiagnosticsEngine about an invalid user supplied checker option value.

Definition at line 51 of file CheckerManager.cpp.

References clang::C, getDiagnostics(), and clang::DiagnosticsEngine::Report().

Referenced by clang::ento::getConfiguration().

◆ runCheckersForBeginFunction()

void CheckerManager::runCheckersForBeginFunction	(	ExplodedNodeSet &	Dst,
		const BlockEdge &	L,
		ExplodedNode *	Pred,
		ExprEngine &	Eng
	)

Run checkers on beginning of function.

Definition at line 421 of file CheckerManager.cpp.

References clang::C, expandGraphWithCheckers(), and clang::ento::ExplodedNodeSet::insert().

Referenced by clang::ento::ExprEngine::processBeginOfFunction().

◆ runCheckersForBind()

void CheckerManager::runCheckersForBind	(	ExplodedNodeSet &	Dst,
		const ExplodedNodeSet &	Src,
		SVal	location,
		SVal	val,
		const Stmt *	S,
		ExprEngine &	Eng,
		const ProgramPoint &	PP
	)

Run checkers for binding of a value to a location.

Definition at line 378 of file CheckerManager.cpp.

References clang::C, and expandGraphWithCheckers().

◆ runCheckersForBranchCondition()

void CheckerManager::runCheckersForBranchCondition	(	const Stmt *	condition,
		ExplodedNodeSet &	Dst,
		ExplodedNode *	Pred,
		ExprEngine &	Eng
	)

Run checkers for branch condition.

Definition at line 479 of file CheckerManager.cpp.

References clang::C, clang::Condition, expandGraphWithCheckers(), and clang::ento::ExplodedNodeSet::insert().

Referenced by clang::ento::ExprEngine::processBranch().

◆ runCheckersForCallEvent()

void CheckerManager::runCheckersForCallEvent	(	bool	isPreVisit,
		ExplodedNodeSet &	Dst,
		const ExplodedNodeSet &	Src,
		const CallEvent &	Call,
		ExprEngine &	Eng,
		bool	wasInlined = `false`
	)

Run checkers for visiting obj-c messages.

Run checkers for visiting an abstract call event.

Definition at line 283 of file CheckerManager.cpp.

References clang::C, clang::Call, and expandGraphWithCheckers().

Referenced by runCheckersForPostCall(), and runCheckersForPreCall().

◆ runCheckersForDeadSymbols()

void CheckerManager::runCheckersForDeadSymbols	(	ExplodedNodeSet &	Dst,
		const ExplodedNodeSet &	Src,
		SymbolReaper &	SymReaper,
		const Stmt *	S,
		ExprEngine &	Eng,
		ProgramPoint::Kind	K
	)

Run checkers for dead symbols.

Notifies checkers when symbols become dead. For example, this allows checkers to aggressively clean up/reduce the checker state and produce precise diagnostics.

Definition at line 572 of file CheckerManager.cpp.

References clang::C, and expandGraphWithCheckers().

Referenced by clang::ento::ExprEngine::removeDead().

◆ runCheckersForEndAnalysis()

void CheckerManager::runCheckersForEndAnalysis	(	ExplodedGraph &	G,
		BugReporter &	BR,
		ExprEngine &	Eng
	)

Run checkers for end of analysis.

Definition at line 387 of file CheckerManager.cpp.

Referenced by clang::ento::ExprEngine::processEndWorklist().

◆ runCheckersForEndFunction()

void CheckerManager::runCheckersForEndFunction	(	NodeBuilderContext &	BC,
		ExplodedNodeSet &	Dst,
		ExplodedNode *	Pred,
		ExprEngine &	Eng,
		const ReturnStmt *	RS
	)

Run checkers on end of function.

Run checkers for end of path.

Definition at line 434 of file CheckerManager.cpp.

References clang::C, and clang::ento::ExplodedNode::getLocationContext().

Referenced by clang::ento::ExprEngine::processEndOfFunction().

◆ runCheckersForEvalAssume()

ProgramStateRef CheckerManager::runCheckersForEvalAssume	(	ProgramStateRef	state,
		SVal	Cond,
		bool	Assumption
	)

Run checkers for handling assumptions on symbolic values.

Definition at line 624 of file CheckerManager.cpp.

Referenced by clang::ento::ExprEngine::processAssume().

◆ runCheckersForEvalCall()

void CheckerManager::runCheckersForEvalCall	(	ExplodedNodeSet &	Dst,
		const ExplodedNodeSet &	Src,
		const CallEvent &	Call,
		ExprEngine &	Eng,
		const EvalCallOptions &	CallOpts
	)

Run checkers for evaluating a call.

Warning: Currently, the CallEvent MUST come from a CallExpr!

Only one checker will evaluate the call.

Definition at line 638 of file CheckerManager.cpp.

References clang::C, clang::Call, clang::ento::ExprEngine::defaultEvalCall(), clang::ento::ExprEngine::getBuilderContext(), clang::ProgramPoint::getProgramPoint(), clang::ento::ExplodedNodeSet::insert(), clang::ento::OS, clang::ProgramPoint::PostStmtKind, and toString().

Referenced by clang::ento::ExprEngine::evalCall().

◆ runCheckersForLiveSymbols()

void CheckerManager::runCheckersForLiveSymbols	(	ProgramStateRef	state,
		SymbolReaper &	SymReaper
	)

Run checkers for live symbols.

Allows modifying SymbolReaper object. For example, checkers can explicitly register symbols of interest as live. These symbols will not be marked dead and removed.

Definition at line 531 of file CheckerManager.cpp.

Referenced by clang::ento::ExprEngine::removeDead().

◆ runCheckersForLocation()

void CheckerManager::runCheckersForLocation	(	ExplodedNodeSet &	Dst,
		const ExplodedNodeSet &	Src,
		SVal	location,
		bool	isLoad,
		const Stmt *	NodeEx,
		const Stmt *	BoundEx,
		ExprEngine &	Eng
	)

Run checkers for load/store of a location.

Definition at line 335 of file CheckerManager.cpp.

References clang::C, and expandGraphWithCheckers().

◆ runCheckersForNewAllocator()

void CheckerManager::runCheckersForNewAllocator	(	const CXXAllocatorCall &	Call,
		ExplodedNodeSet &	Dst,
		ExplodedNode *	Pred,
		ExprEngine &	Eng,
		bool	wasInlined = `false`
	)

Run checkers between C++ operator new and constructor calls.

Definition at line 519 of file CheckerManager.cpp.

References clang::C, clang::Call, expandGraphWithCheckers(), and clang::ento::ExplodedNodeSet::insert().

Referenced by clang::ento::ExprEngine::processCallExit(), and clang::ento::ExprEngine::VisitCXXNewAllocatorCall().

◆ runCheckersForObjCMessage()

void CheckerManager::runCheckersForObjCMessage	(	ObjCMessageVisitKind	visitKind,
		ExplodedNodeSet &	Dst,
		const ExplodedNodeSet &	Src,
		const ObjCMethodCall &	msg,
		ExprEngine &	Eng,
		bool	wasInlined = `false`
	)

Run checkers for visiting obj-c messages.

Definition at line 225 of file CheckerManager.cpp.

References clang::C, and expandGraphWithCheckers().

Referenced by runCheckersForObjCMessageNil(), runCheckersForPostObjCMessage(), and runCheckersForPreObjCMessage().

◆ runCheckersForObjCMessageNil()

void clang::ento::CheckerManager::runCheckersForObjCMessageNil	(	ExplodedNodeSet &	Dst,
		const ExplodedNodeSet &	Src,
		const ObjCMethodCall &	msg,
		ExprEngine &	Eng
	)

inline

Run checkers for visiting an obj-c message to nil.

Definition at line 296 of file CheckerManager.h.

References clang::ento::MessageNil, and runCheckersForObjCMessage().

Referenced by clang::ento::ExprEngine::VisitObjCMessage().

◆ runCheckersForPointerEscape()

ProgramStateRef CheckerManager::runCheckersForPointerEscape	(	ProgramStateRef	State,
		const InvalidatedSymbols &	Escaped,
		const CallEvent *	Call,
		PointerEscapeKind	Kind,
		RegionAndSymbolInvalidationTraits *	ITraits
	)

Run checkers when pointers escape.

Run checkers to process symbol escape event.

This notifies the checkers about pointer escape, which occurs whenever the analyzer cannot track the symbol any more. For example, as a result of assigning a pointer into a global or when it's passed to a function call the analyzer cannot model.

Parameters

State	The state at the point of escape.
Escaped	The list of escaped symbols.
Call	The corresponding CallEvent, if the symbols escape as parameters to the given call.
Kind	The reason of pointer escape.
ITraits	Information about invalidation for a particular region/symbol.

Returns: Checkers can modify the state by returning a new one.

Definition at line 603 of file CheckerManager.cpp.

References clang::Call, clang::ento::PSK_DirectEscapeOnCall, and clang::ento::PSK_IndirectEscapeOnCall.

Referenced by clang::ento::ExprEngine::notifyCheckersOfPointerEscape().

◆ runCheckersForPostCall()

void clang::ento::CheckerManager::runCheckersForPostCall	(	ExplodedNodeSet &	Dst,
		const ExplodedNodeSet &	Src,
		const CallEvent &	Call,
		ExprEngine &	Eng,
		bool	wasInlined = `false`
	)

inline

Run checkers for post-visiting obj-c messages.

Definition at line 318 of file CheckerManager.h.

References clang::Call, and runCheckersForCallEvent().

Referenced by clang::ento::ExprEngine::evalCall(), clang::ento::ExprEngine::processCallExit(), clang::ento::ExprEngine::VisitCXXDeleteExpr(), clang::ento::ExprEngine::VisitCXXDestructor(), clang::ento::ExprEngine::VisitCXXNewAllocatorCall(), and clang::ento::ExprEngine::VisitObjCMessage().

◆ runCheckersForPostObjCMessage()

void clang::ento::CheckerManager::runCheckersForPostObjCMessage	(	ExplodedNodeSet &	Dst,
		const ExplodedNodeSet &	Src,
		const ObjCMethodCall &	msg,
		ExprEngine &	Eng,
		bool	wasInlined = `false`
	)

inline

Run checkers for post-visiting obj-c messages.

Definition at line 286 of file CheckerManager.h.

References clang::ento::Post, and runCheckersForObjCMessage().

Referenced by clang::ento::ExprEngine::processCallExit(), and clang::ento::ExprEngine::VisitObjCMessage().

◆ runCheckersForPostStmt()

void clang::ento::CheckerManager::runCheckersForPostStmt	(	ExplodedNodeSet &	Dst,
		const ExplodedNodeSet &	Src,
		const Stmt *	S,
		ExprEngine &	Eng,
		bool	wasInlined = `false`
	)

inline

Run checkers for post-visiting Stmts.

The notification is performed for every explored CFGElement, which does not include the control flow statements such as IfStmt.

See also: runCheckersForBranchCondition, runCheckersForPreStmt

Definition at line 263 of file CheckerManager.h.

References runCheckersForStmt().

◆ runCheckersForPreCall()

void clang::ento::CheckerManager::runCheckersForPreCall	(	ExplodedNodeSet &	Dst,
		const ExplodedNodeSet &	Src,
		const CallEvent &	Call,
		ExprEngine &	Eng
	)

inline

Run checkers for pre-visiting obj-c messages.

Definition at line 312 of file CheckerManager.h.

References clang::Call, and runCheckersForCallEvent().

Referenced by clang::ento::ExprEngine::evalCall(), clang::ento::ExprEngine::VisitCXXDeleteExpr(), clang::ento::ExprEngine::VisitCXXDestructor(), clang::ento::ExprEngine::VisitCXXNewAllocatorCall(), and clang::ento::ExprEngine::VisitObjCMessage().

◆ runCheckersForPreObjCMessage()

void clang::ento::CheckerManager::runCheckersForPreObjCMessage	(	ExplodedNodeSet &	Dst,
		const ExplodedNodeSet &	Src,
		const ObjCMethodCall &	msg,
		ExprEngine &	Eng
	)

inline

Run checkers for pre-visiting obj-c messages.

Definition at line 278 of file CheckerManager.h.

References clang::ento::Pre, and runCheckersForObjCMessage().

Referenced by clang::ento::ExprEngine::VisitObjCMessage().

◆ runCheckersForPreStmt()

void clang::ento::CheckerManager::runCheckersForPreStmt	(	ExplodedNodeSet &	Dst,
		const ExplodedNodeSet &	Src,
		const Stmt *	S,
		ExprEngine &	Eng
	)

inline

Run checkers for pre-visiting Stmts.

The notification is performed for every explored CFGElement, which does not include the control flow statements such as IfStmt.

See also: runCheckersForBranchCondition, runCheckersForPostStmt

Definition at line 250 of file CheckerManager.h.

References runCheckersForStmt().

◆ runCheckersForPrintStateJson()

void CheckerManager::runCheckersForPrintStateJson	(	raw_ostream &	Out,
		ProgramStateRef	State,
		const char *	NL = `"\n"`,
		unsigned int	Space = `0`,
		bool	IsDot = `false`
	)		const

Run checkers for debug-printing a ProgramState.

Unlike most other callbacks, any checker can simply implement the virtual method CheckerBase::printState if it has custom data to print.

Parameters

Out	The output stream
State	The state being printed
NL	The preferred representation of a newline.
Space	The preferred space between the left side and the message.
IsDot	Whether the message will be printed in 'dot' format.

Definition at line 706 of file CheckerManager.cpp.

References NewLine.

Referenced by clang::ento::ExprEngine::printJson().

◆ runCheckersForRegionChanges()

ProgramStateRef CheckerManager::runCheckersForRegionChanges	(	ProgramStateRef	state,
		const InvalidatedSymbols *	invalidated,
		ArrayRef< const MemRegion * >	ExplicitRegions,
		ArrayRef< const MemRegion * >	Regions,
		const LocationContext *	LCtx,
		const CallEvent *	Call
	)

Run checkers for region changes.

This corresponds to the check::RegionChanges callback.

Parameters

state	The current program state.
invalidated	A set of all symbols potentially touched by the change.
ExplicitRegions	The regions explicitly requested for invalidation. For example, in the case of a function call, these would be arguments.
Regions	The transitive closure of accessible regions, i.e. all regions that may have been touched by this change.
Call	The call expression wrapper if the regions are invalidated by a call.

Definition at line 584 of file CheckerManager.cpp.

References clang::Call.

Referenced by clang::ento::ExprEngine::processRegionChanges().

◆ runCheckersForStmt()

void CheckerManager::runCheckersForStmt	(	bool	isPreVisit,
		ExplodedNodeSet &	Dst,
		const ExplodedNodeSet &	Src,
		const Stmt *	S,
		ExprEngine &	Eng,
		bool	wasInlined = `false`
	)

Run checkers for visiting Stmts.

Definition at line 169 of file CheckerManager.cpp.

References clang::C, and expandGraphWithCheckers().

Referenced by runCheckersForPostStmt(), and runCheckersForPreStmt().

◆ runCheckersOnASTBody()

void CheckerManager::runCheckersOnASTBody	(	const Decl *	D,
		AnalysisManager &	mgr,
		BugReporter &	BR
	)

Run checkers handling Decls containing a Stmt body.

Definition at line 83 of file CheckerManager.cpp.

References D, and clang::Decl::hasBody().

◆ runCheckersOnASTDecl()

void CheckerManager::runCheckersOnASTDecl	(	const Decl *	D,
		AnalysisManager &	mgr,
		BugReporter &	BR
	)

Run checkers handling Decls.

Definition at line 64 of file CheckerManager.cpp.

References D, and clang::Decl::getKind().

◆ runCheckersOnEndOfTranslationUnit()

void CheckerManager::runCheckersOnEndOfTranslationUnit	(	const TranslationUnitDecl *	TU,
		AnalysisManager &	mgr,
		BugReporter &	BR
	)

Run checkers for the entire Translation Unit.

Definition at line 698 of file CheckerManager.cpp.

◆ setCurrentCheckerName()

void clang::ento::CheckerManager::setCurrentCheckerName ( CheckerNameRef name )

inline

Definition at line 162 of file CheckerManager.h.

Referenced by clang::ento::CheckerRegistry::initializeManager().

The documentation for this class was generated from the following files:

include/clang/StaticAnalyzer/Core/CheckerManager.h
lib/StaticAnalyzer/Core/CheckerManager.cpp
lib/StaticAnalyzer/Frontend/CreateCheckerManager.cpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ CheckBeginFunctionFunc

◆ CheckBindFunc

◆ CheckBranchConditionFunc

◆ CheckCallFunc

◆ CheckDeadSymbolsFunc

◆ CheckDeclFunc

◆ CheckEndAnalysisFunc

◆ CheckEndFunctionFunc

◆ CheckEndOfTranslationUnit

◆ CheckerDtor

◆ CheckerRef

◆ CheckerTag

◆ CheckEventFunc

◆ CheckLiveSymbolsFunc

◆ CheckLocationFunc

◆ CheckNewAllocatorFunc

◆ CheckObjCMessageFunc

◆ CheckPointerEscapeFunc

◆ CheckRegionChangesFunc

◆ CheckStmtFunc

◆ EvalAssumeFunc

◆ EvalCallFunc

◆ EventTag

◆ HandlesDeclFunc

◆ HandlesStmtFunc

Constructor & Destructor Documentation

◆ CheckerManager() [1/3]

◆ CheckerManager() [2/3]

◆ CheckerManager() [3/3]

◆ ~CheckerManager()

Member Function Documentation

◆ _dispatchEvent()

◆ _registerDispatcherForEvent()

◆ _registerForBeginFunction()

◆ _registerForBind()

◆ _registerForBody()

◆ _registerForBranchCondition()

◆ _registerForConstPointerEscape()

◆ _registerForDeadSymbols()

◆ _registerForDecl()

◆ _registerForEndAnalysis()

◆ _registerForEndFunction()

◆ _registerForEndOfTranslationUnit()

◆ _registerForEvalAssume()

◆ _registerForEvalCall()

◆ _registerForLiveSymbols()

◆ _registerForLocation()

◆ _registerForNewAllocator()

◆ _registerForObjCMessageNil()

◆ _registerForPointerEscape()

◆ _registerForPostCall()

◆ _registerForPostObjCMessage()

◆ _registerForPostStmt()

◆ _registerForPreCall()

◆ _registerForPreObjCMessage()

◆ _registerForPreStmt()

◆ _registerForRegionChanges()

◆ _registerListenerForEvent()

◆ getAnalyzerOptions()

◆ getASTContext()

◆ getChecker()

◆ getCheckerRegistryData()

◆ getCurrentCheckerName()

◆ getDiagnostics()

◆ getLangOpts()

◆ getPreprocessor()

◆ hasPathSensitiveCheckers()

◆ isRegisteredChecker()

◆ registerChecker()

◆ reportInvalidCheckerOptionValue()

◆ runCheckersForBeginFunction()

◆ runCheckersForBind()

◆ runCheckersForBranchCondition()

◆ runCheckersForCallEvent()

◆ runCheckersForDeadSymbols()

◆ runCheckersForEndAnalysis()