clang  14.0.0git
Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
clang::ento::CXXAllocatorCall Class Reference

Represents the memory allocation call in a C++ new-expression. More...

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

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

Public Member Functions

const CXXNewExprgetOriginExpr () const override
 Returns the expression whose value will be the result of this call. More...
 
const FunctionDeclgetDecl () const override
 Returns the declaration of the function or method that will be called. More...
 
SVal getObjectUnderConstruction () const
 
unsigned getNumImplicitArgs () const
 Number of non-placement arguments to the call. More...
 
unsigned getNumArgs () const override
 Returns the number of arguments (explicit and implicit). More...
 
const ExprgetArgExpr (unsigned Index) const override
 Returns the expression associated with a given argument. More...
 
const ExprgetPlacementArgExpr (unsigned Index) const
 Number of placement arguments to the operator new() call. More...
 
Kind getKind () const override
 Returns the kind of call this is. More...
 
StringRef getKindAsString () const override
 
- Public Member Functions inherited from clang::ento::AnyFunctionCall
RuntimeDefinition getRuntimeDefinition () const override
 Returns the definition of the function or method that will be called. More...
 
bool argumentsMayEscape () const override
 Returns true if any of the arguments are known to escape to long- term storage, even if this method will not modify them. More...
 
void getInitialStackFrameContents (const StackFrameContext *CalleeCtx, BindingsTy &Bindings) const override
 Populates the given SmallVector with the bindings in the callee's stack frame at the start of this call. More...
 
ArrayRef< ParmVarDecl * > parameters () const override
 Return call's formal parameters. More...
 
- Public Member Functions inherited from clang::ento::CallEvent
CallEventoperator= (const CallEvent &)=delete
 
virtual ~CallEvent ()=default
 
const ProgramStateRefgetState () const
 The state in which the call is being evaluated. More...
 
const LocationContextgetLocationContext () const
 The context in which the call is being evaluated. More...
 
bool isInSystemHeader () const
 Returns true if the callee is known to be from a system header. More...
 
bool isCalled (const CallDescription &CD) const
 Returns true if the CallEvent is a call to a function that matches the CallDescription. More...
 
template<typename FirstCallDesc , typename... CallDescs>
bool isCalled (const FirstCallDesc &First, const CallDescs &... Rest) const
 Returns true whether the CallEvent is any of the CallDescriptions supplied as a parameter. More...
 
virtual SourceRange getSourceRange () const
 Returns a source range for the entire call, suitable for outputting in diagnostics. More...
 
virtual SVal getArgSVal (unsigned Index) const
 Returns the value of a given argument at the time of the call. More...
 
virtual SourceRange getArgSourceRange (unsigned Index) const
 Returns the source range for errors associated with this argument. More...
 
QualType getResultType () const
 Returns the result type, adjusted for references. More...
 
SVal getReturnValue () const
 Returns the return value of the call. More...
 
bool hasNonNullArgumentsWithType (bool(*Condition)(QualType)) const
 Returns true if the type of any of the non-null arguments satisfies the condition. More...
 
bool hasNonZeroCallbackArg () const
 Returns true if any of the arguments appear to represent callbacks. More...
 
bool hasVoidPointerToNonConstArg () const
 Returns true if any of the arguments is void*. More...
 
bool isGlobalCFunction (StringRef SpecificName=StringRef()) const
 Returns true if the callee is an externally-visible function in the top-level namespace, such as malloc. More...
 
const IdentifierInfogetCalleeIdentifier () const
 Returns the name of the callee, if its name is a simple identifier. More...
 
ProgramPoint getProgramPoint (bool IsPreVisit=false, const ProgramPointTag *Tag=nullptr) const
 Returns an appropriate ProgramPoint for this call. More...
 
ProgramStateRef invalidateRegions (unsigned BlockCount, ProgramStateRef Orig=nullptr) const
 Returns a new state with all argument regions invalidated. More...
 
template<typename T >
CallEventRef< T > cloneWithState (ProgramStateRef NewState) const
 Returns a copy of this CallEvent, but using the given state. More...
 
CallEventRef cloneWithState (ProgramStateRef NewState) const
 Returns a copy of this CallEvent, but using the given state. More...
 
