clang::ProgramPoint Class Reference

#include "clang/Analysis/ProgramPoint.h"

Inheritance diagram for clang::ProgramPoint:

Public Types

enum

Kind {   BlockEdgeKind , BlockEntranceKind , BlockExitKind , PreStmtKind ,   PreStmtPurgeDeadSymbolsKind , PostStmtPurgeDeadSymbolsKind , PostStmtKind , PreLoadKind ,   PostLoadKind , PreStoreKind , PostStoreKind , PostConditionKind ,   PostLValueKind , PostAllocatorCallKind , MinPostStmtKind = PostStmtKind , MaxPostStmtKind = PostAllocatorCallKind ,   PostInitializerKind , CallEnterKind , CallExitBeginKind , CallExitEndKind ,   FunctionExitKind , PreImplicitCallKind , PostImplicitCallKind , MinImplicitCallKind = PreImplicitCallKind ,   MaxImplicitCallKind = PostImplicitCallKind , LoopExitKind , EpsilonKind }

Public Member Functions
std::optional< SourceLocation >	getSourceLocation () const
ProgramPoint	withTag (const ProgramPointTag *tag) const
	Create a new ProgramPoint object that is the same as the original except for using the specified tag value.
template<typename T>
T	castAs () const
	Convert to the specified ProgramPoint type, asserting that this ProgramPoint is of the desired type.
template<typename T>
std::optional< T >	getAs () const
	Convert to the specified ProgramPoint type, returning std::nullopt if this ProgramPoint is not of the desired type.
Kind	getKind () const
bool	isPurgeKind ()
	Is this a program point corresponding to purge/removal of dead symbols and bindings.
const ProgramPointTag *	getTag () const
const StackFrame *	getStackFrame () const
unsigned	getHashValue () const
bool	operator== (const ProgramPoint &RHS) const
bool	operator!= (const ProgramPoint &RHS) const
void	Profile (llvm::FoldingSetNodeID &ID) const
void	printJson (llvm::raw_ostream &Out, const char *NL="\n") const
LLVM_DUMP_METHOD void	dump () const

Static Public Member Functions
static StringRef	getProgramPointKindName (Kind K)
static ProgramPoint	getProgramPoint (const Stmt *S, ProgramPoint::Kind K, const StackFrame *SF, const ProgramPointTag *tag)

Protected Member Functions
	ProgramPoint ()=default
	ProgramPoint (const void *P, Kind k, const StackFrame *SF, const ProgramPointTag *tag=nullptr, CFGBlock::ConstCFGElementRef ElemRef={nullptr, 0})
	ProgramPoint (const void *P1, const void *P2, Kind k, const StackFrame *SF, const ProgramPointTag *tag=nullptr, CFGBlock::ConstCFGElementRef ElemRef={nullptr, 0})
const void *	getData1 () const
const void *	getData2 () const
void	setData2 (const void *d)
CFGBlock::ConstCFGElementRef	getElementRef () const

Detailed Description

Definition at line 60 of file ProgramPoint.h.

Member Enumeration Documentation

Kind

enum clang::ProgramPoint::Kind

Enumerator
BlockEdgeKind
BlockEntranceKind
BlockExitKind
PreStmtKind
PreStmtPurgeDeadSymbolsKind
PostStmtPurgeDeadSymbolsKind
PostStmtKind
PreLoadKind
PostLoadKind
PreStoreKind
PostStoreKind
PostConditionKind
PostLValueKind
PostAllocatorCallKind
MinPostStmtKind
MaxPostStmtKind
PostInitializerKind
CallEnterKind
CallExitBeginKind
CallExitEndKind
FunctionExitKind
PreImplicitCallKind
PostImplicitCallKind
MinImplicitCallKind
MaxImplicitCallKind
LoopExitKind
EpsilonKind

Definition at line 62 of file ProgramPoint.h.

Constructor & Destructor Documentation

ProgramPoint() [1/3]

clang::ProgramPoint::ProgramPoint ( )

protecteddefault

