clang  14.0.0git
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
clang::ento::SMTConstraintManager Class Reference

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

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

Public Member Functions

 SMTConstraintManager (clang::ento::ExprEngine *EE, clang::ento::SValBuilder &SB)
 
virtual ~SMTConstraintManager ()=default
 
ProgramStateRef assumeSym (ProgramStateRef State, SymbolRef Sym, bool Assumption) override
 Given a symbolic expression that can be reasoned about, assume that it is true/false and generate the new program state. More...
 
ProgramStateRef assumeSymInclusiveRange (ProgramStateRef State, SymbolRef Sym, const llvm::APSInt &From, const llvm::APSInt &To, bool InRange) override
 Given a symbolic expression within the range [From, To], assume that it is true/false and generate the new program state. More...
 
ProgramStateRef assumeSymUnsupported (ProgramStateRef State, SymbolRef Sym, bool Assumption) override
 Given a symbolic expression that cannot be reasoned about, assume that it is zero/nonzero and add it directly to the solver state. More...
 
ConditionTruthVal checkNull (ProgramStateRef State, SymbolRef Sym) override
 Returns whether or not a symbol is known to be null ("true"), known to be non-null ("false"), or may be either ("underconstrained"). More...
 
const llvm::APSIntgetSymVal (ProgramStateRef State, SymbolRef Sym) const override
 If a symbol is perfectly constrained to a constant, attempt to return the concrete value. More...
 
ProgramStateRef removeDeadBindings (ProgramStateRef State, SymbolReaper &SymReaper) override
 Scan all symbols referenced by the constraints. More...
 
void printJson (raw_ostream &Out, ProgramStateRef State, const char *NL="\n", unsigned int Space=0, bool IsDot=false) const override
 
bool haveEqualConstraints (ProgramStateRef S1, ProgramStateRef S2) const override
 
bool canReasonAbout (SVal X) const override
 canReasonAbout - Not all ConstraintManagers can accurately reason about all SVal values. More...
 
LLVM_DUMP_METHOD void dump () const
 Dumps SMT formula. More...
 
- Public Member Functions inherited from clang::ento::SimpleConstraintManager
 SimpleConstraintManager (ExprEngine *exprengine, SValBuilder &SB)
 
 ~SimpleConstraintManager () override
 
ProgramStateRef assume (ProgramStateRef State, DefinedSVal Cond, bool Assumption) override
 Ensures that the DefinedSVal conditional is expressed as a NonLoc by creating boolean casts to handle Loc's. More...
 
ProgramStateRef assumeInclusiveRange (ProgramStateRef State, NonLoc Value, const llvm::APSInt &From, const llvm::APSInt &To, bool InRange) override
 
- Public Member Functions inherited from clang::ento::ConstraintManager
 ConstraintManager ()=default
 
virtual ~ConstraintManager ()
 
ProgramStatePair assumeDual (ProgramStateRef State, DefinedSVal Cond)
 Returns a pair of states (StTrue, StFalse) where the given condition is assumed to be true or false, respectively. More...
 
virtual ProgramStatePair assumeInclusiveRangeDual (ProgramStateRef State, NonLoc Value, const llvm::APSInt &From, const llvm::APSInt &To)
 
ConditionTruthVal isNull (ProgramStateRef State, SymbolRef Sym)
 Convenience method to query the state to see if a symbol is null or not null, or if neither assumption can be made. More...
 

Protected Member Functions

virtual ProgramStateRef assumeExpr (ProgramStateRef State, SymbolRef Sym, const llvm::SMTExprRef &Exp)
 
virtual void addStateConstraints (ProgramStateRef State) const
 Given a program state, construct the logical conjunction and add it to the solver. More...
 
ConditionTruthVal checkModel (ProgramStateRef State, SymbolRef Sym, const llvm::SMTExprRef &Exp) const
 
- Protected Member Functions inherited from clang::ento::SimpleConstraintManager
SValBuildergetSValBuilder () const
 
BasicValueFactorygetBasicVals () const
 
SymbolManagergetSymbolManager () const
 

Protected Attributes

llvm::DenseMap< unsigned, ConditionTruthValCached
 
- Protected Attributes inherited from clang::ento::ConstraintManager
bool NotifyAssumeClients = true
 A flag to indicate that clients should be notified of assumptions. More...
 

Additional Inherited Members

- Public Types inherited from clang::ento::ConstraintManager
using ProgramStatePair = std::pair< ProgramStateRef, ProgramStateRef >
 

Detailed Description

Definition at line 30 of file SMTConstraintManager.h.

Constructor & Destructor Documentation

◆ SMTConstraintManager()

clang::ento::SMTConstraintManager::SMTConstraintManager ( clang::ento::ExprEngine EE,
clang::ento::SValBuilder SB 
)
inline

Definition at line 34 of file SMTConstraintManager.h.

◆ ~SMTConstraintManager()

virtual clang::ento::SMTConstraintManager::~SMTConstraintManager ( )
virtualdefault

Member Function Documentation

◆ addStateConstraints()

virtual void clang::ento::SMTConstraintManager::addStateConstraints ( ProgramStateRef  State) const
inlineprotectedvirtual

Given a program state, construct the logical conjunction and add it to the solver.

Definition at line 308 of file SMTConstraintManager.h.

References State.

Referenced by checkModel(), and getSymVal().

◆ assumeExpr()

virtual ProgramStateRef clang::ento::SMTConstraintManager::assumeExpr ( ProgramStateRef  State,
SymbolRef  Sym,
const llvm::SMTExprRef &  Exp 
)
inlineprotectedvirtual