AnalysisDeclContextgetCalleeAnalysisDeclContext () const
 Returns AnalysisDeclContext for the callee stack frame. More...
 
const StackFrameContextgetCalleeStackFrame (unsigned BlockCount) const
 Returns the callee stack frame. More...
 
const ParamVarRegiongetParameterLocation (unsigned Index, unsigned BlockCount) const
 Returns memory location for a parameter variable within the callee stack frame. More...
 
bool isArgumentConstructedDirectly (unsigned Index) const
 Returns true if on the current path, the argument was constructed by calling a C++ constructor over it. More...
 
virtual Optional< unsignedgetAdjustedParameterIndex (unsigned ASTArgumentIndex) const
 Some calls have parameter numbering mismatched from argument numbering. More...
 
virtual unsigned getASTArgumentIndex (unsigned CallArgumentIndex) const
 Some call event sub-classes conveniently adjust mismatching AST indices to match parameter indices. More...
 
const ConstructionContextgetConstructionContext () const
 Returns the construction context of the call, if it is a C++ constructor call or a call of a function returning a C++ class instance. More...
 
Optional< SValgetReturnValueUnderConstruction () const
 If the call returns a C++ record type then the region of its return value can be retrieved from its construction context. More...
 
param_type_iterator param_type_begin () const
 Returns an iterator over the types of the call's formal parameters. More...
 
param_type_iterator param_type_end () const
 
void dump (raw_ostream &Out) const
 
void dump () const
 

Static Public Member Functions

static bool classof (const CallEvent *CE)
 
- Static Public Member Functions inherited from clang::ento::AnyFunctionCall
static bool classof (const CallEvent *CA)
 
- Static Public Member Functions inherited from clang::ento::CallEvent
static bool isCallStmt (const Stmt *S)
 Returns true if this is a statement is a function or method call of some kind. More...
 
static QualType getDeclaredResultType (const Decl *D)
 Returns the result type of a function or method declaration. More...
 
static bool isVariadic (const Decl *D)
 Returns true if the given decl is known to be variadic. More...
 

Protected Member Functions

 CXXAllocatorCall (const CXXNewExpr *E, ProgramStateRef St, const LocationContext *LCtx)
 
 CXXAllocatorCall (const CXXAllocatorCall &Other)=default
 
void cloneTo (void *Dest) const override
 Copies this CallEvent, with vtable intact, into a new block of memory. More...
 
- Protected Member Functions inherited from clang::ento::AnyFunctionCall
 AnyFunctionCall (const Expr *E, ProgramStateRef St, const LocationContext *LCtx)
 
 AnyFunctionCall (const Decl *D, ProgramStateRef St, const LocationContext *LCtx)
 
 AnyFunctionCall (const AnyFunctionCall &Other)=default
 
- Protected Member Functions inherited from clang::ento::CallEvent
 CallEvent (const Expr *E, ProgramStateRef state, const LocationContext *lctx)
 
 CallEvent (const Decl *D, ProgramStateRef state, const LocationContext *lctx)
 
 CallEvent (const CallEvent &Original)
 
SVal getSVal (const Stmt *S) const
 Get the value of arbitrary expressions at this point in the path. More...
 
virtual void getExtraInvalidatedValues (ValueList &Values, RegionAndSymbolInvalidationTraits *ETraits) const
 Used to specify non-argument regions that will be invalidated as a result of this call. More...
 

Friends

class CallEventManager
 

Additional Inherited Members

- Public Types inherited from clang::ento::CallEvent
using Kind = CallEventKind
 
using FrameBindingTy = std::pair< SVal, SVal >
 
using BindingsTy = SmallVectorImpl< FrameBindingTy >
 
using param_type_iterator = llvm::mapped_iterator< ArrayRef< ParmVarDecl * >::iterator, GetTypeFn >
 
- Protected Types inherited from clang::ento::CallEvent
using ValueList = SmallVectorImpl< SVal >
 
- Protected Attributes inherited from clang::ento::CallEvent
const void * Data
 
SourceLocation Location
 

Detailed Description

Represents the memory allocation call in a C++ new-expression.

This is a call to "operator new".

Definition at line 1000 of file CallEvent.h.

Constructor & Destructor Documentation

◆ CXXAllocatorCall() [1/2]

