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

#include "clang/StaticAnalyzer/Core/PathSensitive/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 LLVM_ATTRIBUTE_RETURNS_NONNULL MemSpaceRegion *	getMemorySpace () const

const LLVM_ATTRIBUTE_RETURNS_NONNULL MemRegion *	getBaseRegion () const

const LLVM_ATTRIBUTE_RETURNS_NONNULL MemRegion *	getMostDerivedObjectRegion () const
	Recursively retrieve the region of the most derived class instance of regions of C++ base class instances. More...

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

const LLVM_ATTRIBUTE_RETURNS_NONNULL MemRegion *	StripCasts (bool StripBaseAndDerivedCasts=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

template<typename RegionTy >
const LLVM_ATTRIBUTE_RETURNS_NONNULL RegionTy *	castAs () const

virtual bool	isBoundable () const

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

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 95 of file MemRegion.h.

Member Enumeration Documentation

◆ Kind

enum clang::ento::MemRegion::Kind

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

Definition at line 97 of file MemRegion.h.

Constructor & Destructor Documentation

◆ MemRegion()

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

inlineprotected

Definition at line 108 of file MemRegion.h.

◆ ~MemRegion()

MemRegion::~MemRegion ( )

protectedvirtualdefault

Member Function Documentation

◆ canPrintPretty()

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 593 of file MemRegion.cpp.

References canPrintPrettyAsExpr().

Referenced by printPretty().

◆ canPrintPrettyAsExpr()

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::CXXDerivedObjectRegion, clang::ento::CXXBaseObjectRegion, clang::ento::ObjCIvarRegion, clang::ento::FieldRegion, clang::ento::ParamVarRegion, and clang::ento::NonParamVarRegion.

Definition at line 597 of file MemRegion.cpp.

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

◆ castAs()

template<typename RegionTy >

const LLVM_ATTRIBUTE_RETURNS_NONNULL RegionTy * clang::ento::MemRegion::castAs

Definition at line 1333 of file MemRegion.h.

◆ dump()

LLVM_DUMP_METHOD void MemRegion::dump ( ) const

Definition at line 441 of file MemRegion.cpp.

References dumpToStream().

◆ dumpToStream()

void MemRegion::dumpToStream ( raw_ostream & os ) const

virtual

Definition at line 452 of file MemRegion.cpp.

Referenced by dump(), getString(), and clang::ento::operator<<().

◆ getAs()

template<typename RegionTy >

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

Definition at line 1325 of file MemRegion.h.

Referenced by clang::ento::retaincountchecker::RetainCountChecker::checkRegionChanges(), dereference(), clang::ento::SVal::getAsFunctionDecl(), getConstructedRegion(), and getDescriptiveName().

◆ getAsOffset()

RegionOffset MemRegion::getAsOffset ( ) const

Compute the offset within the top level memory object.

Definition at line 1598 of file MemRegion.cpp.

References calculateOffset().

◆ getBaseRegion()

const MemRegion * MemRegion::getBaseRegion ( ) const

Definition at line 1290 of file MemRegion.cpp.

References getKind().

Referenced by clang::ento::CXXInstanceCall::getExtraInvalidatedValues(), clang::ento::PathSensitiveBugReport::getInterestingnessKind(), clang::ento::PathSensitiveBugReport::markNotInteresting(), clang::ento::ExprEngine::ProcessAutomaticObjDtor(), clang::ento::ExprEngine::processPointerEscapedOnBind(), clang::ento::ScanReachableSymbols::scan(), and sourceRange().

◆ getContext()

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

inline

Definition at line 1549 of file MemRegion.h.

References clang::ento::MemRegionManager::getContext(), and getMemRegionManager().

Referenced by clang::ento::AllocaRegion::dumpToStream(), clang::ento::StringRegion::dumpToStream(), clang::ento::ObjCStringRegion::dumpToStream(), clang::ento::CompoundLiteralRegion::dumpToStream(), clang::ento::CXXTempObjectRegion::dumpToStream(), clang::ento::ElementRegion::getAsArrayOffset(), clang::ento::MemRegionManager::getElementRegionWithSuper(), clang::ento::TypedValueRegion::getLocationType(), and clang::ento::FunctionCodeRegion::getLocationType().

◆ getDescriptiveName()

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 675 of file MemRegion.cpp.

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

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

◆ getKind()

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

inline

Definition at line 173 of file MemRegion.h.

◆ getMemorySpace()

const MemSpaceRegion * MemRegion::getMemorySpace ( ) const

Definition at line 1260 of file MemRegion.cpp.

Referenced by GetAllocationSite(), clang::ento::VarRegion::getStackFrame(), hasGlobalsOrParametersStorage(), hasStackNonParametersStorage(), hasStackParametersStorage(), hasStackStorage(), and clang::ento::SValExplainer::VisitSymbolicRegion().

◆ getMemRegionManager()

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

pure virtual

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

Referenced by getContext(), and clang::ento::SubRegion::getMemRegionManager().

◆ getMostDerivedObjectRegion()

const MemRegion * MemRegion::getMostDerivedObjectRegion ( ) const

Recursively retrieve the region of the most derived class instance of regions of C++ base class instances.

Definition at line 1311 of file MemRegion.cpp.

◆ getString()

std::string MemRegion::getString ( ) const

Get a string representation of a region for debug use.

Definition at line 445 of file MemRegion.cpp.

References dumpToStream(), s, and string().

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

◆ getSymbolicBase()

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. It might return null.

Definition at line 1349 of file MemRegion.cpp.

Referenced by clang::ento::SValBuilder::evalCastSubKind(), and clang::ento::SVal::getAsLocSymbol().

◆ hasGlobalsOrParametersStorage()

bool MemRegion::hasGlobalsOrParametersStorage ( ) const

Definition at line 1284 of file MemRegion.cpp.

References getMemorySpace().

◆ hasStackNonParametersStorage()

bool MemRegion::hasStackNonParametersStorage ( ) const

Definition at line 1276 of file MemRegion.cpp.

References getMemorySpace().

◆ hasStackParametersStorage()

bool MemRegion::hasStackParametersStorage ( ) const

Definition at line 1280 of file MemRegion.cpp.

References getMemorySpace().

◆ hasStackStorage()

bool MemRegion::hasStackStorage ( ) const

Definition at line 1272 of file MemRegion.cpp.

References getMemorySpace().

Referenced by clang::ento::ExprEngine::processPointerEscapedOnBind(), and shouldEscapeRegion().

◆ isBoundable()

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 179 of file MemRegion.h.

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

◆ isSubRegionOf()

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

virtual

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

Each region is a subregion of itself.

Reimplemented in clang::ento::SubRegion.

Definition at line 1318 of file MemRegion.cpp.

Referenced by clang::ento::UndefOrNullArgVisitor::VisitNode().

◆ printPretty()

void MemRegion::printPretty ( raw_ostream & os ) const

virtual

Print the region for use in diagnostics.

Reimplemented in clang::ento::FieldRegion.

Definition at line 601 of file MemRegion.cpp.

References canPrintPretty(), and printPrettyAsExpr().

◆ printPrettyAsExpr()

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::CXXDerivedObjectRegion, clang::ento::CXXBaseObjectRegion, clang::ento::ObjCIvarRegion, clang::ento::FieldRegion, clang::ento::ParamVarRegion, and clang::ento::NonParamVarRegion.

Definition at line 608 of file MemRegion.cpp.

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

◆ Profile()

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

pure virtual

◆ sourceRange()

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 714 of file MemRegion.cpp.

References getBaseRegion().

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

◆ StripCasts()

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

Definition at line 1326 of file MemRegion.cpp.

References getKind().

Referenced by clang::ento::ExprEngine::bindReturnValue(), clang::ento::StoreManager::castRegion(), clang::ento::retaincountchecker::RetainCountChecker::checkRegionChanges(), clang::ento::SValBuilder::evalCastSubKind(), clang::ento::CXXInstanceCall::getRuntimeDefinition(), clang::ento::loc::MemRegionVal::stripCasts(), and clang::ento::UndefOrNullArgVisitor::VisitNode().

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

include/clang/StaticAnalyzer/Core/PathSensitive/MemRegion.h
lib/StaticAnalyzer/Core/MemRegion.cpp

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ Kind

Constructor & Destructor Documentation

◆ MemRegion()

◆ ~MemRegion()

Member Function Documentation

◆ canPrintPretty()

◆ canPrintPrettyAsExpr()

◆ castAs()

◆ dump()

◆ dumpToStream()

◆ getAs()

◆ getAsOffset()

◆ getBaseRegion()

◆ getContext()

◆ getDescriptiveName()

◆ getKind()

◆ getMemorySpace()

◆ getMemRegionManager()

◆ getMostDerivedObjectRegion()

◆ getString()

◆ getSymbolicBase()

◆ hasGlobalsOrParametersStorage()

◆ hasStackNonParametersStorage()

◆ hasStackParametersStorage()

◆ hasStackStorage()

◆ isBoundable()

◆ isSubRegionOf()

◆ printPretty()

◆ printPrettyAsExpr()

◆ Profile()

◆ sourceRange()

◆ StripCasts()