#include <Store.h>

Collaboration diagram for clang::ento::StoreManager:

Classes
class	BindingsHandler
class	CastResult
class	FindUniqueBinding
Public Types
typedef llvm::DenseSet< SymbolRef >	InvalidatedSymbols
typedef SmallVector< const MemRegion *, 8 >	InvalidatedRegions
Public Member Functions
virtual	~StoreManager ()
virtual SVal	getBinding (Store store, Loc loc, QualType T=QualType())=0
virtual StoreRef	Bind (Store store, Loc loc, SVal val)=0
virtual StoreRef	BindDefault (Store store, const MemRegion *R, SVal V)
virtual StoreRef	Remove (Store St, Loc L)=0
virtual StoreRef	BindCompoundLiteral (Store store, const CompoundLiteralExpr cl, const LocationContext LC, SVal v)=0
virtual StoreRef	getInitialStore (const LocationContext *InitLoc)=0
MemRegionManager &	getRegionManager ()
virtual SubRegionMap *	getSubRegionMap (Store store)=0
virtual Loc	getLValueVar (const VarDecl VD, const LocationContext LC)
Loc	getLValueCompoundLiteral (const CompoundLiteralExpr CL, const LocationContext LC)
virtual SVal	getLValueIvar (const ObjCIvarDecl *decl, SVal base)
virtual SVal	getLValueField (const FieldDecl *D, SVal Base)
virtual SVal	getLValueElement (QualType elementType, NonLoc offset, SVal Base)
virtual DefinedOrUnknownSVal	getSizeInElements (ProgramStateRef state, const MemRegion *region, QualType EleTy)
virtual SVal	ArrayToPointer (Loc Array)=0
virtual SVal	evalDerivedToBase (SVal derived, QualType basePtrType)=0
	Evaluates DerivedToBase casts.
virtual SVal	evalDynamicCast (SVal base, QualType derivedPtrType, bool &Failed)=0
	Evaluates C++ dynamic_cast cast. The callback may result in the following 3 scenarios:
const ElementRegion *	GetElementZeroRegion (const MemRegion *R, QualType T)
const MemRegion *	castRegion (const MemRegion *region, QualType CastToTy)
virtual StoreRef	removeDeadBindings (Store store, const StackFrameContext *LCtx, SymbolReaper &SymReaper)=0
virtual StoreRef	BindDecl (Store store, const VarRegion *VR, SVal initVal)=0
virtual StoreRef	BindDeclWithNoInit (Store store, const VarRegion *VR)=0
virtual bool	includedInBindings (Store store, const MemRegion *region) const =0
virtual void	incrementReferenceCount (Store store)
virtual void	decrementReferenceCount (Store store)
virtual StoreRef	invalidateRegions (Store store, ArrayRef< const MemRegion * > Regions, const Expr E, unsigned Count, const LocationContext LCtx, InvalidatedSymbols &IS, const CallOrObjCMessage Call, InvalidatedRegions Invalidated)=0
virtual StoreRef	enterStackFrame (ProgramStateRef state, const LocationContext callerCtx, const StackFrameContext calleeCtx)
virtual void	print (Store store, raw_ostream &Out, const char nl, const char sep)=0
virtual void	iterBindings (Store store, BindingsHandler &f)=0
	iterBindings - Iterate over the bindings in the Store.
Protected Member Functions
	StoreManager (ProgramStateManager &stateMgr)
const MemRegion *	MakeElementRegion (const MemRegion *baseRegion, QualType pointeeTy, uint64_t index=0)
SVal	CastRetrievedVal (SVal val, const TypedValueRegion *region, QualType castTy, bool performTestOnly=true)
Protected Attributes
SValBuilder &	svalBuilder
ProgramStateManager &	StateMgr
MemRegionManager &	MRMgr
	MRMgr - Manages region objects associated with this StoreManager.
ASTContext &	Ctx

Detailed Description

Definition at line 37 of file Store.h.

Member Typedef Documentation

typedef SmallVector<const MemRegion *, 8> clang::ento::StoreManager::InvalidatedRegions

Definition at line 172 of file Store.h.

typedef llvm::DenseSet<SymbolRef> clang::ento::StoreManager::InvalidatedSymbols

Definition at line 171 of file Store.h.

Constructor & Destructor Documentation

StoreManager::StoreManager ( ProgramStateManager & stateMgr ) [protected]

Definition at line 22 of file Store.cpp.

virtual clang::ento::StoreManager::~StoreManager ( ) [inline, virtual]

Definition at line 49 of file Store.h.

Member Function Documentation

virtual SVal clang::ento::StoreManager::ArrayToPointer ( Loc Array ) [pure virtual]

ArrayToPointer - Used by ExprEngine::VistCast to handle implicit conversions between arrays and pointers.

