132b9e234STed Kremenek //= ProgramState.cpp - Path-Sensitive "State" for tracking values --*- C++ -*--=
232b9e234STed Kremenek //
332b9e234STed Kremenek //                     The LLVM Compiler Infrastructure
432b9e234STed Kremenek //
532b9e234STed Kremenek // This file is distributed under the University of Illinois Open Source
632b9e234STed Kremenek // License. See LICENSE.TXT for details.
732b9e234STed Kremenek //
832b9e234STed Kremenek //===----------------------------------------------------------------------===//
932b9e234STed Kremenek //
1032b9e234STed Kremenek //  This file implements ProgramState and ProgramStateManager.
1132b9e234STed Kremenek //
1232b9e234STed Kremenek //===----------------------------------------------------------------------===//
1332b9e234STed Kremenek 
1432b9e234STed Kremenek #include "clang/Analysis/CFG.h"
1532b9e234STed Kremenek #include "clang/StaticAnalyzer/Core/PathSensitive/ProgramStateTrait.h"
1632b9e234STed Kremenek #include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState.h"
1732b9e234STed Kremenek #include "clang/StaticAnalyzer/Core/PathSensitive/SubEngine.h"
18ec7dc5c1SAnna Zaks #include "clang/StaticAnalyzer/Core/PathSensitive/TaintManager.h"
1932b9e234STed Kremenek #include "llvm/Support/raw_ostream.h"
2032b9e234STed Kremenek 
2132b9e234STed Kremenek using namespace clang;
2232b9e234STed Kremenek using namespace ento;
2332b9e234STed Kremenek 
2432b9e234STed Kremenek // Give the vtable for ConstraintManager somewhere to live.
2532b9e234STed Kremenek // FIXME: Move this elsewhere.
2632b9e234STed Kremenek ConstraintManager::~ConstraintManager() {}
2732b9e234STed Kremenek 
282753ca84SArgyrios Kyrtzidis namespace clang { namespace  ento {
292753ca84SArgyrios Kyrtzidis /// Increments the number of times this state is referenced.
302753ca84SArgyrios Kyrtzidis 
312753ca84SArgyrios Kyrtzidis void ProgramStateRetain(const ProgramState *state) {
322753ca84SArgyrios Kyrtzidis   ++const_cast<ProgramState*>(state)->refCount;
332753ca84SArgyrios Kyrtzidis }
342753ca84SArgyrios Kyrtzidis 
352753ca84SArgyrios Kyrtzidis /// Decrement the number of times this state is referenced.
362753ca84SArgyrios Kyrtzidis void ProgramStateRelease(const ProgramState *state) {
372753ca84SArgyrios Kyrtzidis   assert(state->refCount > 0);
382753ca84SArgyrios Kyrtzidis   ProgramState *s = const_cast<ProgramState*>(state);
392753ca84SArgyrios Kyrtzidis   if (--s->refCount == 0) {
402753ca84SArgyrios Kyrtzidis     ProgramStateManager &Mgr = s->getStateManager();
412753ca84SArgyrios Kyrtzidis     Mgr.StateSet.RemoveNode(s);
422753ca84SArgyrios Kyrtzidis     s->~ProgramState();
432753ca84SArgyrios Kyrtzidis     Mgr.freeStates.push_back(s);
442753ca84SArgyrios Kyrtzidis   }
452753ca84SArgyrios Kyrtzidis }
462753ca84SArgyrios Kyrtzidis }}
472753ca84SArgyrios Kyrtzidis 
4832b9e234STed Kremenek ProgramState::ProgramState(ProgramStateManager *mgr, const Environment& env,
4932b9e234STed Kremenek                  StoreRef st, GenericDataMap gdm)
5032b9e234STed Kremenek   : stateMgr(mgr),
5132b9e234STed Kremenek     Env(env),
5232b9e234STed Kremenek     store(st.getStore()),
5332b9e234STed Kremenek     GDM(gdm),
5432b9e234STed Kremenek     refCount(0) {
5532b9e234STed Kremenek   stateMgr->getStoreManager().incrementReferenceCount(store);
5632b9e234STed Kremenek }
5732b9e234STed Kremenek 
5832b9e234STed Kremenek ProgramState::ProgramState(const ProgramState &RHS)
5932b9e234STed Kremenek     : llvm::FoldingSetNode(),
6032b9e234STed Kremenek       stateMgr(RHS.stateMgr),
6132b9e234STed Kremenek       Env(RHS.Env),
6232b9e234STed Kremenek       store(RHS.store),
6332b9e234STed Kremenek       GDM(RHS.GDM),
6432b9e234STed Kremenek       refCount(0) {
6532b9e234STed Kremenek   stateMgr->getStoreManager().incrementReferenceCount(store);
6632b9e234STed Kremenek }
6732b9e234STed Kremenek 
6832b9e234STed Kremenek ProgramState::~ProgramState() {
6932b9e234STed Kremenek   if (store)
7032b9e234STed Kremenek     stateMgr->getStoreManager().decrementReferenceCount(store);
7132b9e234STed Kremenek }
7232b9e234STed Kremenek 
7332b9e234STed Kremenek ProgramStateManager::~ProgramStateManager() {
7432b9e234STed Kremenek   for (GDMContextsTy::iterator I=GDMContexts.begin(), E=GDMContexts.end();
7532b9e234STed Kremenek        I!=E; ++I)
7632b9e234STed Kremenek     I->second.second(I->second.first);
7732b9e234STed Kremenek }
7832b9e234STed Kremenek 
7949b1e38eSTed Kremenek ProgramStateRef
8049b1e38eSTed Kremenek ProgramStateManager::removeDeadBindings(ProgramStateRef state,
8132b9e234STed Kremenek                                    const StackFrameContext *LCtx,
8232b9e234STed Kremenek                                    SymbolReaper& SymReaper) {
8332b9e234STed Kremenek 
8432b9e234STed Kremenek   // This code essentially performs a "mark-and-sweep" of the VariableBindings.
8532b9e234STed Kremenek   // The roots are any Block-level exprs and Decls that our liveness algorithm
8632b9e234STed Kremenek   // tells us are live.  We then see what Decls they may reference, and keep
8732b9e234STed Kremenek   // those around.  This code more than likely can be made faster, and the
8832b9e234STed Kremenek   // frequency of which this method is called should be experimented with
8932b9e234STed Kremenek   // for optimum performance.
9032b9e234STed Kremenek   ProgramState NewState = *state;
9132b9e234STed Kremenek 
9232b9e234STed Kremenek   NewState.Env = EnvMgr.removeDeadBindings(NewState.Env, SymReaper, state);
9332b9e234STed Kremenek 
9432b9e234STed Kremenek   // Clean up the store.
9532b9e234STed Kremenek   StoreRef newStore = StoreMgr->removeDeadBindings(NewState.getStore(), LCtx,
9632b9e234STed Kremenek                                                    SymReaper);
9732b9e234STed Kremenek   NewState.setStore(newStore);
9832b9e234STed Kremenek   SymReaper.setReapedStore(newStore);
9932b9e234STed Kremenek 
10032b9e234STed Kremenek   return getPersistentState(NewState);
10132b9e234STed Kremenek }
10232b9e234STed Kremenek 
10349b1e38eSTed Kremenek ProgramStateRef ProgramStateManager::MarshalState(ProgramStateRef state,
10432b9e234STed Kremenek                                             const StackFrameContext *InitLoc) {
10532b9e234STed Kremenek   // make up an empty state for now.
10632b9e234STed Kremenek   ProgramState State(this,
10732b9e234STed Kremenek                 EnvMgr.getInitialEnvironment(),
10832b9e234STed Kremenek                 StoreMgr->getInitialStore(InitLoc),
10932b9e234STed Kremenek                 GDMFactory.getEmptyMap());
11032b9e234STed Kremenek 
11132b9e234STed Kremenek   return getPersistentState(State);
11232b9e234STed Kremenek }
11332b9e234STed Kremenek 
11449b1e38eSTed Kremenek ProgramStateRef ProgramState::bindCompoundLiteral(const CompoundLiteralExpr *CL,
11532b9e234STed Kremenek                                             const LocationContext *LC,
11632b9e234STed Kremenek                                             SVal V) const {
11732b9e234STed Kremenek   const StoreRef &newStore =
11832b9e234STed Kremenek     getStateManager().StoreMgr->BindCompoundLiteral(getStore(), CL, LC, V);
11932b9e234STed Kremenek   return makeWithStore(newStore);
12032b9e234STed Kremenek }
12132b9e234STed Kremenek 
12249b1e38eSTed Kremenek ProgramStateRef ProgramState::bindDecl(const VarRegion* VR, SVal IVal) const {
12332b9e234STed Kremenek   const StoreRef &newStore =
12432b9e234STed Kremenek     getStateManager().StoreMgr->BindDecl(getStore(), VR, IVal);
12532b9e234STed Kremenek   return makeWithStore(newStore);
12632b9e234STed Kremenek }
12732b9e234STed Kremenek 
12849b1e38eSTed Kremenek ProgramStateRef ProgramState::bindDeclWithNoInit(const VarRegion* VR) const {
12932b9e234STed Kremenek   const StoreRef &newStore =
13032b9e234STed Kremenek     getStateManager().StoreMgr->BindDeclWithNoInit(getStore(), VR);
13132b9e234STed Kremenek   return makeWithStore(newStore);
13232b9e234STed Kremenek }
13332b9e234STed Kremenek 
13449b1e38eSTed Kremenek ProgramStateRef ProgramState::bindLoc(Loc LV, SVal V) const {
13532b9e234STed Kremenek   ProgramStateManager &Mgr = getStateManager();
13649b1e38eSTed Kremenek   ProgramStateRef newState = makeWithStore(Mgr.StoreMgr->Bind(getStore(),
13732b9e234STed Kremenek                                                              LV, V));
13832b9e234STed Kremenek   const MemRegion *MR = LV.getAsRegion();
13932b9e234STed Kremenek   if (MR && Mgr.getOwningEngine())
14032b9e234STed Kremenek     return Mgr.getOwningEngine()->processRegionChange(newState, MR);
14132b9e234STed Kremenek 
14232b9e234STed Kremenek   return newState;
14332b9e234STed Kremenek }
14432b9e234STed Kremenek 
14549b1e38eSTed Kremenek ProgramStateRef ProgramState::bindDefault(SVal loc, SVal V) const {
14632b9e234STed Kremenek   ProgramStateManager &Mgr = getStateManager();
14732b9e234STed Kremenek   const MemRegion *R = cast<loc::MemRegionVal>(loc).getRegion();
14832b9e234STed Kremenek   const StoreRef &newStore = Mgr.StoreMgr->BindDefault(getStore(), R, V);
14949b1e38eSTed Kremenek   ProgramStateRef new_state = makeWithStore(newStore);
15032b9e234STed Kremenek   return Mgr.getOwningEngine() ?
15132b9e234STed Kremenek            Mgr.getOwningEngine()->processRegionChange(new_state, R) :
15232b9e234STed Kremenek            new_state;
15332b9e234STed Kremenek }
15432b9e234STed Kremenek 
15549b1e38eSTed Kremenek ProgramStateRef
1561fad6631SJordy Rose ProgramState::invalidateRegions(ArrayRef<const MemRegion *> Regions,
15732b9e234STed Kremenek                                 const Expr *E, unsigned Count,
158d519cae8STed Kremenek                                 const LocationContext *LCtx,
15932b9e234STed Kremenek                                 StoreManager::InvalidatedSymbols *IS,
160*742920c8SJordan Rose                                 const CallEvent *Call) const {
16132b9e234STed Kremenek   if (!IS) {
16232b9e234STed Kremenek     StoreManager::InvalidatedSymbols invalidated;
163d519cae8STed Kremenek     return invalidateRegionsImpl(Regions, E, Count, LCtx,
1648158ef0dSAnna Zaks                                  invalidated, Call);
16532b9e234STed Kremenek   }
166d519cae8STed Kremenek   return invalidateRegionsImpl(Regions, E, Count, LCtx, *IS, Call);
16732b9e234STed Kremenek }
16832b9e234STed Kremenek 
16949b1e38eSTed Kremenek ProgramStateRef
1701fad6631SJordy Rose ProgramState::invalidateRegionsImpl(ArrayRef<const MemRegion *> Regions,
17132b9e234STed Kremenek                                     const Expr *E, unsigned Count,
172d519cae8STed Kremenek                                     const LocationContext *LCtx,
17332b9e234STed Kremenek                                     StoreManager::InvalidatedSymbols &IS,
174*742920c8SJordan Rose                                     const CallEvent *Call) const {
17532b9e234STed Kremenek   ProgramStateManager &Mgr = getStateManager();
17632b9e234STed Kremenek   SubEngine* Eng = Mgr.getOwningEngine();
17732b9e234STed Kremenek 
17832b9e234STed Kremenek   if (Eng && Eng->wantsRegionChangeUpdate(this)) {
1791fad6631SJordy Rose     StoreManager::InvalidatedRegions Invalidated;
18032b9e234STed Kremenek     const StoreRef &newStore
181d519cae8STed Kremenek       = Mgr.StoreMgr->invalidateRegions(getStore(), Regions, E, Count, LCtx, IS,
1828158ef0dSAnna Zaks                                         Call, &Invalidated);
18349b1e38eSTed Kremenek     ProgramStateRef newState = makeWithStore(newStore);
1843d34834bSAnna Zaks     return Eng->processRegionChanges(newState, &IS, Regions, Invalidated, Call);
18532b9e234STed Kremenek   }
18632b9e234STed Kremenek 
18732b9e234STed Kremenek   const StoreRef &newStore =
188d519cae8STed Kremenek     Mgr.StoreMgr->invalidateRegions(getStore(), Regions, E, Count, LCtx, IS,
1898158ef0dSAnna Zaks                                     Call, NULL);
19032b9e234STed Kremenek   return makeWithStore(newStore);
19132b9e234STed Kremenek }
19232b9e234STed Kremenek 
19349b1e38eSTed Kremenek ProgramStateRef ProgramState::unbindLoc(Loc LV) const {
19432b9e234STed Kremenek   assert(!isa<loc::MemRegionVal>(LV) && "Use invalidateRegion instead.");
19532b9e234STed Kremenek 
19632b9e234STed Kremenek   Store OldStore = getStore();
19732b9e234STed Kremenek   const StoreRef &newStore = getStateManager().StoreMgr->Remove(OldStore, LV);
19832b9e234STed Kremenek 
19932b9e234STed Kremenek   if (newStore.getStore() == OldStore)
20032b9e234STed Kremenek     return this;
20132b9e234STed Kremenek 
20232b9e234STed Kremenek   return makeWithStore(newStore);
20332b9e234STed Kremenek }
20432b9e234STed Kremenek 
20549b1e38eSTed Kremenek ProgramStateRef
2063d3aea93STed Kremenek ProgramState::enterStackFrame(const LocationContext *callerCtx,
2073d3aea93STed Kremenek                               const StackFrameContext *calleeCtx) const {
20832b9e234STed Kremenek   const StoreRef &new_store =
2093d3aea93STed Kremenek     getStateManager().StoreMgr->enterStackFrame(this, callerCtx, calleeCtx);
21032b9e234STed Kremenek   return makeWithStore(new_store);
21132b9e234STed Kremenek }
21232b9e234STed Kremenek 
21332b9e234STed Kremenek SVal ProgramState::getSValAsScalarOrLoc(const MemRegion *R) const {
21432b9e234STed Kremenek   // We only want to do fetches from regions that we can actually bind
21532b9e234STed Kremenek   // values.  For example, SymbolicRegions of type 'id<...>' cannot
21632b9e234STed Kremenek   // have direct bindings (but their can be bindings on their subregions).
21732b9e234STed Kremenek   if (!R->isBoundable())
21832b9e234STed Kremenek     return UnknownVal();
21932b9e234STed Kremenek 
22032b9e234STed Kremenek   if (const TypedValueRegion *TR = dyn_cast<TypedValueRegion>(R)) {
22132b9e234STed Kremenek     QualType T = TR->getValueType();
22232b9e234STed Kremenek     if (Loc::isLocType(T) || T->isIntegerType())
22332b9e234STed Kremenek       return getSVal(R);
22432b9e234STed Kremenek   }
22532b9e234STed Kremenek 
22632b9e234STed Kremenek   return UnknownVal();
22732b9e234STed Kremenek }
22832b9e234STed Kremenek 
22932b9e234STed Kremenek SVal ProgramState::getSVal(Loc location, QualType T) const {
23032b9e234STed Kremenek   SVal V = getRawSVal(cast<Loc>(location), T);
23132b9e234STed Kremenek 
23232b9e234STed Kremenek   // If 'V' is a symbolic value that is *perfectly* constrained to
23332b9e234STed Kremenek   // be a constant value, use that value instead to lessen the burden
23432b9e234STed Kremenek   // on later analysis stages (so we have less symbolic values to reason
23532b9e234STed Kremenek   // about).
23632b9e234STed Kremenek   if (!T.isNull()) {
23732b9e234STed Kremenek     if (SymbolRef sym = V.getAsSymbol()) {
23832b9e234STed Kremenek       if (const llvm::APSInt *Int = getSymVal(sym)) {
23932b9e234STed Kremenek         // FIXME: Because we don't correctly model (yet) sign-extension
24032b9e234STed Kremenek         // and truncation of symbolic values, we need to convert
24132b9e234STed Kremenek         // the integer value to the correct signedness and bitwidth.
24232b9e234STed Kremenek         //
24332b9e234STed Kremenek         // This shows up in the following:
24432b9e234STed Kremenek         //
24532b9e234STed Kremenek         //   char foo();
24632b9e234STed Kremenek         //   unsigned x = foo();
24732b9e234STed Kremenek         //   if (x == 54)
24832b9e234STed Kremenek         //     ...
24932b9e234STed Kremenek         //
25032b9e234STed Kremenek         //  The symbolic value stored to 'x' is actually the conjured
25132b9e234STed Kremenek         //  symbol for the call to foo(); the type of that symbol is 'char',
25232b9e234STed Kremenek         //  not unsigned.
25332b9e234STed Kremenek         const llvm::APSInt &NewV = getBasicVals().Convert(T, *Int);
25432b9e234STed Kremenek 
25532b9e234STed Kremenek         if (isa<Loc>(V))
25632b9e234STed Kremenek           return loc::ConcreteInt(NewV);
25732b9e234STed Kremenek         else
25832b9e234STed Kremenek           return nonloc::ConcreteInt(NewV);
25932b9e234STed Kremenek       }
26032b9e234STed Kremenek     }
26132b9e234STed Kremenek   }
26232b9e234STed Kremenek 
26332b9e234STed Kremenek   return V;
26432b9e234STed Kremenek }
26532b9e234STed Kremenek 
26649b1e38eSTed Kremenek ProgramStateRef ProgramState::BindExpr(const Stmt *S,
267632e3b7eSTed Kremenek                                            const LocationContext *LCtx,
268632e3b7eSTed Kremenek                                            SVal V, bool Invalidate) const{
269632e3b7eSTed Kremenek   Environment NewEnv =
270632e3b7eSTed Kremenek     getStateManager().EnvMgr.bindExpr(Env, EnvironmentEntry(S, LCtx), V,
27132b9e234STed Kremenek                                       Invalidate);
27232b9e234STed Kremenek   if (NewEnv == Env)
27332b9e234STed Kremenek     return this;
27432b9e234STed Kremenek 
27532b9e234STed Kremenek   ProgramState NewSt = *this;
27632b9e234STed Kremenek   NewSt.Env = NewEnv;
27732b9e234STed Kremenek   return getStateManager().getPersistentState(NewSt);
27832b9e234STed Kremenek }
27932b9e234STed Kremenek 
28049b1e38eSTed Kremenek ProgramStateRef
281632e3b7eSTed Kremenek ProgramState::bindExprAndLocation(const Stmt *S, const LocationContext *LCtx,
282632e3b7eSTed Kremenek                                   SVal location,
28332b9e234STed Kremenek                                   SVal V) const {
28432b9e234STed Kremenek   Environment NewEnv =
285632e3b7eSTed Kremenek     getStateManager().EnvMgr.bindExprAndLocation(Env,
286632e3b7eSTed Kremenek                                                  EnvironmentEntry(S, LCtx),
287632e3b7eSTed Kremenek                                                  location, V);
28832b9e234STed Kremenek 
28932b9e234STed Kremenek   if (NewEnv == Env)
29032b9e234STed Kremenek     return this;
29132b9e234STed Kremenek 
29232b9e234STed Kremenek   ProgramState NewSt = *this;
29332b9e234STed Kremenek   NewSt.Env = NewEnv;
29432b9e234STed Kremenek   return getStateManager().getPersistentState(NewSt);
29532b9e234STed Kremenek }
29632b9e234STed Kremenek 
29749b1e38eSTed Kremenek ProgramStateRef ProgramState::assumeInBound(DefinedOrUnknownSVal Idx,
29832b9e234STed Kremenek                                       DefinedOrUnknownSVal UpperBound,
2994f870e65SAnna Zaks                                       bool Assumption,
3004f870e65SAnna Zaks                                       QualType indexTy) const {
30132b9e234STed Kremenek   if (Idx.isUnknown() || UpperBound.isUnknown())
30232b9e234STed Kremenek     return this;
30332b9e234STed Kremenek 
30432b9e234STed Kremenek   // Build an expression for 0 <= Idx < UpperBound.
30532b9e234STed Kremenek   // This is the same as Idx + MIN < UpperBound + MIN, if overflow is allowed.
30632b9e234STed Kremenek   // FIXME: This should probably be part of SValBuilder.
30732b9e234STed Kremenek   ProgramStateManager &SM = getStateManager();
30832b9e234STed Kremenek   SValBuilder &svalBuilder = SM.getSValBuilder();
30932b9e234STed Kremenek   ASTContext &Ctx = svalBuilder.getContext();
31032b9e234STed Kremenek 
31132b9e234STed Kremenek   // Get the offset: the minimum value of the array index type.
31232b9e234STed Kremenek   BasicValueFactory &BVF = svalBuilder.getBasicValueFactory();
31332b9e234STed Kremenek   // FIXME: This should be using ValueManager::ArrayindexTy...somehow.
3144f870e65SAnna Zaks   if (indexTy.isNull())
3154f870e65SAnna Zaks     indexTy = Ctx.IntTy;
31632b9e234STed Kremenek   nonloc::ConcreteInt Min(BVF.getMinValue(indexTy));
31732b9e234STed Kremenek 
31832b9e234STed Kremenek   // Adjust the index.
31932b9e234STed Kremenek   SVal newIdx = svalBuilder.evalBinOpNN(this, BO_Add,
32032b9e234STed Kremenek                                         cast<NonLoc>(Idx), Min, indexTy);
32132b9e234STed Kremenek   if (newIdx.isUnknownOrUndef())
32232b9e234STed Kremenek     return this;
32332b9e234STed Kremenek 
32432b9e234STed Kremenek   // Adjust the upper bound.
32532b9e234STed Kremenek   SVal newBound =
32632b9e234STed Kremenek     svalBuilder.evalBinOpNN(this, BO_Add, cast<NonLoc>(UpperBound),
32732b9e234STed Kremenek                             Min, indexTy);
32832b9e234STed Kremenek 
32932b9e234STed Kremenek   if (newBound.isUnknownOrUndef())
33032b9e234STed Kremenek     return this;
33132b9e234STed Kremenek 
33232b9e234STed Kremenek   // Build the actual comparison.
33332b9e234STed Kremenek   SVal inBound = svalBuilder.evalBinOpNN(this, BO_LT,
33432b9e234STed Kremenek                                 cast<NonLoc>(newIdx), cast<NonLoc>(newBound),
33532b9e234STed Kremenek                                 Ctx.IntTy);
33632b9e234STed Kremenek   if (inBound.isUnknownOrUndef())
33732b9e234STed Kremenek     return this;
33832b9e234STed Kremenek 
33932b9e234STed Kremenek   // Finally, let the constraint manager take care of it.
34032b9e234STed Kremenek   ConstraintManager &CM = SM.getConstraintManager();
34132b9e234STed Kremenek   return CM.assume(this, cast<DefinedSVal>(inBound), Assumption);
34232b9e234STed Kremenek }
34332b9e234STed Kremenek 
34449b1e38eSTed Kremenek ProgramStateRef ProgramStateManager::getInitialState(const LocationContext *InitLoc) {
34532b9e234STed Kremenek   ProgramState State(this,
34632b9e234STed Kremenek                 EnvMgr.getInitialEnvironment(),
34732b9e234STed Kremenek                 StoreMgr->getInitialStore(InitLoc),
34832b9e234STed Kremenek                 GDMFactory.getEmptyMap());
34932b9e234STed Kremenek 
35032b9e234STed Kremenek   return getPersistentState(State);
35132b9e234STed Kremenek }
35232b9e234STed Kremenek 
35349b1e38eSTed Kremenek ProgramStateRef ProgramStateManager::getPersistentStateWithGDM(
35449b1e38eSTed Kremenek                                                      ProgramStateRef FromState,
35549b1e38eSTed Kremenek                                                      ProgramStateRef GDMState) {
3562753ca84SArgyrios Kyrtzidis   ProgramState NewState(*FromState);
35732b9e234STed Kremenek   NewState.GDM = GDMState->GDM;
35832b9e234STed Kremenek   return getPersistentState(NewState);
35932b9e234STed Kremenek }
36032b9e234STed Kremenek 
36149b1e38eSTed Kremenek ProgramStateRef ProgramStateManager::getPersistentState(ProgramState &State) {
36232b9e234STed Kremenek 
36332b9e234STed Kremenek   llvm::FoldingSetNodeID ID;
36432b9e234STed Kremenek   State.Profile(ID);
36532b9e234STed Kremenek   void *InsertPos;
36632b9e234STed Kremenek 
36732b9e234STed Kremenek   if (ProgramState *I = StateSet.FindNodeOrInsertPos(ID, InsertPos))
36832b9e234STed Kremenek     return I;
36932b9e234STed Kremenek 
37032b9e234STed Kremenek   ProgramState *newState = 0;
37132b9e234STed Kremenek   if (!freeStates.empty()) {
37232b9e234STed Kremenek     newState = freeStates.back();
37332b9e234STed Kremenek     freeStates.pop_back();
37432b9e234STed Kremenek   }
37532b9e234STed Kremenek   else {
37632b9e234STed Kremenek     newState = (ProgramState*) Alloc.Allocate<ProgramState>();
37732b9e234STed Kremenek   }
37832b9e234STed Kremenek   new (newState) ProgramState(State);
37932b9e234STed Kremenek   StateSet.InsertNode(newState, InsertPos);
38032b9e234STed Kremenek   return newState;
38132b9e234STed Kremenek }
38232b9e234STed Kremenek 
38349b1e38eSTed Kremenek ProgramStateRef ProgramState::makeWithStore(const StoreRef &store) const {
3842753ca84SArgyrios Kyrtzidis   ProgramState NewSt(*this);
38532b9e234STed Kremenek   NewSt.setStore(store);
38632b9e234STed Kremenek   return getStateManager().getPersistentState(NewSt);
38732b9e234STed Kremenek }
38832b9e234STed Kremenek 
38932b9e234STed Kremenek void ProgramState::setStore(const StoreRef &newStore) {
39032b9e234STed Kremenek   Store newStoreStore = newStore.getStore();
39132b9e234STed Kremenek   if (newStoreStore)
39232b9e234STed Kremenek     stateMgr->getStoreManager().incrementReferenceCount(newStoreStore);
39332b9e234STed Kremenek   if (store)
39432b9e234STed Kremenek     stateMgr->getStoreManager().decrementReferenceCount(store);
39532b9e234STed Kremenek   store = newStoreStore;
39632b9e234STed Kremenek }
39732b9e234STed Kremenek 
39832b9e234STed Kremenek //===----------------------------------------------------------------------===//
39932b9e234STed Kremenek //  State pretty-printing.
40032b9e234STed Kremenek //===----------------------------------------------------------------------===//
40132b9e234STed Kremenek 
402632e3b7eSTed Kremenek void ProgramState::print(raw_ostream &Out,
40358a20d31SJordy Rose                          const char *NL, const char *Sep) const {
40432b9e234STed Kremenek   // Print the store.
40532b9e234STed Kremenek   ProgramStateManager &Mgr = getStateManager();
40658a20d31SJordy Rose   Mgr.getStoreManager().print(getStore(), Out, NL, Sep);
40732b9e234STed Kremenek 
408632e3b7eSTed Kremenek   // Print out the environment.
409632e3b7eSTed Kremenek   Env.print(Out, NL, Sep);
41032b9e234STed Kremenek 
411632e3b7eSTed Kremenek   // Print out the constraints.
41258a20d31SJordy Rose   Mgr.getConstraintManager().print(this, Out, NL, Sep);
41332b9e234STed Kremenek 
41432b9e234STed Kremenek   // Print checker-specific data.
41558a20d31SJordy Rose   Mgr.getOwningEngine()->printState(Out, this, NL, Sep);
41632b9e234STed Kremenek }
41732b9e234STed Kremenek 
418632e3b7eSTed Kremenek void ProgramState::printDOT(raw_ostream &Out) const {
419632e3b7eSTed Kremenek   print(Out, "\\l", "\\|");
420f784d08dSAnna Zaks }
421f784d08dSAnna Zaks 
422f784d08dSAnna Zaks void ProgramState::dump() const {
423632e3b7eSTed Kremenek   print(llvm::errs());
42432b9e234STed Kremenek }
42532b9e234STed Kremenek 
426282dc143SAnna Zaks void ProgramState::printTaint(raw_ostream &Out,
427282dc143SAnna Zaks                               const char *NL, const char *Sep) const {
428282dc143SAnna Zaks   TaintMapImpl TM = get<TaintMap>();
429282dc143SAnna Zaks 
430282dc143SAnna Zaks   if (!TM.isEmpty())
431282dc143SAnna Zaks     Out <<"Tainted Symbols:" << NL;
432282dc143SAnna Zaks 
433282dc143SAnna Zaks   for (TaintMapImpl::iterator I = TM.begin(), E = TM.end(); I != E; ++I) {
434282dc143SAnna Zaks     Out << I->first << " : " << I->second << NL;
435282dc143SAnna Zaks   }
436282dc143SAnna Zaks }
437282dc143SAnna Zaks 
438282dc143SAnna Zaks void ProgramState::dumpTaint() const {
439282dc143SAnna Zaks   printTaint(llvm::errs());
440282dc143SAnna Zaks }
441282dc143SAnna Zaks 
44232b9e234STed Kremenek //===----------------------------------------------------------------------===//
44332b9e234STed Kremenek // Generic Data Map.
44432b9e234STed Kremenek //===----------------------------------------------------------------------===//
44532b9e234STed Kremenek 
44632b9e234STed Kremenek void *const* ProgramState::FindGDM(void *K) const {
44732b9e234STed Kremenek   return GDM.lookup(K);
44832b9e234STed Kremenek }
44932b9e234STed Kremenek 
45032b9e234STed Kremenek void*
45132b9e234STed Kremenek ProgramStateManager::FindGDMContext(void *K,
45232b9e234STed Kremenek                                void *(*CreateContext)(llvm::BumpPtrAllocator&),
45332b9e234STed Kremenek                                void (*DeleteContext)(void*)) {
45432b9e234STed Kremenek 
45532b9e234STed Kremenek   std::pair<void*, void (*)(void*)>& p = GDMContexts[K];
45632b9e234STed Kremenek   if (!p.first) {
45732b9e234STed Kremenek     p.first = CreateContext(Alloc);
45832b9e234STed Kremenek     p.second = DeleteContext;
45932b9e234STed Kremenek   }
46032b9e234STed Kremenek 
46132b9e234STed Kremenek   return p.first;
46232b9e234STed Kremenek }
46332b9e234STed Kremenek 
46449b1e38eSTed Kremenek ProgramStateRef ProgramStateManager::addGDM(ProgramStateRef St, void *Key, void *Data){
46532b9e234STed Kremenek   ProgramState::GenericDataMap M1 = St->getGDM();
46632b9e234STed Kremenek   ProgramState::GenericDataMap M2 = GDMFactory.add(M1, Key, Data);
46732b9e234STed Kremenek 
46832b9e234STed Kremenek   if (M1 == M2)
46932b9e234STed Kremenek     return St;
47032b9e234STed Kremenek 
47132b9e234STed Kremenek   ProgramState NewSt = *St;
47232b9e234STed Kremenek   NewSt.GDM = M2;
47332b9e234STed Kremenek   return getPersistentState(NewSt);
47432b9e234STed Kremenek }
47532b9e234STed Kremenek 
47649b1e38eSTed Kremenek ProgramStateRef ProgramStateManager::removeGDM(ProgramStateRef state, void *Key) {
47732b9e234STed Kremenek   ProgramState::GenericDataMap OldM = state->getGDM();
47832b9e234STed Kremenek   ProgramState::GenericDataMap NewM = GDMFactory.remove(OldM, Key);
47932b9e234STed Kremenek 
48032b9e234STed Kremenek   if (NewM == OldM)
48132b9e234STed Kremenek     return state;
48232b9e234STed Kremenek 
48332b9e234STed Kremenek   ProgramState NewState = *state;
48432b9e234STed Kremenek   NewState.GDM = NewM;
48532b9e234STed Kremenek   return getPersistentState(NewState);
48632b9e234STed Kremenek }
48732b9e234STed Kremenek 
48868e081d6SDavid Blaikie void ScanReachableSymbols::anchor() { }
48968e081d6SDavid Blaikie 
49032b9e234STed Kremenek bool ScanReachableSymbols::scan(nonloc::CompoundVal val) {
49132b9e234STed Kremenek   for (nonloc::CompoundVal::iterator I=val.begin(), E=val.end(); I!=E; ++I)
49232b9e234STed Kremenek     if (!scan(*I))
49332b9e234STed Kremenek       return false;
49432b9e234STed Kremenek 
49532b9e234STed Kremenek   return true;
49632b9e234STed Kremenek }
49732b9e234STed Kremenek 
49832b9e234STed Kremenek bool ScanReachableSymbols::scan(const SymExpr *sym) {
49932b9e234STed Kremenek   unsigned &isVisited = visited[sym];
50032b9e234STed Kremenek   if (isVisited)
50132b9e234STed Kremenek     return true;
50232b9e234STed Kremenek   isVisited = 1;
50332b9e234STed Kremenek 
504a636fbe7SAnna Zaks   if (!visitor.VisitSymbol(sym))
50532b9e234STed Kremenek     return false;
50632b9e234STed Kremenek 
50752fb9c08SAnna Zaks   // TODO: should be rewritten using SymExpr::symbol_iterator.
50832b9e234STed Kremenek   switch (sym->getKind()) {
50932b9e234STed Kremenek     case SymExpr::RegionValueKind:
51032b9e234STed Kremenek     case SymExpr::ConjuredKind:
51132b9e234STed Kremenek     case SymExpr::DerivedKind:
51232b9e234STed Kremenek     case SymExpr::ExtentKind:
51332b9e234STed Kremenek     case SymExpr::MetadataKind:
51432b9e234STed Kremenek       break;
515c25efcccSAnna Zaks     case SymExpr::CastSymbolKind:
516c25efcccSAnna Zaks       return scan(cast<SymbolCast>(sym)->getOperand());
51732b9e234STed Kremenek     case SymExpr::SymIntKind:
51832b9e234STed Kremenek       return scan(cast<SymIntExpr>(sym)->getLHS());
519ecd73008SAnna Zaks     case SymExpr::IntSymKind:
520ecd73008SAnna Zaks       return scan(cast<IntSymExpr>(sym)->getRHS());
52132b9e234STed Kremenek     case SymExpr::SymSymKind: {
52232b9e234STed Kremenek       const SymSymExpr *x = cast<SymSymExpr>(sym);
52332b9e234STed Kremenek       return scan(x->getLHS()) && scan(x->getRHS());
52432b9e234STed Kremenek     }
52532b9e234STed Kremenek   }
52632b9e234STed Kremenek   return true;
52732b9e234STed Kremenek }
52832b9e234STed Kremenek 
52932b9e234STed Kremenek bool ScanReachableSymbols::scan(SVal val) {
53032b9e234STed Kremenek   if (loc::MemRegionVal *X = dyn_cast<loc::MemRegionVal>(&val))
53132b9e234STed Kremenek     return scan(X->getRegion());
53232b9e234STed Kremenek 
53332b9e234STed Kremenek   if (nonloc::LocAsInteger *X = dyn_cast<nonloc::LocAsInteger>(&val))
53432b9e234STed Kremenek     return scan(X->getLoc());
53532b9e234STed Kremenek 
53632b9e234STed Kremenek   if (SymbolRef Sym = val.getAsSymbol())
53732b9e234STed Kremenek     return scan(Sym);
53832b9e234STed Kremenek 
53932b9e234STed Kremenek   if (const SymExpr *Sym = val.getAsSymbolicExpression())
54032b9e234STed Kremenek     return scan(Sym);
54132b9e234STed Kremenek 
54232b9e234STed Kremenek   if (nonloc::CompoundVal *X = dyn_cast<nonloc::CompoundVal>(&val))
54332b9e234STed Kremenek     return scan(*X);
54432b9e234STed Kremenek 
54532b9e234STed Kremenek   return true;
54632b9e234STed Kremenek }
54732b9e234STed Kremenek 
54832b9e234STed Kremenek bool ScanReachableSymbols::scan(const MemRegion *R) {
54932b9e234STed Kremenek   if (isa<MemSpaceRegion>(R))
55032b9e234STed Kremenek     return true;
55132b9e234STed Kremenek 
55232b9e234STed Kremenek   unsigned &isVisited = visited[R];
55332b9e234STed Kremenek   if (isVisited)
55432b9e234STed Kremenek     return true;
55532b9e234STed Kremenek   isVisited = 1;
556b14b42d4STed Kremenek 
557b14b42d4STed Kremenek 
558b14b42d4STed Kremenek   if (!visitor.VisitMemRegion(R))
559b14b42d4STed Kremenek     return false;
56032b9e234STed Kremenek 
56132b9e234STed Kremenek   // If this is a symbolic region, visit the symbol for the region.
56232b9e234STed Kremenek   if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(R))
56332b9e234STed Kremenek     if (!visitor.VisitSymbol(SR->getSymbol()))
56432b9e234STed Kremenek       return false;
56532b9e234STed Kremenek 
56632b9e234STed Kremenek   // If this is a subregion, also visit the parent regions.
56732b9e234STed Kremenek   if (const SubRegion *SR = dyn_cast<SubRegion>(R))
56832b9e234STed Kremenek     if (!scan(SR->getSuperRegion()))
56932b9e234STed Kremenek       return false;
57032b9e234STed Kremenek 
571c3da376fSTed Kremenek   // Regions captured by a block are also implicitly reachable.
572c3da376fSTed Kremenek   if (const BlockDataRegion *BDR = dyn_cast<BlockDataRegion>(R)) {
573c3da376fSTed Kremenek     BlockDataRegion::referenced_vars_iterator I = BDR->referenced_vars_begin(),
574c3da376fSTed Kremenek                                               E = BDR->referenced_vars_end();
575c3da376fSTed Kremenek     for ( ; I != E; ++I) {
576c3da376fSTed Kremenek       if (!scan(I.getCapturedRegion()))
577c3da376fSTed Kremenek         return false;
578c3da376fSTed Kremenek     }
579c3da376fSTed Kremenek   }
580c3da376fSTed Kremenek 
58132b9e234STed Kremenek   // Now look at the binding to this region (if any).
58232b9e234STed Kremenek   if (!scan(state->getSValAsScalarOrLoc(R)))
58332b9e234STed Kremenek     return false;
58432b9e234STed Kremenek 
58532b9e234STed Kremenek   // Now look at the subregions.
58632b9e234STed Kremenek   if (!SRM.get())
58732b9e234STed Kremenek     SRM.reset(state->getStateManager().getStoreManager().
58832b9e234STed Kremenek                                            getSubRegionMap(state->getStore()));
58932b9e234STed Kremenek 
59032b9e234STed Kremenek   return SRM->iterSubRegions(R, *this);
59132b9e234STed Kremenek }
59232b9e234STed Kremenek 
59332b9e234STed Kremenek bool ProgramState::scanReachableSymbols(SVal val, SymbolVisitor& visitor) const {
59432b9e234STed Kremenek   ScanReachableSymbols S(this, visitor);
59532b9e234STed Kremenek   return S.scan(val);
59632b9e234STed Kremenek }
59732b9e234STed Kremenek 
59832b9e234STed Kremenek bool ProgramState::scanReachableSymbols(const SVal *I, const SVal *E,
59932b9e234STed Kremenek                                    SymbolVisitor &visitor) const {
60032b9e234STed Kremenek   ScanReachableSymbols S(this, visitor);
60132b9e234STed Kremenek   for ( ; I != E; ++I) {
60232b9e234STed Kremenek     if (!S.scan(*I))
60332b9e234STed Kremenek       return false;
60432b9e234STed Kremenek   }
60532b9e234STed Kremenek   return true;
60632b9e234STed Kremenek }
60732b9e234STed Kremenek 
60832b9e234STed Kremenek bool ProgramState::scanReachableSymbols(const MemRegion * const *I,
60932b9e234STed Kremenek                                    const MemRegion * const *E,
61032b9e234STed Kremenek                                    SymbolVisitor &visitor) const {
61132b9e234STed Kremenek   ScanReachableSymbols S(this, visitor);
61232b9e234STed Kremenek   for ( ; I != E; ++I) {
61332b9e234STed Kremenek     if (!S.scan(*I))
61432b9e234STed Kremenek       return false;
61532b9e234STed Kremenek   }
61632b9e234STed Kremenek   return true;
61732b9e234STed Kremenek }
618ec7dc5c1SAnna Zaks 
61949b1e38eSTed Kremenek ProgramStateRef ProgramState::addTaint(const Stmt *S,
620632e3b7eSTed Kremenek                                            const LocationContext *LCtx,
621ec7dc5c1SAnna Zaks                                            TaintTagType Kind) const {
622e48ee503SAnna Zaks   if (const Expr *E = dyn_cast_or_null<Expr>(S))
623e48ee503SAnna Zaks     S = E->IgnoreParens();
624e48ee503SAnna Zaks 
625632e3b7eSTed Kremenek   SymbolRef Sym = getSVal(S, LCtx).getAsSymbol();
626d6bb3227SAnna Zaks   if (Sym)
627ec7dc5c1SAnna Zaks     return addTaint(Sym, Kind);
628d6bb3227SAnna Zaks 
629632e3b7eSTed Kremenek   const MemRegion *R = getSVal(S, LCtx).getAsRegion();
63004b57c25SAnna Zaks   addTaint(R, Kind);
631d6bb3227SAnna Zaks 
632d6bb3227SAnna Zaks   // Cannot add taint, so just return the state.
633d6bb3227SAnna Zaks   return this;
634ec7dc5c1SAnna Zaks }
635ec7dc5c1SAnna Zaks 
63649b1e38eSTed Kremenek ProgramStateRef ProgramState::addTaint(const MemRegion *R,
63704b57c25SAnna Zaks                                            TaintTagType Kind) const {
63804b57c25SAnna Zaks   if (const SymbolicRegion *SR = dyn_cast_or_null<SymbolicRegion>(R))
63904b57c25SAnna Zaks     return addTaint(SR->getSymbol(), Kind);
64004b57c25SAnna Zaks   return this;
64104b57c25SAnna Zaks }
64204b57c25SAnna Zaks 
64349b1e38eSTed Kremenek ProgramStateRef ProgramState::addTaint(SymbolRef Sym,
644ec7dc5c1SAnna Zaks                                            TaintTagType Kind) const {
645282dc143SAnna Zaks   // If this is a symbol cast, remove the cast before adding the taint. Taint
646282dc143SAnna Zaks   // is cast agnostic.
647282dc143SAnna Zaks   while (const SymbolCast *SC = dyn_cast<SymbolCast>(Sym))
648282dc143SAnna Zaks     Sym = SC->getOperand();
649282dc143SAnna Zaks 
65049b1e38eSTed Kremenek   ProgramStateRef NewState = set<TaintMap>(Sym, Kind);
651ec7dc5c1SAnna Zaks   assert(NewState);
652ec7dc5c1SAnna Zaks   return NewState;
653ec7dc5c1SAnna Zaks }
654ec7dc5c1SAnna Zaks 
655632e3b7eSTed Kremenek bool ProgramState::isTainted(const Stmt *S, const LocationContext *LCtx,
656632e3b7eSTed Kremenek                              TaintTagType Kind) const {
657e48ee503SAnna Zaks   if (const Expr *E = dyn_cast_or_null<Expr>(S))
658e48ee503SAnna Zaks     S = E->IgnoreParens();
659e48ee503SAnna Zaks 
660632e3b7eSTed Kremenek   SVal val = getSVal(S, LCtx);
6619da86ce8SAnna Zaks   return isTainted(val, Kind);
662ec7dc5c1SAnna Zaks }
663ec7dc5c1SAnna Zaks 
664ec7dc5c1SAnna Zaks bool ProgramState::isTainted(SVal V, TaintTagType Kind) const {
665b86fdbe7SAnna Zaks   if (const SymExpr *Sym = V.getAsSymExpr())
666b86fdbe7SAnna Zaks     return isTainted(Sym, Kind);
6679de45554SAnna Zaks   if (const MemRegion *Reg = V.getAsRegion())
6689de45554SAnna Zaks     return isTainted(Reg, Kind);
669b86fdbe7SAnna Zaks   return false;
670b86fdbe7SAnna Zaks }
671b86fdbe7SAnna Zaks 
672b86fdbe7SAnna Zaks bool ProgramState::isTainted(const MemRegion *Reg, TaintTagType K) const {
673b86fdbe7SAnna Zaks   if (!Reg)
674b86fdbe7SAnna Zaks     return false;
675b86fdbe7SAnna Zaks 
676b86fdbe7SAnna Zaks   // Element region (array element) is tainted if either the base or the offset
677b86fdbe7SAnna Zaks   // are tainted.
678b86fdbe7SAnna Zaks   if (const ElementRegion *ER = dyn_cast<ElementRegion>(Reg))
679b86fdbe7SAnna Zaks     return isTainted(ER->getSuperRegion(), K) || isTainted(ER->getIndex(), K);
680b86fdbe7SAnna Zaks 
681b86fdbe7SAnna Zaks   if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(Reg))
682b86fdbe7SAnna Zaks     return isTainted(SR->getSymbol(), K);
683b86fdbe7SAnna Zaks 
684b86fdbe7SAnna Zaks   if (const SubRegion *ER = dyn_cast<SubRegion>(Reg))
685b86fdbe7SAnna Zaks     return isTainted(ER->getSuperRegion(), K);
686b86fdbe7SAnna Zaks 
687b86fdbe7SAnna Zaks   return false;
688ec7dc5c1SAnna Zaks }
689ec7dc5c1SAnna Zaks 
690126a2ef9SAnna Zaks bool ProgramState::isTainted(SymbolRef Sym, TaintTagType Kind) const {
69189c00c9dSAnna Zaks   if (!Sym)
69289c00c9dSAnna Zaks     return false;
69389c00c9dSAnna Zaks 
694b86fdbe7SAnna Zaks   // Traverse all the symbols this symbol depends on to see if any are tainted.
695ee1a4353SAnna Zaks   bool Tainted = false;
696ee1a4353SAnna Zaks   for (SymExpr::symbol_iterator SI = Sym->symbol_begin(), SE =Sym->symbol_end();
697ee1a4353SAnna Zaks        SI != SE; ++SI) {
698ee1a4353SAnna Zaks     assert(isa<SymbolData>(*SI));
699ee1a4353SAnna Zaks     const TaintTagType *Tag = get<TaintMap>(*SI);
700ee1a4353SAnna Zaks     Tainted = (Tag && *Tag == Kind);
701c25efcccSAnna Zaks 
702ee1a4353SAnna Zaks     // If this is a SymbolDerived with a tainted parent, it's also tainted.
703ee1a4353SAnna Zaks     if (const SymbolDerived *SD = dyn_cast<SymbolDerived>(*SI))
704ee1a4353SAnna Zaks       Tainted = Tainted || isTainted(SD->getParentSymbol(), Kind);
705394256ccSAnna Zaks 
706394256ccSAnna Zaks     // If memory region is tainted, data is also tainted.
707394256ccSAnna Zaks     if (const SymbolRegionValue *SRV = dyn_cast<SymbolRegionValue>(*SI))
708394256ccSAnna Zaks       Tainted = Tainted || isTainted(SRV->getRegion(), Kind);
709394256ccSAnna Zaks 
710282dc143SAnna Zaks     // If If this is a SymbolCast from a tainted value, it's also tainted.
711282dc143SAnna Zaks     if (const SymbolCast *SC = dyn_cast<SymbolCast>(*SI))
712282dc143SAnna Zaks       Tainted = Tainted || isTainted(SC->getOperand(), Kind);
713282dc143SAnna Zaks 
714ee1a4353SAnna Zaks     if (Tainted)
715ee1a4353SAnna Zaks       return true;
716ec7dc5c1SAnna Zaks   }
717ec7dc5c1SAnna Zaks 
718ee1a4353SAnna Zaks   return Tainted;
719ec7dc5c1SAnna Zaks }
720