clang  6.0.0svn
Macros | Enumerations | Functions
ExprEngineCallAndReturn.cpp File Reference
#include "clang/StaticAnalyzer/Core/PathSensitive/ExprEngine.h"
#include "PrettyStackTraceLocationContext.h"
#include "clang/AST/CXXInheritance.h"
#include "clang/AST/DeclCXX.h"
#include "clang/AST/ParentMap.h"
#include "clang/Analysis/Analyses/LiveVariables.h"
#include "clang/StaticAnalyzer/Core/CheckerManager.h"
#include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h"
#include "llvm/ADT/SmallSet.h"
#include "llvm/ADT/Statistic.h"
#include "llvm/Support/SaveAndRestore.h"
Include dependency graph for ExprEngineCallAndReturn.cpp:

Go to the source code of this file.

Macros

#define DEBUG_TYPE   "ExprEngine"
 

Enumerations

enum  DynamicDispatchMode
 
enum  CallInlinePolicy { CIP_Allowed, CIP_DisallowedOnce, CIP_DisallowedAlways }
 

Functions

 STATISTIC (NumOfDynamicDispatchPathSplits, "The # of times we split the path due to imprecise dynamic dispatch info")
 
 STATISTIC (NumInlinedCalls, "The # of times we inlined a call")
 
 STATISTIC (NumReachedInlineCountMax, "The # of times we reached inline count maximum")
 
static std::pair< const Stmt *, const CFGBlock * > getLastStmt (const ExplodedNode *Node)
 
static SVal adjustReturnValue (SVal V, QualType ExpectedTy, QualType ActualTy, StoreManager &StoreMgr)
 Adjusts a return value when the called function's return type does not match the caller's expression type. More...
 
static bool wasDifferentDeclUsedForInlining (CallEventRef<> Call, const StackFrameContext *calleeCtx)
 
static bool isTemporaryPRValue (const CXXConstructExpr *E, SVal V)
 Returns true if the CXXConstructExpr E was intended to construct a prvalue for the region in V. More...
 
 REGISTER_TRAIT_WITH_PROGRAMSTATE (DynamicDispatchBifurcationMap, CLANG_ENTO_PROGRAMSTATE_MAP(const MemRegion *, unsigned)) bool ExprEngine
 
static ProgramStateRef getInlineFailedState (ProgramStateRef State, const Stmt *CallE)
 
static CallInlinePolicy mayInlineCallKind (const CallEvent &Call, const ExplodedNode *Pred, AnalyzerOptions &Opts)
 
static bool hasMember (const ASTContext &Ctx, const CXXRecordDecl *RD, StringRef Name)
 Returns true if the given C++ class contains a member with the given name. More...
 
static bool isContainerClass (const ASTContext &Ctx, const CXXRecordDecl *RD)
 Returns true if the given C++ class is a container or iterator. More...
 
static bool isContainerMethod (const ASTContext &Ctx, const FunctionDecl *FD)
 Returns true if the given function refers to a method of a C++ container or iterator. More...
 
static bool isCXXSharedPtrDtor (const FunctionDecl *FD)
 Returns true if the given function is the destructor of a class named "shared_ptr". More...
 
static bool mayInlineDecl (AnalysisDeclContext *CalleeADC, AnalyzerOptions &Opts)
 Returns true if the function in CalleeADC may be inlined in general. More...
 
static bool isTrivialObjectAssignment (const CallEvent &Call)
 

Macro Definition Documentation

◆ DEBUG_TYPE

#define DEBUG_TYPE   "ExprEngine"

Definition at line 29 of file ExprEngineCallAndReturn.cpp.

Enumeration Type Documentation

◆ CallInlinePolicy

Enumerator
CIP_Allowed 
CIP_DisallowedOnce 
CIP_DisallowedAlways 

Definition at line 573 of file ExprEngineCallAndReturn.cpp.

◆ DynamicDispatchMode

Definition at line 394 of file ExprEngineCallAndReturn.cpp.

Function Documentation

◆ adjustReturnValue()

static SVal adjustReturnValue ( SVal  V,
QualType  ExpectedTy,
QualType  ActualTy,
StoreManager StoreMgr 
)
static

Adjusts a return value when the called function's return type does not match the caller's expression type.

This can happen when a dynamic call is devirtualized, and the overridding method has a covariant (more specific) return type than the parent's method. For C++ objects, this means we need to add base casts.

Definition at line 127 of file ExprEngineCallAndReturn.cpp.

References clang::ento::StoreManager::evalDerivedToBase(), clang::ExpectedClass, clang::CXXBasePaths::front(), clang::ento::SVal::getAs(), clang::QualType::getCanonicalType(), clang::Type::getCanonicalTypeUnqualified(), clang::Type::getPointeeCXXRecordDecl(), clang::CXXBasePaths::isAmbiguous(), clang::CXXRecordDecl::isDerivedFrom(), and clang::Type::isObjCObjectPointerType().

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

◆ getInlineFailedState()

static ProgramStateRef getInlineFailedState ( ProgramStateRef  State,
const Stmt CallE 
)
static

Definition at line 459 of file ExprEngineCallAndReturn.cpp.

◆ getLastStmt()

static std::pair<const Stmt*, const CFGBlock*> getLastStmt ( const ExplodedNode Node)
static

◆ hasMember()

static bool hasMember ( const ASTContext Ctx,
const CXXRecordDecl RD,
StringRef  Name 
)
static

