clang  10.0.0svn
Public Types | Public Member Functions | Protected Member Functions | List of all members
clang::ento::MemRegion Class Referenceabstract

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

#include "clang/StaticAnalyzer/Core/PathSensitive/MemRegion.h"

Inheritance diagram for clang::ento::MemRegion:
Inheritance graph
[legend]
Collaboration diagram for clang::ento::MemRegion:
Collaboration graph
[legend]

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

Member Enumeration Documentation

◆ Kind

enum clang::ento::MemRegion::Kind

Definition at line 96 of file MemRegion.h.

Constructor & Destructor Documentation

◆ MemRegion()

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

Definition at line 107 of file MemRegion.h.

References dump().

◆ ~MemRegion()

MemRegion::~MemRegion ( )
protectedvirtualdefault

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

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

◆ 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, and clang::ento::VarRegion.

Definition at line 588 of file MemRegion.cpp.

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

◆ castAs()

template<typename RegionTy >
const RegionTy * clang::ento::MemRegion::castAs ( ) const

Definition at line 1236 of file MemRegion.h.

◆ dump()

LLVM_DUMP_METHOD void MemRegion::dump ( ) const

Definition at line 443 of file MemRegion.cpp.

◆ dumpToStream()

void MemRegion::dumpToStream ( raw_ostream &  os) const
virtual

Reimplemented in clang::ento::CXXDerivedObjectRegion, clang::ento::CXXBaseObjectRegion, clang::ento::CXXTempObjectRegion, clang::ento::ElementRegion, clang::ento::ObjCIvarRegion, clang::ento::FieldRegion, clang::ento::CXXThisRegion, clang::ento::VarRegion, 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::StackArgumentsSpaceRegion, clang::ento::StackLocalsSpaceRegion, clang::ento::UnknownSpaceRegion, clang::ento::HeapSpaceRegion, clang::ento::GlobalInternalSpaceRegion, clang::ento::GlobalImmutableSpaceRegion, clang::ento::GlobalSystemSpaceRegion, clang::ento::StaticGlobalSpaceRegion, and clang::ento::CodeSpaceRegion.

Definition at line 454 of file MemRegion.cpp.

Referenced by clang::ento::operator<<().

◆ getAs()

template<typename RegionTy >
const RegionTy * clang::ento::MemRegion::getAs ( ) const

Definition at line 1228 of file MemRegion.h.

Referenced by clang::ento::mpi::MPIChecker::checkMissingWaits(), 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 1467 of file MemRegion.cpp.

References calculateOffset(), distance(), clang::ento::MemRegionManager::getAllocator(), clang::ento::MemRegionManager::getCodeRegion(), clang::ento::BlockCodeRegion::getDecl(), clang::AnalysisDeclContext::getReferencedBlockVars(), clang::ento::MemRegionManager::getUnknownRegion(), clang::ento::MemRegionManager::getVarRegion(), clang::Decl::hasAttr(), and clang::VarDecl::hasLocalStorage().

◆ getBaseRegion()

const MemRegion * MemRegion::getBaseRegion ( ) const

Definition at line 1160 of file MemRegion.cpp.

References getKind().

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

◆ getContext()

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

Definition at line 1436 of file MemRegion.h.

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

◆ 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
UseQuotesSet if the name should be quoted.
Returns
variable name for memory region

Definition at line 659 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().

◆ getKind()

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

Definition at line 169 of file MemRegion.h.