clang::ento::CXXAllocatorCall::CXXAllocatorCall ( const CXXNewExpr E,
ProgramStateRef  St,
const LocationContext LCtx 
)
inlineprotected

Definition at line 1004 of file CallEvent.h.

Referenced by cloneTo().

◆ CXXAllocatorCall() [2/2]

clang::ento::CXXAllocatorCall::CXXAllocatorCall ( const CXXAllocatorCall Other)
protecteddefault

Member Function Documentation

◆ classof()

static bool clang::ento::CXXAllocatorCall::classof ( const CallEvent CE)
inlinestatic

◆ cloneTo()

void clang::ento::CXXAllocatorCall::cloneTo ( void *  Dest) const
inlineoverrideprotectedvirtual

Copies this CallEvent, with vtable intact, into a new block of memory.

Implements clang::ento::CallEvent.

Definition at line 1009 of file CallEvent.h.

References CXXAllocatorCall().

◆ getArgExpr()

const Expr* clang::ento::CXXAllocatorCall::getArgExpr ( unsigned  Index) const
inlineoverridevirtual

Returns the expression associated with a given argument.

May be null if this expression does not appear in the source.

Reimplemented from clang::ento::CallEvent.

Definition at line 1037 of file CallEvent.h.

◆ getDecl()

const FunctionDecl* clang::ento::CXXAllocatorCall::getDecl ( ) const
inlineoverridevirtual

Returns the declaration of the function or method that will be called.

May be null.

Reimplemented from clang::ento::AnyFunctionCall.

Definition at line 1016 of file CallEvent.h.

References clang::CXXNewExpr::getOperatorNew(), and getOriginExpr().

◆ getKind()

Kind clang::ento::CXXAllocatorCall::getKind ( ) const
inlineoverridevirtual

Returns the kind of call this is.

Implements clang::ento::CallEvent.

Definition at line 1052 of file CallEvent.h.

References clang::ento::CE_CXXAllocator.

◆ getKindAsString()

StringRef clang::ento::CXXAllocatorCall::getKindAsString ( ) const
inlineoverridevirtual

Implements clang::ento::CallEvent.

Definition at line 1053 of file CallEvent.h.

◆ getNumArgs()

unsigned clang::ento::CXXAllocatorCall::getNumArgs ( ) const
inlineoverridevirtual

Returns the number of arguments (explicit and implicit).

Note that this may be greater than the number of parameters in the callee's declaration, and that it may include arguments not written in the source.

Implements clang::ento::CallEvent.

Definition at line 1033 of file CallEvent.h.

References getNumImplicitArgs(), clang::CXXNewExpr::getNumPlacementArgs(), and getOriginExpr().

◆ getNumImplicitArgs()

unsigned clang::ento::CXXAllocatorCall::getNumImplicitArgs ( ) const
inline

Number of non-placement arguments to the call.

It is equal to 2 for C++17 aligned operator new() calls that have alignment implicitly passed as the second argument, and to 1 for other operator new() calls.

Definition at line 1029 of file CallEvent.h.

References getOriginExpr(), and clang::CXXNewExpr::passAlignment().

Referenced by getNumArgs().

◆ getObjectUnderConstruction()

SVal clang::ento::CXXAllocatorCall::getObjectUnderConstruction ( ) const
inline

◆ getOriginExpr()

const CXXNewExpr* clang::ento::CXXAllocatorCall::getOriginExpr ( ) const
inlineoverridevirtual

Returns the expression whose value will be the result of this call.

May be null.

Reimplemented from clang::ento::CallEvent.

Definition at line 1012 of file CallEvent.h.

References clang::ento::CallEvent::getOriginExpr().

Referenced by getDecl(), getNumArgs(), getNumImplicitArgs(), and getObjectUnderConstruction().

◆ getPlacementArgExpr()

const Expr* clang::ento::CXXAllocatorCall::getPlacementArgExpr ( unsigned  Index) const
inline

Number of placement arguments to the operator new() call.

For example, standard std::nothrow operator new and standard placement new both have 1 implicit argument (size) and 1 placement argument, while regular operator new() has 1 implicit argument and 0 placement arguments.

Definition at line 1048 of file CallEvent.h.

Friends And Related Function Documentation

◆ CallEventManager

friend class CallEventManager
friend

Definition at line 1001 of file CallEvent.h.


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