virtual StoreRef clang::ento::StoreManager::Bind	(	Store	store,
		Loc	loc,
		SVal	val
	)		`[pure virtual]`

Return a state with the specified value bound to the given location.

Parameters:

[in]	state	The analysis state.
[in]	loc	The symbolic memory location.
[in]	val	The value to bind to location `loc`.

Returns:: A pointer to a ProgramState object that contains the same bindings as state with the addition of having the value specified by val bound to the location given for loc.

virtual StoreRef clang::ento::StoreManager::BindCompoundLiteral	(	Store	store,
		const CompoundLiteralExpr *	cl,
		const LocationContext *	LC,
		SVal	v
	)		`[pure virtual]`

BindCompoundLiteral - Return the store that has the bindings currently in 'store' plus the bindings for the CompoundLiteral. 'R' is the region for the compound literal and 'BegInit' and 'EndInit' represent an array of initializer values.

virtual StoreRef clang::ento::StoreManager::BindDecl	(	Store	store,
		const VarRegion *	VR,
		SVal	initVal
	)		`[pure virtual]`

virtual StoreRef clang::ento::StoreManager::BindDeclWithNoInit	(	Store	store,
		const VarRegion *	VR
	)		`[pure virtual]`

StoreRef StoreManager::BindDefault	(	Store	store,
		const MemRegion *	R,
		SVal	V
	)		`[virtual]`

Definition at line 49 of file Store.cpp.

const MemRegion * StoreManager::castRegion	(	const MemRegion *	region,
		QualType	CastToTy
	)

castRegion - Used by ExprEngine::VisitCast to handle casts from a MemRegion* to a specific location type. 'R' is the region being casted and 'CastToTy' the result type of the cast.

Definition at line 60 of file Store.cpp.

Referenced by clang::ento::SValBuilder::evalCast().

SVal StoreManager::CastRetrievedVal	(	SVal	V,
		const TypedValueRegion *	R,
		QualType	castTy,
		bool	performTestOnly = `true`
	)		`[protected]`

CastRetrievedVal - Used by subclasses of StoreManager to implement implicit casts that arise from loads from regions that are reinterpreted as another region.

Definition at line 217 of file Store.cpp.

References Ctx, clang::ento::SValBuilder::dispatchCast(), clang::ento::SValBuilder::getContext(), clang::ASTContext::getPointerType(), clang::ento::TypedValueRegion::getValueType(), clang::ASTContext::hasSameUnqualifiedType(), clang::QualType::isNull(), clang::ento::SVal::isUnknownOrUndef(), and svalBuilder.

virtual void clang::ento::StoreManager::decrementReferenceCount ( Store store ) [inline, virtual]

If the StoreManager supports it, decrement the reference count of the specified Store object. If the reference count hits 0, the memory associated with the object is recycled.

Definition at line 169 of file Store.h.

Referenced by clang::ento::StoreRef::operator=(), clang::ento::ProgramState::~ProgramState(), and clang::ento::StoreRef::~StoreRef().

StoreRef StoreManager::enterStackFrame	(	ProgramStateRef	state,
		const LocationContext *	callerCtx,
		const StackFrameContext *	calleeCtx
	)		`[virtual]`

enterStackFrame - Let the StoreManager to do something when execution engine is about to execute into a callee.

Definition at line 206 of file ProgramState.cpp.

References clang::ento::ProgramState::getStateManager().

virtual SVal clang::ento::StoreManager::evalDerivedToBase	(	SVal	derived,
		QualType	basePtrType
	)		`[pure virtual]`

Evaluates DerivedToBase casts.

Referenced by clang::ento::ExprEngine::ProcessInitializer(), and clang::ento::ExprEngine::VisitCast().

virtual SVal clang::ento::StoreManager::evalDynamicCast	(	SVal	base,
		QualType	derivedPtrType,
		bool &	Failed
	)		`[pure virtual]`

Evaluates C++ dynamic_cast cast. The callback may result in the following 3 scenarios:

Successful cast (ex: derived is subclass of base).
Failed cast (ex: derived is definitely not a subclass of base).
We don't know (base is a symbolic region and we don't have enough info to determine if the cast will succeed at run time). The function returns an SVal representing the derived class; it's valid only if Failed flag is set to false.

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

virtual SVal clang::ento::StoreManager::getBinding	(	Store	store,
		Loc	loc,
		QualType	T = `QualType()`
	)		`[pure virtual]`

Return the value bound to specified location in a given state.

Parameters:

[in]	state	The analysis state.
[in]	loc	The symbolic memory location.
[in]	T	An optional type that provides a hint indicating the expected type of the returned value. This is used if the value is lazily computed.

Returns:: The value bound to the location loc.

const ElementRegion * StoreManager::GetElementZeroRegion	(	const MemRegion *	R,
		QualType	T
	)

