MemRegion - The root abstract class for all memory regions. More...

#include <MemRegion.h>

Inheritance diagram for clang::ento::MemRegion:

[legend]

Collaboration diagram for clang::ento::MemRegion:

Public Types
enum	Kind

Public Member Functions
ASTContext &	getContext () const

virtual void	Profile (llvm::FoldingSetNodeID &ID) const =0

virtual MemRegionManager *	getMemRegionManager () const =0

const MemSpaceRegion *	getMemorySpace () const

const MemRegion *	getBaseRegion () const

virtual bool	isSubRegionOf (const MemRegion *R) const
	Check if the region is a subregion of the given region. More...

const MemRegion *	StripCasts (bool StripBaseCasts=true) const

const SymbolicRegion *	getSymbolicBase () const
	If this is a symbolic region, returns the region. More...

bool	hasGlobalsOrParametersStorage () const

bool	hasStackStorage () const

bool	hasStackNonParametersStorage () const

bool	hasStackParametersStorage () const

RegionOffset	getAsOffset () const
	Compute the offset within the top level memory object. More...

std::string	getString () const
	Get a string representation of a region for debug use. More...

virtual void	dumpToStream (raw_ostream &os) const

void	dump () const

virtual bool	canPrintPretty () const
	Returns true if this region can be printed in a user-friendly way. More...

virtual void	printPretty (raw_ostream &os) const
	Print the region for use in diagnostics. More...

virtual bool	canPrintPrettyAsExpr () const
	Returns true if this region's textual representation can be used as part of a larger expression. More...

virtual void	printPrettyAsExpr (raw_ostream &os) const
	Print the region as expression. More...

Kind	getKind () const

template<typename RegionTy >
const RegionTy *	getAs () const

virtual bool	isBoundable () const

std::string	getDescriptiveName (bool UseQuotes=true) const
	Get descriptive name for memory region. More...

clang::SourceRange	sourceRange () const
	Retrieve source range from memory region. More...

Protected Member Functions
	MemRegion (Kind k)

virtual	~MemRegion ()

Detailed Description

MemRegion - The root abstract class for all memory regions.

Definition at line 79 of file MemRegion.h.

Member Enumeration Documentation

enum clang::ento::MemRegion::Kind

Definition at line 81 of file MemRegion.h.

Constructor & Destructor Documentation

clang::ento::MemRegion::MemRegion ( Kind k )

inlineprotected

Definition at line 91 of file MemRegion.h.

References dump().

MemRegion::~MemRegion ( )

protectedvirtual

Definition at line 92 of file MemRegion.cpp.

Member Function Documentation

bool MemRegion::canPrintPretty ( ) const

virtual

Returns true if this region can be printed in a user-friendly way.

Reimplemented in clang::ento::FieldRegion.

Definition at line 526 of file MemRegion.cpp.

Referenced by didPreviousFreeFail(), and clang::ento::FindLastStoreBRVisitor::VisitNode().

bool MemRegion::canPrintPrettyAsExpr ( ) const

virtual

Returns true if this region's textual representation can be used as part of a larger expression.

Reimplemented in clang::ento::CXXBaseObjectRegion, clang::ento::ObjCIvarRegion, clang::ento::FieldRegion, and clang::ento::VarRegion.

Definition at line 530 of file MemRegion.cpp.

Referenced by clang::ento::FieldRegion::canPrintPrettyAsExpr(), clang::ento::CXXBaseObjectRegion::canPrintPrettyAsExpr(), and getDescriptiveName().

LLVM_DUMP_METHOD void MemRegion::dump ( ) const

Definition at line 395 of file MemRegion.cpp.

void MemRegion::dumpToStream ( raw_ostream & os ) const

virtual

Definition at line 406 of file MemRegion.cpp.

Referenced by llvm::operator<<().

template<typename RegionTy >

const RegionTy * clang::ento::MemRegion::getAs ( ) const

Definition at line 1106 of file MemRegion.h.

Referenced by clang::ento::mpi::MPIChecker::checkMissingWaits(), didPreviousFreeFail(), GetAllocationSite(), clang::ento::SVal::getAsFunctionDecl(), getDescriptiveName(), getNullConstraint(), clang::ento::ExprEngine::notifyCheckersOfPointerEscape(), parameterTypeFromSVal(), llvm::FoldingSetTrait< AllocKind >::Profile(), treatUnusedNewEscaped(), and updateOutParameter().

RegionOffset MemRegion::getAsOffset ( ) const

Compute the offset within the top level memory object.

Definition at line 1204 of file MemRegion.cpp.