Returns true if the given C++ class contains a member with the given name.

Definition at line 674 of file ExprEngineCallAndReturn.cpp.

Referenced by isContainerClass().

◆ isContainerClass()

static bool isContainerClass ( const ASTContext Ctx,
const CXXRecordDecl RD 
)
static

Returns true if the given C++ class is a container or iterator.

Our heuristic for this is whether it contains a method named 'begin()' or a nested type named 'iterator' or 'iterator_category'.

Definition at line 696 of file ExprEngineCallAndReturn.cpp.

References hasMember().

Referenced by isContainerMethod().

◆ isContainerMethod()

static bool isContainerMethod ( const ASTContext Ctx,
const FunctionDecl FD 
)
static

Returns true if the given function refers to a method of a C++ container or iterator.

We generally do a poor job modeling most containers right now, and might prefer not to inline their methods.

Definition at line 707 of file ExprEngineCallAndReturn.cpp.

References isContainerClass().

Referenced by mayInlineDecl().

◆ isCXXSharedPtrDtor()

static bool isCXXSharedPtrDtor ( const FunctionDecl FD)
static

Returns true if the given function is the destructor of a class named "shared_ptr".

Definition at line 716 of file ExprEngineCallAndReturn.cpp.

References clang::DeclarationName::getAsIdentifierInfo(), clang::NamedDecl::getDeclName(), and clang::CXXMethodDecl::getParent().

Referenced by mayInlineDecl().

◆ isTemporaryPRValue()

static bool isTemporaryPRValue ( const CXXConstructExpr E,
SVal  V 
)
static

Returns true if the CXXConstructExpr E was intended to construct a prvalue for the region in V.

Note that we can't just test for rvalue vs. glvalue because CXXConstructExprs embedded in DeclStmts and initializers are considered rvalues by the AST, and the analyzer would like to treat them as lvalues.

Definition at line 202 of file ExprEngineCallAndReturn.cpp.

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

◆ isTrivialObjectAssignment()

static bool isTrivialObjectAssignment ( const CallEvent Call)
static

◆ mayInlineCallKind()

static CallInlinePolicy mayInlineCallKind ( const CallEvent Call,
const ExplodedNode Pred,
AnalyzerOptions Opts 
)
static

◆ mayInlineDecl()

static bool mayInlineDecl ( AnalysisDeclContext CalleeADC,
AnalyzerOptions Opts 
)
static

Returns true if the function in CalleeADC may be inlined in general.

This checks static properties of the function, such as its signature and CFG, to determine whether the analyzer should ever consider inlining it, in any context.

Definition at line 734 of file ExprEngineCallAndReturn.cpp.

References CIP_Allowed, CIP_DisallowedAlways, clang::AnalyzerOptions::getAlwaysInlineSize(), clang::AnalysisDeclContext::getAnalysis(), clang::ento::AnalysisManager::getAnalysisDeclContextManager(), clang::ento::ExprEngine::getAnalysisManager(), clang::AnalysisDeclContext::getASTContext(), clang::AnalysisDeclContext::getCFG(), clang::AnalysisDeclContextManager::getContext(), clang::AnalysisDeclContext::getDecl(), clang::ASTContext::getLangOpts(), clang::ento::ExplodedNode::getLocationContext(), clang::AnalyzerOptions::getMaxInlinableSize(), clang::AnalyzerOptions::getMaxTimesInlineLarge(), clang::AnalyzerOptions::getMinCFGSizeTreatFunctionsAsLarge(), clang::CFG::getNumBlockIDs(), clang::ASTContext::getSourceManager(), clang::ento::ExprEngine::Inline_Minimal, clang::AnalyzerOptions::InlineMaxStackDepth, clang::AnalysisDeclContext::isBodyAutosynthesized(), isContainerMethod(), isCXXSharedPtrDtor(), clang::SourceManager::isInMainFile(), clang::AnalysisDeclContext::isInStdNamespace(), clang::SourceManager::isInSystemHeader(), clang::ento::CallEvent::isVariadic(), mayInlineCallKind(), clang::AnalyzerOptions::mayInlineCXXContainerMethods(), clang::AnalyzerOptions::mayInlineCXXSharedPtrDtor(), clang::AnalyzerOptions::mayInlineCXXStandardLibrary(), clang::AnalyzerOptions::mayInlineTemplateFunctions(), clang::ento::AnalysisManager::options, clang::ento::AnalysisManager::shouldInlineCall(), and clang::FunctionDecl::TK_NonTemplate.

◆ REGISTER_TRAIT_WITH_PROGRAMSTATE()

REGISTER_TRAIT_WITH_PROGRAMSTATE ( DynamicDispatchBifurcationMap  ,
CLANG_ENTO_PROGRAMSTATE_MAP(const MemRegion *, unsigned)   
)

◆ STATISTIC() [1/3]

STATISTIC ( NumOfDynamicDispatchPathSplits  ,
"The # of times we split the path due to imprecise dynamic dispatch info"   
)

◆ STATISTIC() [2/3]

STATISTIC ( NumInlinedCalls  ,
"The # of times we inlined a call"   
)

◆ STATISTIC() [3/3]

STATISTIC ( NumReachedInlineCountMax  ,
"The # of times we reached inline count maximum"   
)

◆ wasDifferentDeclUsedForInlining()

static bool wasDifferentDeclUsedForInlining ( CallEventRef<>  Call,
const StackFrameContext calleeCtx 
)
static