Referenced by clang::ento::StoreManager::castRegion(), clang::ento::MemSpaceRegion::classof(), clang::ento::CodeSpaceRegion::classof(), clang::ento::GlobalsSpaceRegion::classof(), clang::ento::StaticGlobalSpaceRegion::classof(), clang::ento::NonStaticGlobalSpaceRegion::classof(), clang::ento::GlobalSystemSpaceRegion::classof(), clang::ento::GlobalImmutableSpaceRegion::classof(), clang::ento::GlobalInternalSpaceRegion::classof(), clang::ento::HeapSpaceRegion::classof(), clang::ento::UnknownSpaceRegion::classof(), clang::ento::StackSpaceRegion::classof(), clang::ento::StackLocalsSpaceRegion::classof(), clang::ento::StackArgumentsSpaceRegion::classof(), clang::ento::SubRegion::classof(), clang::ento::AllocaRegion::classof(), clang::ento::TypedRegion::classof(), clang::ento::TypedValueRegion::classof(), clang::ento::CodeTextRegion::classof(), clang::ento::FunctionCodeRegion::classof(), clang::ento::BlockCodeRegion::classof(), clang::ento::BlockDataRegion::classof(), clang::ento::SymbolicRegion::classof(), clang::ento::StringRegion::classof(), clang::ento::ObjCStringRegion::classof(), clang::ento::CompoundLiteralRegion::classof(), clang::ento::DeclRegion::classof(), clang::ento::VarRegion::classof(), clang::ento::CXXThisRegion::classof(), clang::ento::FieldRegion::classof(), clang::ento::ObjCIvarRegion::classof(), clang::ento::ElementRegion::classof(), clang::ento::CXXTempObjectRegion::classof(), clang::ento::CXXBaseObjectRegion::classof(), clang::ento::CXXDerivedObjectRegion::classof(), getBaseRegion(), StripCasts(), and clang::ento::MemRegionVisitor< SValExplainer, std::string >::Visit().

◆ getMemorySpace()

const MemSpaceRegion * MemRegion::getMemorySpace ( ) const

Definition at line 1128 of file MemRegion.cpp.

Referenced by 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 clang::ento::mpi::MPIChecker::checkMissingWaits(), 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 1181 of file MemRegion.cpp.

◆ getString()

std::string MemRegion::getString ( ) const

Get a string representation of a region for debug use.

Definition at line 447 of file MemRegion.cpp.

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.

Definition at line 1219 of file MemRegion.cpp.

Referenced by clang::ento::SVal::getAsLocSymbol().

◆ hasGlobalsOrParametersStorage()

bool MemRegion::hasGlobalsOrParametersStorage ( ) const

Definition at line 1152 of file MemRegion.cpp.

◆ hasStackNonParametersStorage()

bool MemRegion::hasStackNonParametersStorage ( ) const

Definition at line 1144 of file MemRegion.cpp.

◆ hasStackParametersStorage()

bool MemRegion::hasStackParametersStorage ( ) const

Definition at line 1148 of file MemRegion.cpp.

◆ hasStackStorage()

bool MemRegion::hasStackStorage ( ) const

Definition at line 1140 of file MemRegion.cpp.

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

◆ printPretty()

void MemRegion::printPretty ( raw_ostream &  os) const
virtual

Print the region for use in diagnostics.

Reimplemented in clang::ento::FieldRegion.

Definition at line 592 of file MemRegion.cpp.

◆ 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, and clang::ento::VarRegion.

Definition at line 599 of file MemRegion.cpp.

Referenced by getDescriptiveName(), 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

Implemented in clang::ento::CXXDerivedObjectRegion, clang::ento::CXXBaseObjectRegion, clang::ento::CXXTempObjectRegion, clang::ento::ElementRegion, clang::ento::CXXThisRegion, clang::ento::VarRegion, 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()

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

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

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

References getKind().

Referenced by clang::ento::StoreManager::castRegion(), clang::ento::retaincountchecker::RetainCountChecker::checkRegionChanges(), clang::ento::SVal::getAsLocSymbol(), clang::ento::getDynamicTypeInfo(), clang::ento::setDynamicTypeInfo(), and clang::ento::loc::MemRegionVal::stripCasts().

The documentation for this class was generated from the following files:
Generated on Mon Nov 4 2019 00:56:07 for clang by   doxygen 1.8.13