Definition at line 297 of file SMTConstraintManager.h.

References checkModel(), and State.

Referenced by assumeSym(), and assumeSymInclusiveRange().

◆ assumeSym()

ProgramStateRef clang::ento::SMTConstraintManager::assumeSym ( ProgramStateRef  State,
SymbolRef  Sym,
bool  Assumption 
)
inlineoverridevirtual

Given a symbolic expression that can be reasoned about, assume that it is true/false and generate the new program state.

Implements clang::ento::SimpleConstraintManager.

Definition at line 43 of file SMTConstraintManager.h.

References assumeExpr(), clang::ento::SimpleConstraintManager::getBasicVals(), clang::ento::BasicValueFactory::getContext(), clang::ento::SMTConv::getExpr(), clang::ento::SMTConv::getZeroExpr(), clang::Type::isBooleanType(), and State.

◆ assumeSymInclusiveRange()

ProgramStateRef clang::ento::SMTConstraintManager::assumeSymInclusiveRange ( ProgramStateRef  State,
SymbolRef  Sym,
const llvm::APSInt From,
const llvm::APSInt To,
bool  InRange 
)
inlineoverridevirtual

Given a symbolic expression within the range [From, To], assume that it is true/false and generate the new program state.

This function is used to handle case ranges produced by a language extension for switch case statements.

Implements clang::ento::SimpleConstraintManager.

Definition at line 63 of file SMTConstraintManager.h.

References assumeExpr(), clang::ento::SimpleConstraintManager::getBasicVals(), clang::ento::BasicValueFactory::getContext(), clang::ento::SMTConv::getRangeExpr(), clang::interp::InRange(), and State.

◆ assumeSymUnsupported()

ProgramStateRef clang::ento::SMTConstraintManager::assumeSymUnsupported ( ProgramStateRef  State,
SymbolRef  Sym,
bool  Assumption 
)
inlineoverridevirtual

Given a symbolic expression that cannot be reasoned about, assume that it is zero/nonzero and add it directly to the solver state.

Implements clang::ento::SimpleConstraintManager.

Definition at line 72 of file SMTConstraintManager.h.

References State.

◆ canReasonAbout()

bool clang::ento::SMTConstraintManager::canReasonAbout ( SVal  X) const
inlineoverridevirtual

canReasonAbout - Not all ConstraintManagers can accurately reason about all SVal values.

This method returns true if the ConstraintManager can reasonably handle a given SVal value. This is typically queried by ExprEngine to determine if the value should be replaced with a conjured symbolic value in order to recover some precision.

Implements clang::ento::ConstraintManager.

Definition at line 246 of file SMTConstraintManager.h.

References clang::ento::SimpleConstraintManager::getBasicVals(), clang::ento::BasicValueFactory::getContext(), clang::TargetInfo::getLongDoubleFormat(), clang::ento::SimpleConstraintManager::getSValBuilder(), clang::ASTContext::getTargetInfo(), clang::ento::SymExpr::getType(), clang::Type::isComplexIntegerType(), clang::Type::isComplexType(), clang::Type::isRealFloatingType(), clang::Type::isSpecificBuiltinType(), clang::ento::SValBuilder::makeSymbolVal(), and clang::tooling::X().

◆ checkModel()

ConditionTruthVal clang::ento::SMTConstraintManager::checkModel ( ProgramStateRef  State,
SymbolRef  Sym,
const llvm::SMTExprRef &  Exp 
) const
inlineprotected

Definition at line 327 of file SMTConstraintManager.h.

References addStateConstraints(), Cached, and State.

Referenced by assumeExpr(), and checkNull().

◆ checkNull()

ConditionTruthVal clang::ento::SMTConstraintManager::checkNull ( ProgramStateRef  State,
SymbolRef  Sym 
)
inlineoverridevirtual

◆ dump()

LLVM_DUMP_METHOD void clang::ento::SMTConstraintManager::dump ( ) const
inline

Dumps SMT formula.

Definition at line 293 of file SMTConstraintManager.h.

◆ getSymVal()

const llvm::APSInt* clang::ento::SMTConstraintManager::getSymVal ( ProgramStateRef  state,
SymbolRef  sym 
) const
inlineoverridevirtual

◆ haveEqualConstraints()

bool clang::ento::SMTConstraintManager::haveEqualConstraints ( ProgramStateRef  S1,
ProgramStateRef  S2 
) const
inlineoverridevirtual

Implements clang::ento::ConstraintManager.

Definition at line 241 of file SMTConstraintManager.h.

◆ printJson()

void clang::ento::SMTConstraintManager::printJson ( raw_ostream &  Out,
ProgramStateRef  State,
const char *  NL = "\n",
unsigned int  Space = 0,
bool  IsDot = false 
) const
inlineoverridevirtual

Implements clang::ento::ConstraintManager.

Definition at line 213 of file SMTConstraintManager.h.

References clang::Indent(), and State.

◆ removeDeadBindings()

ProgramStateRef clang::ento::SMTConstraintManager::removeDeadBindings ( ProgramStateRef  state,
SymbolReaper SymReaper 
)
inlineoverridevirtual

Scan all symbols referenced by the constraints.

If the symbol is not alive, remove it.

Implements clang::ento::ConstraintManager.

Definition at line 200 of file SMTConstraintManager.h.

References clang::ento::SymbolReaper::isDead(), and State.

Member Data Documentation

◆ Cached

llvm::DenseMap<unsigned, ConditionTruthVal> clang::ento::SMTConstraintManager::Cached
mutableprotected

Definition at line 354 of file SMTConstraintManager.h.

Referenced by checkModel().


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