References distance(), clang::RecordDecl::field_begin(), clang::RecordDecl::field_end(), clang::ento::MemRegionManager::getAllocator(), clang::ento::SVal::getAs(), clang::Type::getAsCXXRecordDecl(), clang::ASTContext::getASTRecordLayout(), clang::ASTRecordLayout::getBaseClassOffset(), clang::ASTContext::getCharWidth(), clang::ento::MemRegionManager::getCodeRegion(), clang::ento::MemRegionManager::getContext(), clang::ento::FieldRegion::getDecl(), clang::ento::CXXBaseObjectRegion::getDecl(), clang::ASTRecordLayout::getFieldOffset(), clang::ento::ElementRegion::getIndex(), getKind(), clang::FieldDecl::getParent(), clang::Type::getPointeeType(), clang::CharUnits::getQuantity(), clang::AnalysisDeclContext::getReferencedBlockVars(), clang::ento::SubRegion::getSuperRegion(), clang::ASTContext::getTypeSize(), clang::ento::MemRegionManager::getUnknownRegion(), clang::ento::ElementRegion::getValueType(), clang::ento::MemRegionManager::getVarRegion(), clang::ASTRecordLayout::getVBaseClassOffset(), clang::VarDecl::hasLocalStorage(), clang::TagDecl::isCompleteDefinition(), isImmediateBase(), clang::Type::isIncompleteType(), clang::TagDecl::isUnion(), clang::ento::CXXBaseObjectRegion::isVirtual(), clang::CXXRecordDecl::isVirtuallyDerivedFrom(), and clang::ento::RegionOffset::Symbolic.

Referenced by collectSubRegionBindings(), didPreviousFreeFail(), and evalBinOpFieldRegionFieldRegion().

const MemRegion * MemRegion::getBaseRegion ( ) const

Definition at line 1087 of file MemRegion.cpp.

References getKind().

Referenced by collectSubRegionBindings(), didPreviousFreeFail(), evalBinOpFieldRegionFieldRegion(), GetAllocationSite(), getExistingLazyBinding(), clang::CXXInstanceCall::getExtraInvalidatedValues(), clang::ento::BugReport::isInteresting(), clang::ento::SymbolReaper::isLiveRegion(), isRecordEmpty(), clang::ento::BugReport::markInteresting(), and clang::ento::ScanReachableSymbols::scan().

ASTContext & clang::ento::MemRegion::getContext ( ) const

inline

Definition at line 1301 of file MemRegion.h.

Referenced by clang::ento::MemRegionManager::getElementRegionWithSuper().

std::string MemRegion::getDescriptiveName ( bool UseQuotes = true ) const

Get descriptive name for memory region.

The name is obtained from the variable/field declaration retrieved from the memory region. Regions that point to an element of an array are returned as: "arr[0]". Regions that point to a struct are returned as: "st.var".

Parameters

UseQuotes Set if the name should be quoted.

Returns: variable name for memory region

Definition at line 593 of file MemRegion.cpp.

References canPrintPrettyAsExpr(), clang::ento::SVal::getAs(), getAs(), getDescriptiveName(), clang::ento::ElementRegion::getIndex(), clang::ento::SubRegion::getSuperRegion(), and printPrettyAsExpr().

Referenced by getDescriptiveName(), clang::ento::mpi::MPIBugReporter::reportDoubleNonblocking(), clang::ento::mpi::MPIBugReporter::reportMissingWait(), and clang::ento::mpi::MPIBugReporter::reportUnmatchedWait().

Kind clang::ento::MemRegion::getKind ( ) const

inline

Definition at line 148 of file MemRegion.h.

const MemSpaceRegion * MemRegion::getMemorySpace ( ) const

Definition at line 1055 of file MemRegion.cpp.

References clang::ento::SubRegion::getSuperRegion().

Referenced by collectSubRegionBindings(), computeExtentBegin(), didPreviousFreeFail(), evalBinOpFieldRegionFieldRegion(), getExistingLazyBinding(), and isInitializationOfVar().

virtual MemRegionManager* clang::ento::MemRegion::getMemRegionManager ( ) const

pure virtual

Implemented in clang::ento::SubRegion, and clang::ento::MemSpaceRegion.

Referenced by clang::ento::mpi::MPIChecker::checkMissingWaits(), and clang::ento::SubRegion::getMemRegionManager().

std::string MemRegion::getString ( ) const

Get a string representation of a region for debug use.

Definition at line 399 of file MemRegion.cpp.

Referenced by clang::ento::SValExplainer::VisitStringRegion().

const SymbolicRegion * MemRegion::getSymbolicBase ( ) const

If this is a symbolic region, returns the region.

Otherwise, goes up the base chain looking for the first symbolic base region.

Definition at line 1135 of file MemRegion.cpp.

References clang::ento::SubRegion::getSuperRegion().

Referenced by clang::ento::createSimpleSValBuilder(), clang::ento::ProgramStateTrait< SymbolSet >::GDMIndex(), and clang::ento::SVal::getAsLocSymbol().

bool MemRegion::hasGlobalsOrParametersStorage ( ) const

Definition at line 1079 of file MemRegion.cpp.