Definition at line 53 of file Store.cpp.

References Ctx, clang::ento::MemRegionManager::getElementRegion(), clang::QualType::isNull(), clang::ento::SValBuilder::makeZeroArrayIndex(), MRMgr, and svalBuilder.

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

virtual StoreRef clang::ento::StoreManager::getInitialStore ( const LocationContext * InitLoc ) [pure virtual]

getInitialStore - Returns the initial "empty" store representing the value bindings upon entry to an analyzed function.

Loc clang::ento::StoreManager::getLValueCompoundLiteral	(	const CompoundLiteralExpr *	CL,
		const LocationContext *	LC
	)		`[inline]`

Definition at line 97 of file Store.h.

References clang::ento::MemRegionManager::getCompoundLiteralRegion(), and MRMgr.

SVal StoreManager::getLValueElement	(	QualType	elementType,
		NonLoc	offset,
		SVal	Base
	)		`[virtual]`

Definition at line 277 of file Store.cpp.

References clang::ento::SValBuilder::convertToArrayIndex(), Ctx, clang::ento::SValBuilder::getBasicValueFactory(), clang::ento::MemRegionManager::getElementRegion(), clang::ento::ElementRegion::getIndex(), clang::ento::SubRegion::getSuperRegion(), clang::ento::BasicValueFactory::getValue(), getValue(), clang::ento::SVal::isUnknownOrUndef(), MRMgr, clang::ento::MemRegion::StripCasts(), and svalBuilder.

virtual SVal clang::ento::StoreManager::getLValueField	(	const FieldDecl *	D,
		SVal	Base
	)		`[inline, virtual]`

Definition at line 104 of file Store.h.

SVal StoreManager::getLValueIvar	(	const ObjCIvarDecl *	decl,
		SVal	base
	)		`[virtual]`

Definition at line 273 of file Store.cpp.

virtual Loc clang::ento::StoreManager::getLValueVar	(	const VarDecl *	VD,
		const LocationContext *	LC
	)		`[inline, virtual]`

Definition at line 93 of file Store.h.

References clang::ento::MemRegionManager::getVarRegion(), clang::ento::SValBuilder::makeLoc(), MRMgr, and svalBuilder.

MemRegionManager& clang::ento::StoreManager::getRegionManager ( ) [inline]

getRegionManager - Returns the internal RegionManager object that is used to query and manipulate MemRegion objects.

Definition at line 86 of file Store.h.

References MRMgr.

virtual DefinedOrUnknownSVal clang::ento::StoreManager::getSizeInElements	(	ProgramStateRef	state,
		const MemRegion *	region,
		QualType	EleTy
	)		`[inline, virtual]`

Definition at line 112 of file Store.h.

virtual SubRegionMap* clang::ento::StoreManager::getSubRegionMap ( Store store ) [pure virtual]

getSubRegionMap - Returns an opaque map object that clients can query to get the subregions of a given MemRegion object. It is the

virtual bool clang::ento::StoreManager::includedInBindings	(	Store	store,
		const MemRegion *	region
	)		const `[pure virtual]`

virtual void clang::ento::StoreManager::incrementReferenceCount ( Store store ) [inline, virtual]

If the StoreManager supports it, increment the reference count of the specified Store object.

Definition at line 164 of file Store.h.

Referenced by clang::ento::StoreRef::operator=(), clang::ento::ProgramState::ProgramState(), and clang::ento::StoreRef::StoreRef().

ProgramStateRef ProgramState::invalidateRegions	(	Store	store,
		ArrayRef< const MemRegion * >	Regions,
		const Expr *	E,
		unsigned	Count,
		const LocationContext *	LCtx,
		InvalidatedSymbols &	IS,
		const CallOrObjCMessage *	Call,
		InvalidatedRegions *	Invalidated
	)		`[pure virtual]`

invalidateRegions - Clears out the specified regions from the store, marking their values as unknown. Depending on the store, this may also invalidate additional regions that may have changed based on accessing the given regions. Optionally, invalidates non-static globals as well.

Parameters:

[in]	store	The initial store
[in]	Begin	A pointer to the first region to invalidate.
[in]	End	A pointer just past the last region to invalidate.
[in]	E	The current statement being evaluated. Used to conjure symbols to mark the values of invalidated regions.
[in]	Count	The current block count. Used to conjure symbols to mark the values of invalidated regions.
[in,out]	IS	A set to fill with any symbols that are no longer accessible. Pass `NULL` if this information will not be used.
[in]	Call	The call expression which will be used to determine which globals should get invalidated.
[in,out]	Regions	A vector to fill with any regions being invalidated. This should include any regions explicitly invalidated even if they do not currently have bindings. Pass `NULL` if this information will not be used.