Referenced by castAs(), getAs(), getProgramPoint(), operator!=(), operator==(), and withTag().

ProgramPoint() [2/3]

clang::ProgramPoint::ProgramPoint ( const void * P, Kind k, const StackFrame * SF, const ProgramPointTag * tag = nullptr, CFGBlock::ConstCFGElementRef ElemRef = {nullptr, 0} )

inlineprotected

Definition at line 107 of file ProgramPoint.h.

ProgramPoint() [3/3]

clang::ProgramPoint::ProgramPoint ( const void * P1, const void * P2, Kind k, const StackFrame * SF, const ProgramPointTag * tag = nullptr, CFGBlock::ConstCFGElementRef ElemRef = {nullptr, 0} )

inlineprotected

Definition at line 118 of file ProgramPoint.h.

Member Function Documentation

castAs()

template<typename T>

T clang::ProgramPoint::castAs ( ) const

inline

Convert to the specified ProgramPoint type, asserting that this ProgramPoint is of the desired type.

Definition at line 142 of file ProgramPoint.h.

References ProgramPoint().

Referenced by clang::ento::StackHintGeneratorForSymbol::getMessage(), getSourceLocation(), printJson(), REGISTER_TRAIT_WITH_PROGRAMSTATE(), clang::ento::ExprEngine::VisitLogicalExpr(), and clang::ento::retaincountchecker::RefCountReportVisitor::VisitNode().

dump()

LLVM_DUMP_METHOD void ProgramPoint::dump

(

)

const

Definition at line 48 of file ProgramPoint.cpp.

References printJson().

getAs()

template<typename T>

std::optional< T > clang::ProgramPoint::getAs ( ) const

inline

Convert to the specified ProgramPoint type, returning std::nullopt if this ProgramPoint is not of the desired type.

Definition at line 152 of file ProgramPoint.h.

References ProgramPoint().

Referenced by alreadyExecutedAtLeastOneLoopIteration(), clang::ento::bugreporter::StoreHandler::constructNote(), clang::ento::PathDiagnosticLocation::create(), clang::ento::CoreEngine::enqueueStmtNode(), exitingDestructor(), GetAllocationSite(), clang::ento::ExplodedNode::getCFGBlock(), getLastStmt(), clang::ento::PathSensitiveBugReport::getLocation(), clang::ento::CheckerContext::getLocationRegionIfPostStore(), clang::ento::PathSensitiveBugReport::getStmt(), getStmtBeforeCond(), clang::ento::ExplodedNode::getStmtForDiagnostics(), clang::ento::madeNewBranch(), peelOffOuterExpr(), printJson(), REGISTER_TRAIT_WITH_PROGRAMSTATE(), shouldRemoveDeadBindings(), clang::ento::ExprEngine::VisitLogicalExpr(), clang::ento::retaincountchecker::RefCountReportVisitor::VisitNode(), clang::ento::SuppressInlineDefensiveChecksVisitor::VisitNode(), clang::ento::UndefOrNullArgVisitor::VisitNode(), and clang::ento::ConditionBRVisitor::VisitNodeImpl().

getData1()

const void * clang::ProgramPoint::getData1 ( ) const

inlineprotected

Definition at line 126 of file ProgramPoint.h.

Referenced by clang::BlockEntrance::getBlock(), clang::BlockExit::getBlock(), clang::CallExitEnd::getCalleeStackFrame(), clang::CallEnter::getCallExpr(), clang::EpsilonPoint::getData(), clang::PostInitializer::getInitializer(), clang::ImplicitCallPoint::getLocation(), clang::LoopExit::getLoopStmt(), clang::CallExitBegin::getReturnStmt(), clang::BlockEdge::getSrc(), clang::FunctionExitPoint::getStmt(), clang::StmtPoint::getStmt(), Profile(), and withTag().

getData2()

const void * clang::ProgramPoint::getData2 ( ) const

inlineprotected

Definition at line 127 of file ProgramPoint.h.