bool MemRegion::hasStackNonParametersStorage ( ) const

Definition at line 1071 of file MemRegion.cpp.

Referenced by collectSubRegionBindings(), and getExistingLazyBinding().

bool MemRegion::hasStackParametersStorage ( ) const

Definition at line 1075 of file MemRegion.cpp.

bool MemRegion::hasStackStorage ( ) const

Definition at line 1067 of file MemRegion.cpp.

virtual bool clang::ento::MemRegion::isBoundable ( ) const

inlinevirtual

Reimplemented in clang::ento::CompoundLiteralRegion, clang::ento::ObjCStringRegion, clang::ento::StringRegion, clang::ento::SymbolicRegion, clang::ento::CodeTextRegion, clang::ento::TypedRegion, clang::ento::AllocaRegion, and clang::ento::MemSpaceRegion.

Definition at line 152 of file MemRegion.h.

Referenced by clang::ento::StoreManager::castRegion(), collectSubRegionBindings(), and clang::ento::ProgramState::getSValAsScalarOrLoc().

bool MemRegion::isSubRegionOf ( const MemRegion * R ) const

virtual

Check if the region is a subregion of the given region.

Reimplemented in clang::ento::SubRegion.

Definition at line 1105 of file MemRegion.cpp.

Referenced by collectSubRegionBindings(), and clang::ento::UndefOrNullArgVisitor::VisitNode().

void MemRegion::printPretty ( raw_ostream & os ) const

virtual

Print the region for use in diagnostics.

Reimplemented in clang::ento::FieldRegion.

Definition at line 534 of file MemRegion.cpp.

Referenced by didPreviousFreeFail().

void MemRegion::printPrettyAsExpr ( raw_ostream & os ) const

virtual

Print the region as expression.

When this region represents a subexpression, the method is for printing an expression containing it.

Reimplemented in clang::ento::CXXBaseObjectRegion, clang::ento::ObjCIvarRegion, clang::ento::FieldRegion, and clang::ento::VarRegion.

Definition at line 541 of file MemRegion.cpp.

Referenced by getDescriptiveName(), clang::ento::FieldRegion::printPrettyAsExpr(), and clang::ento::CXXBaseObjectRegion::printPrettyAsExpr().

virtual void clang::ento::MemRegion::Profile ( llvm::FoldingSetNodeID & ID ) const

pure virtual

Implemented in clang::ento::CXXBaseObjectRegion, clang::ento::CXXTempObjectRegion, clang::ento::ElementRegion, clang::ento::DeclRegion, clang::ento::CompoundLiteralRegion, clang::ento::ObjCStringRegion, clang::ento::StringRegion, clang::ento::SymbolicRegion, clang::ento::BlockDataRegion, clang::ento::BlockCodeRegion, clang::ento::FunctionCodeRegion, clang::ento::AllocaRegion, clang::ento::StackSpaceRegion, clang::ento::StaticGlobalSpaceRegion, and clang::ento::MemSpaceRegion.

SourceRange MemRegion::sourceRange ( ) const

Retrieve source range from memory region.

The range retrieval is based on the decl obtained from the memory region. For a VarRegion the range of the base region is returned. For a FieldRegion the range of the field is returned. If no declaration is found, an empty source range is returned. The client is responsible for checking if the returned range is valid.

Returns: source range for declaration retrieved from memory region

Definition at line 633 of file MemRegion.cpp.

References clang::ento::VarRegion::getDecl(), clang::ento::FieldRegion::getDecl(), clang::VarDecl::getSourceRange(), and clang::FieldDecl::getSourceRange().

Referenced by clang::ento::mpi::MPIBugReporter::reportDoubleNonblocking(), clang::ento::mpi::MPIBugReporter::reportMissingWait(), and clang::ento::mpi::MPIBugReporter::reportUnmatchedWait().

const MemRegion * MemRegion::StripCasts ( bool StripBaseCasts = true ) const

Definition at line 1113 of file MemRegion.cpp.

References clang::ento::ElementRegion::getIndex(), getKind(), clang::ento::SubRegion::getSuperRegion(), and clang::ento::SVal::isZeroConstant().

Referenced by clang::ento::StoreManager::attemptDownCast(), clang::ento::StoreManager::castRegion(), clang::ento::ExprEngine::defaultEvalCall(), didPreviousFreeFail(), clang::ento::SVal::getAsLocSymbol(), clang::ento::getDynamicTypeInfo(), clang::ento::StoreManager::getLValueElement(), clang::CXXInstanceCall::getRuntimeDefinition(), clang::ento::ExprEngine::notifyCheckersOfPointerEscape(), clang::ento::setDynamicTypeInfo(), clang::ento::loc::MemRegionVal::stripCasts(), updateOutParameter(), and clang::ento::UndefOrNullArgVisitor::VisitNode().

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

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation