clang  6.0.0svn
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
clang::ento::ConstraintManager Class Referenceabstract

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

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

Public Types

typedef std::pair< ProgramStateRef, ProgramStateRefProgramStatePair
 

Public Member Functions

 ConstraintManager ()
 
virtual ~ConstraintManager ()
 
virtual ProgramStateRef assume (ProgramStateRef state, DefinedSVal Cond, bool Assumption)=0
 
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 ProgramStateRef assumeInclusiveRange (ProgramStateRef State, NonLoc Value, const llvm::APSInt &From, const llvm::APSInt &To, bool InBound)=0
 
virtual ProgramStatePair assumeInclusiveRangeDual (ProgramStateRef State, NonLoc Value, const llvm::APSInt &From, const llvm::APSInt &To)
 
virtual const llvm::APSInt * getSymVal (ProgramStateRef state, SymbolRef sym) const
 If a symbol is perfectly constrained to a constant, attempt to return the concrete value. More...
 
virtual ProgramStateRef removeDeadBindings (ProgramStateRef state, SymbolReaper &SymReaper)=0
 Scan all symbols referenced by the constraints. More...
 
virtual void print (ProgramStateRef state, raw_ostream &Out, const char *nl, const char *sep)=0
 
virtual void EndPath (ProgramStateRef state)
 
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 bool canReasonAbout (SVal X) const =0
 canReasonAbout - Not all ConstraintManagers can accurately reason about all SVal values. More...
 
virtual ConditionTruthVal checkNull (ProgramStateRef State, SymbolRef Sym)
 Returns whether or not a symbol is known to be null ("true"), known to be non-null ("false"), or may be either ("underconstrained"). More...
 

Protected Attributes

bool NotifyAssumeClients
 A flag to indicate that clients should be notified of assumptions. More...
 

Detailed Description

Definition at line 62 of file ConstraintManager.h.

Member Typedef Documentation

◆ ProgramStatePair

Definition at line 71 of file ConstraintManager.h.

Constructor & Destructor Documentation

◆ ConstraintManager()

clang::ento::ConstraintManager::ConstraintManager ( )
inline

Definition at line 64 of file ConstraintManager.h.

References clang::CodeGen::state.

◆ ~ConstraintManager()

ConstraintManager::~ConstraintManager ( )
virtual

Definition at line 19 of file ConstraintManager.cpp.

Member Function Documentation

◆ assume()

virtual ProgramStateRef clang::ento::ConstraintManager::assume ( ProgramStateRef  state,
DefinedSVal  Cond,
bool  Assumption 
)
pure virtual

◆ assumeDual()

ProgramStatePair clang::ento::ConstraintManager::assumeDual ( ProgramStateRef  State,
DefinedSVal  Cond 
)
inline

Returns a pair of states (StTrue, StFalse) where the given condition is assumed to be true or false, respectively.

Definition at line 75 of file ConstraintManager.h.

References State.

Referenced by checkNull().

◆ assumeInclusiveRange()

virtual ProgramStateRef clang::ento::ConstraintManager::assumeInclusiveRange ( ProgramStateRef  State,
NonLoc  Value,
const llvm::APSInt &  From,
const llvm::APSInt &  To,
bool  InBound 
)
pure virtual

◆ assumeInclusiveRangeDual()

virtual ProgramStatePair clang::ento::ConstraintManager::assumeInclusiveRangeDual ( ProgramStateRef  State,
NonLoc  Value,
const llvm::APSInt &  From,
const llvm::APSInt &  To 
)
inlinevirtual

Definition at line 108 of file ConstraintManager.h.

◆ canReasonAbout()

virtual bool clang::ento::ConstraintManager::canReasonAbout ( SVal  X) const
protectedpure virtual

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.

Referenced by clang::ento::SimpleConstraintManager::assume(), and clang::ento::SimpleConstraintManager::assumeInclusiveRange().

◆ checkNull()

ConditionTruthVal ConstraintManager::checkNull ( ProgramStateRef  State,
SymbolRef  Sym 
)
protectedvirtual

Returns whether or not a symbol is known to be null ("true"), known to be non-null ("false"), or may be either ("underconstrained").

Definition at line 28 of file ConstraintManager.cpp.

References assumeDual(), getLocFromSymbol(), clang::ento::SymExpr::getType(), clang::ento::Loc::isLocType(), and P.

◆ EndPath()

virtual void clang::ento::ConstraintManager::EndPath ( ProgramStateRef  state)
inlinevirtual

Definition at line 152 of file ConstraintManager.h.

◆ getSymVal()

virtual const llvm::APSInt* clang::ento::ConstraintManager::getSymVal ( ProgramStateRef  state,
SymbolRef  sym 
) const
inlinevirtual

If a symbol is perfectly constrained to a constant, attempt to return the concrete value.

Note that a ConstraintManager is not obligated to return a concretized value for a symbol, even if it is perfectly constrained.

Definition at line 137 of file ConstraintManager.h.

◆ isNull()

ConditionTruthVal clang::ento::ConstraintManager::isNull ( ProgramStateRef  State,
SymbolRef  Sym 
)
inline

Convenience method to query the state to see if a symbol is null or not null, or if neither assumption can be made.

Definition at line 156 of file ConstraintManager.h.

Referenced by didPreviousFreeFail(), and isLeaked().

◆ print()

virtual void clang::ento::ConstraintManager::print ( ProgramStateRef  state,
raw_ostream &  Out,
const char *  nl,
const char *  sep 
)
pure virtual

◆ removeDeadBindings()

virtual ProgramStateRef clang::ento::ConstraintManager::removeDeadBindings ( ProgramStateRef  state,
SymbolReaper SymReaper 
)
pure virtual

Scan all symbols referenced by the constraints.

If the symbol is not alive, remove it.

Member Data Documentation

◆ NotifyAssumeClients

bool clang::ento::ConstraintManager::NotifyAssumeClients
protected

A flag to indicate that clients should be notified of assumptions.

By default this is the case, but sometimes this needs to be restricted to avoid infinite recursions within the ConstraintManager.

Note that this flag allows the ConstraintManager to be re-entrant, but not thread-safe.

Definition at line 169 of file ConstraintManager.h.

Referenced by clang::ento::SimpleConstraintManager::assume().


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