Referenced by clang::CallEnter::getCalleeStackFrame(), clang::ImplicitCallPoint::getDecl(), clang::BlockEdge::getDst(), clang::PostInitializer::getLocationValue(), clang::PostStore::getLocationValue(), clang::BlockEntrance::getPreviousBlock(), clang::PreStmt::getSubStmt(), clang::PostStore::PostStore(), Profile(), and withTag().

getElementRef()

CFGBlock::ConstCFGElementRef clang::ProgramPoint::getElementRef ( ) const

inlineprotected

Definition at line 129 of file ProgramPoint.h.

getHashValue()

unsigned clang::ProgramPoint::getHashValue ( ) const

inline

Definition at line 183 of file ProgramPoint.h.

References Profile().

Referenced by llvm::DenseMapInfo< clang::ProgramPoint >::getHashValue().

getKind()

Kind clang::ProgramPoint::getKind ( ) const

inline

Definition at line 161 of file ProgramPoint.h.

Referenced by clang::ento::WorkList::enqueue(), getSourceLocation(), isPurgeKind(), printJson(), Profile(), and withTag().

getProgramPoint()

ProgramPoint ProgramPoint::getProgramPoint ( const Stmt * S, ProgramPoint::Kind K, const StackFrame * SF, const ProgramPointTag * tag )

static

Definition at line 23 of file ProgramPoint.cpp.

References PostLoadKind, PostLValueKind, PostStmtKind, PostStmtPurgeDeadSymbolsKind, PreLoadKind, PreStmtKind, PreStmtPurgeDeadSymbolsKind, PreStoreKind, and ProgramPoint().

Referenced by clang::ento::NodeBuilder::generateNode(), clang::ento::NodeBuilder::generateSink(), clang::ento::CoreEngine::makeNodeWithBinding(), clang::ento::ExprEngine::removeDead(), and clang::ento::CheckerManager::runCheckersForEvalCall().

getProgramPointKindName()

StringRef ProgramPoint::getProgramPointKindName ( Kind K )

static

Definition at line 52 of file ProgramPoint.cpp.

References BlockEdgeKind, BlockEntranceKind, BlockExitKind, CallEnterKind, CallExitBeginKind, CallExitEndKind, EpsilonKind, FunctionExitKind, LoopExitKind, PostAllocatorCallKind, PostConditionKind, PostImplicitCallKind, PostInitializerKind, PostLoadKind, PostLValueKind, PostStmtKind, PostStmtPurgeDeadSymbolsKind, PostStoreKind, PreImplicitCallKind, PreLoadKind, PreStmtKind, PreStmtPurgeDeadSymbolsKind, and PreStoreKind.

Referenced by timeTraceScopeName().

getSourceLocation()

std::optional< SourceLocation > ProgramPoint::getSourceLocation

(

)

const

Definition at line 104 of file ProgramPoint.cpp.

References BlockEdgeKind, BlockEntranceKind, BlockExitKind, CallEnterKind, CallExitBeginKind, CallExitEndKind, castAs(), EpsilonKind, FunctionExitKind, getKind(), clang::Init, LoopExitKind, PostAllocatorCallKind, PostConditionKind, PostImplicitCallKind, PostInitializerKind, PostLoadKind, PostLValueKind, PostStmtKind, PostStmtPurgeDeadSymbolsKind, PostStoreKind, PreImplicitCallKind, PreLoadKind, PreStmtKind, PreStmtPurgeDeadSymbolsKind, and PreStoreKind.

getStackFrame()

const StackFrame * clang::ProgramPoint::getStackFrame ( ) const

inline

Definition at line 180 of file ProgramPoint.h.

Referenced by clang::ento::PathDiagnosticCallPiece::construct(), clang::ento::bugreporter::StoreHandler::constructNote(), clang::ento::PathDiagnosticLocation::create(), clang::FunctionExitPoint::getBlock(), getLastStmt(), clang::ento::PathSensitiveBugReport::getLocation(), clang::ento::ExplodedNode::getStackFrame(), clang::ento::PathSensitiveBugReport::getStmt(), printJson(), Profile(), clang::ento::PathDiagnosticCallPiece::setCallee(), and withTag().

getTag()

const ProgramPointTag * clang::ProgramPoint::getTag ( ) const

inline

Definition at line 178 of file ProgramPoint.h.

Referenced by llvm::DOTGraphTraits< ExplodedGraph * >::getNodeLabel(), Profile(), clang::ento::retaincountchecker::RefCountReportVisitor::VisitNode(), clang::ento::TagVisitor::VisitNode(), clang::ento::TrackConstraintBRVisitor::VisitNode(), clang::ento::ConditionBRVisitor::VisitNodeImpl(), and clang::ento::ExprEngine::VisitObjCMessage().

isPurgeKind()

bool clang::ProgramPoint::isPurgeKind ( )

inline

Is this a program point corresponding to purge/removal of dead symbols and bindings.

Definition at line 172 of file ProgramPoint.h.

References getKind(), PostStmtPurgeDeadSymbolsKind, and PreStmtPurgeDeadSymbolsKind.

Referenced by clang::ento::ExplodedNode::getNextStmtForDiagnostics().

operator!=()

bool clang::ProgramPoint::operator!= ( const ProgramPoint & RHS ) const

inline

Definition at line 194 of file ProgramPoint.h.

References ProgramPoint().

operator==()

bool clang::ProgramPoint::operator== ( const ProgramPoint & RHS ) const

inline

Definition at line 189 of file ProgramPoint.h.

References ProgramPoint().

printJson()

void ProgramPoint::printJson	(	llvm::raw_ostream &	Out,
		const char *	NL = "\n" ) const

Definition at line 167 of file ProgramPoint.cpp.

References BlockEdgeKind, BlockEntranceKind, BlockExitKind, clang::C, CallEnterKind, CallExitBeginKind, CallExitEndKind, castAs(), EpsilonKind, FunctionExitKind, clang::StackFrame::getAnalysisDeclContext(), getAs(), clang::Decl::getAsFunction(), clang::AnalysisDeclContext::getASTContext(), clang::CFGBlock::getBlockID(), clang::ImplicitCallPoint::getDecl(), clang::BlockEdge::getDst(), clang::AnalysisDeclContext::getFunctionName(), getKind(), clang::CFGBlock::getLabel(), clang::QualType::getLocalUnqualifiedType(), clang::ImplicitCallPoint::getLocation(), clang::NamedDecl::getQualifiedNameAsString(), clang::BlockEdge::getSrc(), getStackFrame(), clang::CFGBlock::getTerminatorStmt(), clang::Init, clang::isa(), LoopExitKind, PostImplicitCallKind, PostInitializerKind, PreImplicitCallKind, clang::QualType::print(), clang::printSourceLocationAsJson(), clang::CFGBlock::printTerminatorJson(), and SM.

Referenced by dump(), and llvm::DOTGraphTraits< ExplodedGraph * >::getNodeLabel().

Profile()

void clang::ProgramPoint::Profile ( llvm::FoldingSetNodeID & ID ) const

inline

Definition at line 199 of file ProgramPoint.h.

References getData1(), getData2(), getKind(), getStackFrame(), and getTag().

Referenced by getHashValue().

setData2()

void clang::ProgramPoint::setData2 ( const void * d )

inlineprotected

Definition at line 128 of file ProgramPoint.h.

Referenced by clang::PostStore::PostStore().

withTag()

ProgramPoint clang::ProgramPoint::withTag ( const ProgramPointTag * tag ) const

inline

Create a new ProgramPoint object that is the same as the original except for using the specified tag value.

Definition at line 134 of file ProgramPoint.h.

References getData1(), getData2(), getKind(), getStackFrame(), and ProgramPoint().

Referenced by clang::ento::CoreEngine::enqueueStmtNode(), clang::ento::ExprEngine::processCFGBlockEntrance(), and clang::ento::ExprEngine::VisitCXXDestructor().

---

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

• include/clang/Analysis/ProgramPoint.h
• lib/Analysis/ProgramPoint.cpp