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"
15d457ca92SJordan Rose #include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h"
1632b9e234STed Kremenek #include "clang/StaticAnalyzer/Core/PathSensitive/ProgramStateTrait.h"
1732b9e234STed Kremenek #include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState.h"
1832b9e234STed Kremenek #include "clang/StaticAnalyzer/Core/PathSensitive/SubEngine.h"
19ec7dc5c1SAnna Zaks #include "clang/StaticAnalyzer/Core/PathSensitive/TaintManager.h"
2032b9e234STed Kremenek #include "llvm/Support/raw_ostream.h"
2132b9e234STed Kremenek 
2232b9e234STed Kremenek using namespace clang;
2332b9e234STed Kremenek using namespace ento;
2432b9e234STed Kremenek 
252753ca84SArgyrios Kyrtzidis namespace clang { namespace  ento {
262753ca84SArgyrios Kyrtzidis /// Increments the number of times this state is referenced.
272753ca84SArgyrios Kyrtzidis 
282753ca84SArgyrios Kyrtzidis void ProgramStateRetain(const ProgramState *state) {
292753ca84SArgyrios Kyrtzidis   ++const_cast<ProgramState*>(state)->refCount;
302753ca84SArgyrios Kyrtzidis }
312753ca84SArgyrios Kyrtzidis 
322753ca84SArgyrios Kyrtzidis /// Decrement the number of times this state is referenced.
332753ca84SArgyrios Kyrtzidis void ProgramStateRelease(const ProgramState *state) {
342753ca84SArgyrios Kyrtzidis   assert(state->refCount > 0);
352753ca84SArgyrios Kyrtzidis   ProgramState *s = const_cast<ProgramState*>(state);
362753ca84SArgyrios Kyrtzidis   if (--s->refCount == 0) {
372753ca84SArgyrios Kyrtzidis     ProgramStateManager &Mgr = s->getStateManager();
382753ca84SArgyrios Kyrtzidis     Mgr.StateSet.RemoveNode(s);
392753ca84SArgyrios Kyrtzidis     s->~ProgramState();
402753ca84SArgyrios Kyrtzidis     Mgr.freeStates.push_back(s);
412753ca84SArgyrios Kyrtzidis   }
422753ca84SArgyrios Kyrtzidis }
432753ca84SArgyrios Kyrtzidis }}
442753ca84SArgyrios Kyrtzidis 
4532b9e234STed Kremenek ProgramState::ProgramState(ProgramStateManager *mgr, const Environment& env,
4632b9e234STed Kremenek                  StoreRef st, GenericDataMap gdm)
4732b9e234STed Kremenek   : stateMgr(mgr),
4832b9e234STed Kremenek     Env(env),
4932b9e234STed Kremenek     store(st.getStore()),
5032b9e234STed Kremenek     GDM(gdm),
5132b9e234STed Kremenek     refCount(0) {
5232b9e234STed Kremenek   stateMgr->getStoreManager().incrementReferenceCount(store);
5332b9e234STed Kremenek }
5432b9e234STed Kremenek 
5532b9e234STed Kremenek ProgramState::ProgramState(const ProgramState &RHS)
5632b9e234STed Kremenek     : llvm::FoldingSetNode(),
5732b9e234STed Kremenek       stateMgr(RHS.stateMgr),
5832b9e234STed Kremenek       Env(RHS.Env),
5932b9e234STed Kremenek       store(RHS.store),
6032b9e234STed Kremenek       GDM(RHS.GDM),
6132b9e234STed Kremenek       refCount(0) {
6232b9e234STed Kremenek   stateMgr->getStoreManager().incrementReferenceCount(store);
6332b9e234STed Kremenek }
6432b9e234STed Kremenek 
6532b9e234STed Kremenek ProgramState::~ProgramState() {
6632b9e234STed Kremenek   if (store)
6732b9e234STed Kremenek     stateMgr->getStoreManager().decrementReferenceCount(store);
6832b9e234STed Kremenek }
6932b9e234STed Kremenek 
70d457ca92SJordan Rose ProgramStateManager::ProgramStateManager(ASTContext &Ctx,
71d457ca92SJordan Rose                                          StoreManagerCreator CreateSMgr,
72d457ca92SJordan Rose                                          ConstraintManagerCreator CreateCMgr,
73d457ca92SJordan Rose                                          llvm::BumpPtrAllocator &alloc,
74d457ca92SJordan Rose                                          SubEngine &SubEng)
75d457ca92SJordan Rose   : Eng(&SubEng), EnvMgr(alloc), GDMFactory(alloc),
76d457ca92SJordan Rose     svalBuilder(createSimpleSValBuilder(alloc, Ctx, *this)),
77d457ca92SJordan Rose     CallEventMgr(new CallEventManager(alloc)), Alloc(alloc) {
78d457ca92SJordan Rose   StoreMgr.reset((*CreateSMgr)(*this));
79d457ca92SJordan Rose   ConstraintMgr.reset((*CreateCMgr)(*this, SubEng));
80d457ca92SJordan Rose }
81d457ca92SJordan Rose 
82d457ca92SJordan Rose 
8332b9e234STed Kremenek ProgramStateManager::~ProgramStateManager() {
8432b9e234STed Kremenek   for (GDMContextsTy::iterator I=GDMContexts.begin(), E=GDMContexts.end();
8532b9e234STed Kremenek        I!=E; ++I)
8632b9e234STed Kremenek     I->second.second(I->second.first);
8732b9e234STed Kremenek }
8832b9e234STed Kremenek 
8949b1e38eSTed Kremenek ProgramStateRef
9049b1e38eSTed Kremenek ProgramStateManager::removeDeadBindings(ProgramStateRef state,
9132b9e234STed Kremenek                                    const StackFrameContext *LCtx,
9232b9e234STed Kremenek                                    SymbolReaper& SymReaper) {
9332b9e234STed Kremenek 
9432b9e234STed Kremenek   // This code essentially performs a "mark-and-sweep" of the VariableBindings.
9532b9e234STed Kremenek   // The roots are any Block-level exprs and Decls that our liveness algorithm
9632b9e234STed Kremenek   // tells us are live.  We then see what Decls they may reference, and keep
9732b9e234STed Kremenek   // those around.  This code more than likely can be made faster, and the
9832b9e234STed Kremenek   // frequency of which this method is called should be experimented with
9932b9e234STed Kremenek   // for optimum performance.
10032b9e234STed Kremenek   ProgramState NewState = *state;
10132b9e234STed Kremenek 
10232b9e234STed Kremenek   NewState.Env = EnvMgr.removeDeadBindings(NewState.Env, SymReaper, state);
10332b9e234STed Kremenek 
10432b9e234STed Kremenek   // Clean up the store.
10532b9e234STed Kremenek   StoreRef newStore = StoreMgr->removeDeadBindings(NewState.getStore(), LCtx,
10632b9e234STed Kremenek                                                    SymReaper);
10732b9e234STed Kremenek   NewState.setStore(newStore);
10832b9e234STed Kremenek   SymReaper.setReapedStore(newStore);
10932b9e234STed Kremenek 
110*db72e2fcSJordan Rose   ProgramStateRef Result = getPersistentState(NewState);
111*db72e2fcSJordan Rose   return ConstraintMgr->removeDeadBindings(Result, SymReaper);
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 =
1182cd56c4cSTed Kremenek     getStateManager().StoreMgr->bindCompoundLiteral(getStore(), CL, LC, V);
11932b9e234STed Kremenek   return makeWithStore(newStore);
12032b9e234STed Kremenek }
12132b9e234STed Kremenek 
1221afcb744STed Kremenek ProgramStateRef ProgramState::bindLoc(Loc LV, SVal V, bool notifyChanges) const {
12332b9e234STed Kremenek   ProgramStateManager &Mgr = getStateManager();
12449b1e38eSTed Kremenek   ProgramStateRef newState = makeWithStore(Mgr.StoreMgr->Bind(getStore(),
12532b9e234STed Kremenek                                                              LV, V));
12632b9e234STed Kremenek   const MemRegion *MR = LV.getAsRegion();
1271afcb744STed Kremenek   if (MR && Mgr.getOwningEngine() && notifyChanges)
12832b9e234STed Kremenek     return Mgr.getOwningEngine()->processRegionChange(newState, MR);
12932b9e234STed Kremenek 
13032b9e234STed Kremenek   return newState;
13132b9e234STed Kremenek }
13232b9e234STed Kremenek 
13349b1e38eSTed Kremenek ProgramStateRef ProgramState::bindDefault(SVal loc, SVal V) const {
13432b9e234STed Kremenek   ProgramStateManager &Mgr = getStateManager();
13532b9e234STed Kremenek   const MemRegion *R = cast<loc::MemRegionVal>(loc).getRegion();
13632b9e234STed Kremenek   const StoreRef &newStore = Mgr.StoreMgr->BindDefault(getStore(), R, V);
13749b1e38eSTed Kremenek   ProgramStateRef new_state = makeWithStore(newStore);
13832b9e234STed Kremenek   return Mgr.getOwningEngine() ?
13932b9e234STed Kremenek            Mgr.getOwningEngine()->processRegionChange(new_state, R) :
14032b9e234STed Kremenek            new_state;
14132b9e234STed Kremenek }
14232b9e234STed Kremenek 
14349b1e38eSTed Kremenek ProgramStateRef
1441fad6631SJordy Rose ProgramState::invalidateRegions(ArrayRef<const MemRegion *> Regions,
14532b9e234STed Kremenek                                 const Expr *E, unsigned Count,
146d519cae8STed Kremenek                                 const LocationContext *LCtx,
14732b9e234STed Kremenek                                 StoreManager::InvalidatedSymbols *IS,
148742920c8SJordan Rose                                 const CallEvent *Call) const {
14932b9e234STed Kremenek   if (!IS) {
15032b9e234STed Kremenek     StoreManager::InvalidatedSymbols invalidated;
151d519cae8STed Kremenek     return invalidateRegionsImpl(Regions, E, Count, LCtx,
1528158ef0dSAnna Zaks                                  invalidated, Call);
15332b9e234STed Kremenek   }
154d519cae8STed Kremenek   return invalidateRegionsImpl(Regions, E, Count, LCtx, *IS, Call);
15532b9e234STed Kremenek }
15632b9e234STed Kremenek 
15749b1e38eSTed Kremenek ProgramStateRef
1581fad6631SJordy Rose ProgramState::invalidateRegionsImpl(ArrayRef<const MemRegion *> Regions,
15932b9e234STed Kremenek                                     const Expr *E, unsigned Count,
160d519cae8STed Kremenek                                     const LocationContext *LCtx,
16132b9e234STed Kremenek                                     StoreManager::InvalidatedSymbols &IS,
162742920c8SJordan Rose                                     const CallEvent *Call) const {
16332b9e234STed Kremenek   ProgramStateManager &Mgr = getStateManager();
16432b9e234STed Kremenek   SubEngine* Eng = Mgr.getOwningEngine();
16532b9e234STed Kremenek 
16632b9e234STed Kremenek   if (Eng && Eng->wantsRegionChangeUpdate(this)) {
1671fad6631SJordy Rose     StoreManager::InvalidatedRegions Invalidated;
16832b9e234STed Kremenek     const StoreRef &newStore
169d519cae8STed Kremenek       = Mgr.StoreMgr->invalidateRegions(getStore(), Regions, E, Count, LCtx, IS,
1708158ef0dSAnna Zaks                                         Call, &Invalidated);
17149b1e38eSTed Kremenek     ProgramStateRef newState = makeWithStore(newStore);
1723d34834bSAnna Zaks     return Eng->processRegionChanges(newState, &IS, Regions, Invalidated, Call);
17332b9e234STed Kremenek   }
17432b9e234STed Kremenek 
17532b9e234STed Kremenek   const StoreRef &newStore =
176d519cae8STed Kremenek     Mgr.StoreMgr->invalidateRegions(getStore(), Regions, E, Count, LCtx, IS,
1778158ef0dSAnna Zaks                                     Call, NULL);
17832b9e234STed Kremenek   return makeWithStore(newStore);
17932b9e234STed Kremenek }
18032b9e234STed Kremenek 
18162698881STed Kremenek ProgramStateRef ProgramState::killBinding(Loc LV) const {
18232b9e234STed Kremenek   assert(!isa<loc::MemRegionVal>(LV) && "Use invalidateRegion instead.");
18332b9e234STed Kremenek 
18432b9e234STed Kremenek   Store OldStore = getStore();
18562698881STed Kremenek   const StoreRef &newStore =
18662698881STed Kremenek     getStateManager().StoreMgr->killBinding(OldStore, LV);
18732b9e234STed Kremenek 
18832b9e234STed Kremenek   if (newStore.getStore() == OldStore)
18932b9e234STed Kremenek     return this;
19032b9e234STed Kremenek 
19132b9e234STed Kremenek   return makeWithStore(newStore);
19232b9e234STed Kremenek }
19332b9e234STed Kremenek 
19449b1e38eSTed Kremenek ProgramStateRef
195d1d54aa1SJordan Rose ProgramState::enterStackFrame(const CallEvent &Call,
196d1d54aa1SJordan Rose                               const StackFrameContext *CalleeCtx) const {
197d1d54aa1SJordan Rose   const StoreRef &NewStore =
198d1d54aa1SJordan Rose     getStateManager().StoreMgr->enterStackFrame(getStore(), Call, CalleeCtx);
199d1d54aa1SJordan Rose   return makeWithStore(NewStore);
20032b9e234STed Kremenek }
20132b9e234STed Kremenek 
20232b9e234STed Kremenek SVal ProgramState::getSValAsScalarOrLoc(const MemRegion *R) const {
20332b9e234STed Kremenek   // We only want to do fetches from regions that we can actually bind
20432b9e234STed Kremenek   // values.  For example, SymbolicRegions of type 'id<...>' cannot
20532b9e234STed Kremenek   // have direct bindings (but their can be bindings on their subregions).
20632b9e234STed Kremenek   if (!R->isBoundable())
20732b9e234STed Kremenek     return UnknownVal();
20832b9e234STed Kremenek 
20932b9e234STed Kremenek   if (const TypedValueRegion *TR = dyn_cast<TypedValueRegion>(R)) {
21032b9e234STed Kremenek     QualType T = TR->getValueType();
21132b9e234STed Kremenek     if (Loc::isLocType(T) || T->isIntegerType())
21232b9e234STed Kremenek       return getSVal(R);
21332b9e234STed Kremenek   }
21432b9e234STed Kremenek 
21532b9e234STed Kremenek   return UnknownVal();
21632b9e234STed Kremenek }
21732b9e234STed Kremenek 
21832b9e234STed Kremenek SVal ProgramState::getSVal(Loc location, QualType T) const {
21932b9e234STed Kremenek   SVal V = getRawSVal(cast<Loc>(location), T);
22032b9e234STed Kremenek 
22132b9e234STed Kremenek   // If 'V' is a symbolic value that is *perfectly* constrained to
22232b9e234STed Kremenek   // be a constant value, use that value instead to lessen the burden
22332b9e234STed Kremenek   // on later analysis stages (so we have less symbolic values to reason
22432b9e234STed Kremenek   // about).
22532b9e234STed Kremenek   if (!T.isNull()) {
22632b9e234STed Kremenek     if (SymbolRef sym = V.getAsSymbol()) {
227244e1d7dSTed Kremenek       if (const llvm::APSInt *Int = getStateManager()
228244e1d7dSTed Kremenek                                     .getConstraintManager()
229244e1d7dSTed Kremenek                                     .getSymVal(this, sym)) {
23032b9e234STed Kremenek         // FIXME: Because we don't correctly model (yet) sign-extension
23132b9e234STed Kremenek         // and truncation of symbolic values, we need to convert
23232b9e234STed Kremenek         // the integer value to the correct signedness and bitwidth.
23332b9e234STed Kremenek         //
23432b9e234STed Kremenek         // This shows up in the following:
23532b9e234STed Kremenek         //
23632b9e234STed Kremenek         //   char foo();
23732b9e234STed Kremenek         //   unsigned x = foo();
23832b9e234STed Kremenek         //   if (x == 54)
23932b9e234STed Kremenek         //     ...
24032b9e234STed Kremenek         //
24132b9e234STed Kremenek         //  The symbolic value stored to 'x' is actually the conjured
24232b9e234STed Kremenek         //  symbol for the call to foo(); the type of that symbol is 'char',
24332b9e234STed Kremenek         //  not unsigned.
24432b9e234STed Kremenek         const llvm::APSInt &NewV = getBasicVals().Convert(T, *Int);
24532b9e234STed Kremenek 
24632b9e234STed Kremenek         if (isa<Loc>(V))
24732b9e234STed Kremenek           return loc::ConcreteInt(NewV);
24832b9e234STed Kremenek         else
24932b9e234STed Kremenek           return nonloc::ConcreteInt(NewV);
25032b9e234STed Kremenek       }
25132b9e234STed Kremenek     }
25232b9e234STed Kremenek   }
25332b9e234STed Kremenek 
25432b9e234STed Kremenek   return V;
25532b9e234STed Kremenek }
25632b9e234STed Kremenek 
25749b1e38eSTed Kremenek ProgramStateRef ProgramState::BindExpr(const Stmt *S,
258632e3b7eSTed Kremenek                                            const LocationContext *LCtx,
259632e3b7eSTed Kremenek                                            SVal V, bool Invalidate) const{
260632e3b7eSTed Kremenek   Environment NewEnv =
261632e3b7eSTed Kremenek     getStateManager().EnvMgr.bindExpr(Env, EnvironmentEntry(S, LCtx), V,
26232b9e234STed Kremenek                                       Invalidate);
26332b9e234STed Kremenek   if (NewEnv == Env)
26432b9e234STed Kremenek     return this;
26532b9e234STed Kremenek 
26632b9e234STed Kremenek   ProgramState NewSt = *this;
26732b9e234STed Kremenek   NewSt.Env = NewEnv;
26832b9e234STed Kremenek   return getStateManager().getPersistentState(NewSt);
26932b9e234STed Kremenek }
27032b9e234STed Kremenek 
27149b1e38eSTed Kremenek ProgramStateRef
272632e3b7eSTed Kremenek ProgramState::bindExprAndLocation(const Stmt *S, const LocationContext *LCtx,
273632e3b7eSTed Kremenek                                   SVal location,
27432b9e234STed Kremenek                                   SVal V) const {
27532b9e234STed Kremenek   Environment NewEnv =
276632e3b7eSTed Kremenek     getStateManager().EnvMgr.bindExprAndLocation(Env,
277632e3b7eSTed Kremenek                                                  EnvironmentEntry(S, LCtx),
278632e3b7eSTed Kremenek                                                  location, V);
27932b9e234STed Kremenek 
28032b9e234STed Kremenek   if (NewEnv == Env)
28132b9e234STed Kremenek     return this;
28232b9e234STed Kremenek 
28332b9e234STed Kremenek   ProgramState NewSt = *this;
28432b9e234STed Kremenek   NewSt.Env = NewEnv;
28532b9e234STed Kremenek   return getStateManager().getPersistentState(NewSt);
28632b9e234STed Kremenek }
28732b9e234STed Kremenek 
28849b1e38eSTed Kremenek ProgramStateRef ProgramState::assumeInBound(DefinedOrUnknownSVal Idx,
28932b9e234STed Kremenek                                       DefinedOrUnknownSVal UpperBound,
2904f870e65SAnna Zaks                                       bool Assumption,
2914f870e65SAnna Zaks                                       QualType indexTy) const {
29232b9e234STed Kremenek   if (Idx.isUnknown() || UpperBound.isUnknown())
29332b9e234STed Kremenek     return this;
29432b9e234STed Kremenek 
29532b9e234STed Kremenek   // Build an expression for 0 <= Idx < UpperBound.
29632b9e234STed Kremenek   // This is the same as Idx + MIN < UpperBound + MIN, if overflow is allowed.
29732b9e234STed Kremenek   // FIXME: This should probably be part of SValBuilder.
29832b9e234STed Kremenek   ProgramStateManager &SM = getStateManager();
29932b9e234STed Kremenek   SValBuilder &svalBuilder = SM.getSValBuilder();
30032b9e234STed Kremenek   ASTContext &Ctx = svalBuilder.getContext();
30132b9e234STed Kremenek 
30232b9e234STed Kremenek   // Get the offset: the minimum value of the array index type.
30332b9e234STed Kremenek   BasicValueFactory &BVF = svalBuilder.getBasicValueFactory();
30432b9e234STed Kremenek   // FIXME: This should be using ValueManager::ArrayindexTy...somehow.
3054f870e65SAnna Zaks   if (indexTy.isNull())
3064f870e65SAnna Zaks     indexTy = Ctx.IntTy;
30732b9e234STed Kremenek   nonloc::ConcreteInt Min(BVF.getMinValue(indexTy));
30832b9e234STed Kremenek 
30932b9e234STed Kremenek   // Adjust the index.
31032b9e234STed Kremenek   SVal newIdx = svalBuilder.evalBinOpNN(this, BO_Add,
31132b9e234STed Kremenek                                         cast<NonLoc>(Idx), Min, indexTy);
31232b9e234STed Kremenek   if (newIdx.isUnknownOrUndef())
31332b9e234STed Kremenek     return this;
31432b9e234STed Kremenek 
31532b9e234STed Kremenek   // Adjust the upper bound.
31632b9e234STed Kremenek   SVal newBound =
31732b9e234STed Kremenek     svalBuilder.evalBinOpNN(this, BO_Add, cast<NonLoc>(UpperBound),
31832b9e234STed Kremenek                             Min, indexTy);
31932b9e234STed Kremenek 
32032b9e234STed Kremenek   if (newBound.isUnknownOrUndef())
32132b9e234STed Kremenek     return this;
32232b9e234STed Kremenek 
32332b9e234STed Kremenek   // Build the actual comparison.
32432b9e234STed Kremenek   SVal inBound = svalBuilder.evalBinOpNN(this, BO_LT,
32532b9e234STed Kremenek                                 cast<NonLoc>(newIdx), cast<NonLoc>(newBound),
32632b9e234STed Kremenek                                 Ctx.IntTy);
32732b9e234STed Kremenek   if (inBound.isUnknownOrUndef())
32832b9e234STed Kremenek     return this;
32932b9e234STed Kremenek 
33032b9e234STed Kremenek   // Finally, let the constraint manager take care of it.
33132b9e234STed Kremenek   ConstraintManager &CM = SM.getConstraintManager();
33232b9e234STed Kremenek   return CM.assume(this, cast<DefinedSVal>(inBound), Assumption);
33332b9e234STed Kremenek }
33432b9e234STed Kremenek 
33549b1e38eSTed Kremenek ProgramStateRef ProgramStateManager::getInitialState(const LocationContext *InitLoc) {
33632b9e234STed Kremenek   ProgramState State(this,
33732b9e234STed Kremenek                 EnvMgr.getInitialEnvironment(),
33832b9e234STed Kremenek                 StoreMgr->getInitialStore(InitLoc),
33932b9e234STed Kremenek                 GDMFactory.getEmptyMap());
34032b9e234STed Kremenek 
34132b9e234STed Kremenek   return getPersistentState(State);
34232b9e234STed Kremenek }
34332b9e234STed Kremenek 
34449b1e38eSTed Kremenek ProgramStateRef ProgramStateManager::getPersistentStateWithGDM(
34549b1e38eSTed Kremenek                                                      ProgramStateRef FromState,
34649b1e38eSTed Kremenek                                                      ProgramStateRef GDMState) {
3472753ca84SArgyrios Kyrtzidis   ProgramState NewState(*FromState);
34832b9e234STed Kremenek   NewState.GDM = GDMState->GDM;
34932b9e234STed Kremenek   return getPersistentState(NewState);
35032b9e234STed Kremenek }
35132b9e234STed Kremenek 
35249b1e38eSTed Kremenek ProgramStateRef ProgramStateManager::getPersistentState(ProgramState &State) {
35332b9e234STed Kremenek 
35432b9e234STed Kremenek   llvm::FoldingSetNodeID ID;
35532b9e234STed Kremenek   State.Profile(ID);
35632b9e234STed Kremenek   void *InsertPos;
35732b9e234STed Kremenek 
35832b9e234STed Kremenek   if (ProgramState *I = StateSet.FindNodeOrInsertPos(ID, InsertPos))
35932b9e234STed Kremenek     return I;
36032b9e234STed Kremenek 
36132b9e234STed Kremenek   ProgramState *newState = 0;
36232b9e234STed Kremenek   if (!freeStates.empty()) {
36332b9e234STed Kremenek     newState = freeStates.back();
36432b9e234STed Kremenek     freeStates.pop_back();
36532b9e234STed Kremenek   }
36632b9e234STed Kremenek   else {
36732b9e234STed Kremenek     newState = (ProgramState*) Alloc.Allocate<ProgramState>();
36832b9e234STed Kremenek   }
36932b9e234STed Kremenek   new (newState) ProgramState(State);
37032b9e234STed Kremenek   StateSet.InsertNode(newState, InsertPos);
37132b9e234STed Kremenek   return newState;
37232b9e234STed Kremenek }
37332b9e234STed Kremenek 
37449b1e38eSTed Kremenek ProgramStateRef ProgramState::makeWithStore(const StoreRef &store) const {
3752753ca84SArgyrios Kyrtzidis   ProgramState NewSt(*this);
37632b9e234STed Kremenek   NewSt.setStore(store);
37732b9e234STed Kremenek   return getStateManager().getPersistentState(NewSt);
37832b9e234STed Kremenek }
37932b9e234STed Kremenek 
38032b9e234STed Kremenek void ProgramState::setStore(const StoreRef &newStore) {
38132b9e234STed Kremenek   Store newStoreStore = newStore.getStore();
38232b9e234STed Kremenek   if (newStoreStore)
38332b9e234STed Kremenek     stateMgr->getStoreManager().incrementReferenceCount(newStoreStore);
38432b9e234STed Kremenek   if (store)
38532b9e234STed Kremenek     stateMgr->getStoreManager().decrementReferenceCount(store);
38632b9e234STed Kremenek   store = newStoreStore;
38732b9e234STed Kremenek }
38832b9e234STed Kremenek 
38932b9e234STed Kremenek //===----------------------------------------------------------------------===//
39032b9e234STed Kremenek //  State pretty-printing.
39132b9e234STed Kremenek //===----------------------------------------------------------------------===//
39232b9e234STed Kremenek 
393632e3b7eSTed Kremenek void ProgramState::print(raw_ostream &Out,
39458a20d31SJordy Rose                          const char *NL, const char *Sep) const {
39532b9e234STed Kremenek   // Print the store.
39632b9e234STed Kremenek   ProgramStateManager &Mgr = getStateManager();
39758a20d31SJordy Rose   Mgr.getStoreManager().print(getStore(), Out, NL, Sep);
39832b9e234STed Kremenek 
399632e3b7eSTed Kremenek   // Print out the environment.
400632e3b7eSTed Kremenek   Env.print(Out, NL, Sep);
40132b9e234STed Kremenek 
402632e3b7eSTed Kremenek   // Print out the constraints.
40358a20d31SJordy Rose   Mgr.getConstraintManager().print(this, Out, NL, Sep);
40432b9e234STed Kremenek 
40532b9e234STed Kremenek   // Print checker-specific data.
40658a20d31SJordy Rose   Mgr.getOwningEngine()->printState(Out, this, NL, Sep);
40732b9e234STed Kremenek }
40832b9e234STed Kremenek 
409632e3b7eSTed Kremenek void ProgramState::printDOT(raw_ostream &Out) const {
410632e3b7eSTed Kremenek   print(Out, "\\l", "\\|");
411f784d08dSAnna Zaks }
412f784d08dSAnna Zaks 
413f784d08dSAnna Zaks void ProgramState::dump() const {
414632e3b7eSTed Kremenek   print(llvm::errs());
41532b9e234STed Kremenek }
41632b9e234STed Kremenek 
417282dc143SAnna Zaks void ProgramState::printTaint(raw_ostream &Out,
418282dc143SAnna Zaks                               const char *NL, const char *Sep) const {
419282dc143SAnna Zaks   TaintMapImpl TM = get<TaintMap>();
420282dc143SAnna Zaks 
421282dc143SAnna Zaks   if (!TM.isEmpty())
422282dc143SAnna Zaks     Out <<"Tainted Symbols:" << NL;
423282dc143SAnna Zaks 
424282dc143SAnna Zaks   for (TaintMapImpl::iterator I = TM.begin(), E = TM.end(); I != E; ++I) {
425282dc143SAnna Zaks     Out << I->first << " : " << I->second << NL;
426282dc143SAnna Zaks   }
427282dc143SAnna Zaks }
428282dc143SAnna Zaks 
429282dc143SAnna Zaks void ProgramState::dumpTaint() const {
430282dc143SAnna Zaks   printTaint(llvm::errs());
431282dc143SAnna Zaks }
432282dc143SAnna Zaks 
43332b9e234STed Kremenek //===----------------------------------------------------------------------===//
43432b9e234STed Kremenek // Generic Data Map.
43532b9e234STed Kremenek //===----------------------------------------------------------------------===//
43632b9e234STed Kremenek 
43732b9e234STed Kremenek void *const* ProgramState::FindGDM(void *K) const {
43832b9e234STed Kremenek   return GDM.lookup(K);
43932b9e234STed Kremenek }
44032b9e234STed Kremenek 
44132b9e234STed Kremenek void*
44232b9e234STed Kremenek ProgramStateManager::FindGDMContext(void *K,
44332b9e234STed Kremenek                                void *(*CreateContext)(llvm::BumpPtrAllocator&),
44432b9e234STed Kremenek                                void (*DeleteContext)(void*)) {
44532b9e234STed Kremenek 
44632b9e234STed Kremenek   std::pair<void*, void (*)(void*)>& p = GDMContexts[K];
44732b9e234STed Kremenek   if (!p.first) {
44832b9e234STed Kremenek     p.first = CreateContext(Alloc);
44932b9e234STed Kremenek     p.second = DeleteContext;
45032b9e234STed Kremenek   }
45132b9e234STed Kremenek 
45232b9e234STed Kremenek   return p.first;
45332b9e234STed Kremenek }
45432b9e234STed Kremenek 
45549b1e38eSTed Kremenek ProgramStateRef ProgramStateManager::addGDM(ProgramStateRef St, void *Key, void *Data){
45632b9e234STed Kremenek   ProgramState::GenericDataMap M1 = St->getGDM();
45732b9e234STed Kremenek   ProgramState::GenericDataMap M2 = GDMFactory.add(M1, Key, Data);
45832b9e234STed Kremenek 
45932b9e234STed Kremenek   if (M1 == M2)
46032b9e234STed Kremenek     return St;
46132b9e234STed Kremenek 
46232b9e234STed Kremenek   ProgramState NewSt = *St;
46332b9e234STed Kremenek   NewSt.GDM = M2;
46432b9e234STed Kremenek   return getPersistentState(NewSt);
46532b9e234STed Kremenek }
46632b9e234STed Kremenek 
46749b1e38eSTed Kremenek ProgramStateRef ProgramStateManager::removeGDM(ProgramStateRef state, void *Key) {
46832b9e234STed Kremenek   ProgramState::GenericDataMap OldM = state->getGDM();
46932b9e234STed Kremenek   ProgramState::GenericDataMap NewM = GDMFactory.remove(OldM, Key);
47032b9e234STed Kremenek 
47132b9e234STed Kremenek   if (NewM == OldM)
47232b9e234STed Kremenek     return state;
47332b9e234STed Kremenek 
47432b9e234STed Kremenek   ProgramState NewState = *state;
47532b9e234STed Kremenek   NewState.GDM = NewM;
47632b9e234STed Kremenek   return getPersistentState(NewState);
47732b9e234STed Kremenek }
47832b9e234STed Kremenek 
47932b9e234STed Kremenek bool ScanReachableSymbols::scan(nonloc::CompoundVal val) {
48032b9e234STed Kremenek   for (nonloc::CompoundVal::iterator I=val.begin(), E=val.end(); I!=E; ++I)
48132b9e234STed Kremenek     if (!scan(*I))
48232b9e234STed Kremenek       return false;
48332b9e234STed Kremenek 
48432b9e234STed Kremenek   return true;
48532b9e234STed Kremenek }
48632b9e234STed Kremenek 
48732b9e234STed Kremenek bool ScanReachableSymbols::scan(const SymExpr *sym) {
48832b9e234STed Kremenek   unsigned &isVisited = visited[sym];
48932b9e234STed Kremenek   if (isVisited)
49032b9e234STed Kremenek     return true;
49132b9e234STed Kremenek   isVisited = 1;
49232b9e234STed Kremenek 
493a636fbe7SAnna Zaks   if (!visitor.VisitSymbol(sym))
49432b9e234STed Kremenek     return false;
49532b9e234STed Kremenek 
49652fb9c08SAnna Zaks   // TODO: should be rewritten using SymExpr::symbol_iterator.
49732b9e234STed Kremenek   switch (sym->getKind()) {
49832b9e234STed Kremenek     case SymExpr::RegionValueKind:
49932b9e234STed Kremenek     case SymExpr::ConjuredKind:
50032b9e234STed Kremenek     case SymExpr::DerivedKind:
50132b9e234STed Kremenek     case SymExpr::ExtentKind:
50232b9e234STed Kremenek     case SymExpr::MetadataKind:
50332b9e234STed Kremenek       break;
504c25efcccSAnna Zaks     case SymExpr::CastSymbolKind:
505c25efcccSAnna Zaks       return scan(cast<SymbolCast>(sym)->getOperand());
50632b9e234STed Kremenek     case SymExpr::SymIntKind:
50732b9e234STed Kremenek       return scan(cast<SymIntExpr>(sym)->getLHS());
508ecd73008SAnna Zaks     case SymExpr::IntSymKind:
509ecd73008SAnna Zaks       return scan(cast<IntSymExpr>(sym)->getRHS());
51032b9e234STed Kremenek     case SymExpr::SymSymKind: {
51132b9e234STed Kremenek       const SymSymExpr *x = cast<SymSymExpr>(sym);
51232b9e234STed Kremenek       return scan(x->getLHS()) && scan(x->getRHS());
51332b9e234STed Kremenek     }
51432b9e234STed Kremenek   }
51532b9e234STed Kremenek   return true;
51632b9e234STed Kremenek }
51732b9e234STed Kremenek 
51832b9e234STed Kremenek bool ScanReachableSymbols::scan(SVal val) {
51932b9e234STed Kremenek   if (loc::MemRegionVal *X = dyn_cast<loc::MemRegionVal>(&val))
52032b9e234STed Kremenek     return scan(X->getRegion());
52132b9e234STed Kremenek 
522356279caSJordan Rose   if (nonloc::LazyCompoundVal *X = dyn_cast<nonloc::LazyCompoundVal>(&val))
523356279caSJordan Rose     return scan(X->getRegion());
524356279caSJordan Rose 
52532b9e234STed Kremenek   if (nonloc::LocAsInteger *X = dyn_cast<nonloc::LocAsInteger>(&val))
52632b9e234STed Kremenek     return scan(X->getLoc());
52732b9e234STed Kremenek 
52832b9e234STed Kremenek   if (SymbolRef Sym = val.getAsSymbol())
52932b9e234STed Kremenek     return scan(Sym);
53032b9e234STed Kremenek 
53132b9e234STed Kremenek   if (const SymExpr *Sym = val.getAsSymbolicExpression())
53232b9e234STed Kremenek     return scan(Sym);
53332b9e234STed Kremenek 
53432b9e234STed Kremenek   if (nonloc::CompoundVal *X = dyn_cast<nonloc::CompoundVal>(&val))
53532b9e234STed Kremenek     return scan(*X);
53632b9e234STed Kremenek 
53732b9e234STed Kremenek   return true;
53832b9e234STed Kremenek }
53932b9e234STed Kremenek 
54032b9e234STed Kremenek bool ScanReachableSymbols::scan(const MemRegion *R) {
54132b9e234STed Kremenek   if (isa<MemSpaceRegion>(R))
54232b9e234STed Kremenek     return true;
54332b9e234STed Kremenek 
54432b9e234STed Kremenek   unsigned &isVisited = visited[R];
54532b9e234STed Kremenek   if (isVisited)
54632b9e234STed Kremenek     return true;
54732b9e234STed Kremenek   isVisited = 1;
548b14b42d4STed Kremenek 
549b14b42d4STed Kremenek 
550b14b42d4STed Kremenek   if (!visitor.VisitMemRegion(R))
551b14b42d4STed Kremenek     return false;
55232b9e234STed Kremenek 
55332b9e234STed Kremenek   // If this is a symbolic region, visit the symbol for the region.
55432b9e234STed Kremenek   if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(R))
55532b9e234STed Kremenek     if (!visitor.VisitSymbol(SR->getSymbol()))
55632b9e234STed Kremenek       return false;
55732b9e234STed Kremenek 
55832b9e234STed Kremenek   // If this is a subregion, also visit the parent regions.
5593a80cec5SJordan Rose   if (const SubRegion *SR = dyn_cast<SubRegion>(R)) {
5603a80cec5SJordan Rose     const MemRegion *Super = SR->getSuperRegion();
5613a80cec5SJordan Rose     if (!scan(Super))
56232b9e234STed Kremenek       return false;
56332b9e234STed Kremenek 
5643a80cec5SJordan Rose     // When we reach the topmost region, scan all symbols in it.
5653a80cec5SJordan Rose     if (isa<MemSpaceRegion>(Super)) {
5663a80cec5SJordan Rose       StoreManager &StoreMgr = state->getStateManager().getStoreManager();
5673a80cec5SJordan Rose       if (!StoreMgr.scanReachableSymbols(state->getStore(), SR, *this))
5683a80cec5SJordan Rose         return false;
5693a80cec5SJordan Rose     }
5703a80cec5SJordan Rose   }
5713a80cec5SJordan Rose 
572c3da376fSTed Kremenek   // Regions captured by a block are also implicitly reachable.
573c3da376fSTed Kremenek   if (const BlockDataRegion *BDR = dyn_cast<BlockDataRegion>(R)) {
574c3da376fSTed Kremenek     BlockDataRegion::referenced_vars_iterator I = BDR->referenced_vars_begin(),
575c3da376fSTed Kremenek                                               E = BDR->referenced_vars_end();
576c3da376fSTed Kremenek     for ( ; I != E; ++I) {
577c3da376fSTed Kremenek       if (!scan(I.getCapturedRegion()))
578c3da376fSTed Kremenek         return false;
579c3da376fSTed Kremenek     }
580c3da376fSTed Kremenek   }
581c3da376fSTed Kremenek 
5823a80cec5SJordan Rose   return true;
58332b9e234STed Kremenek }
58432b9e234STed Kremenek 
58532b9e234STed Kremenek bool ProgramState::scanReachableSymbols(SVal val, SymbolVisitor& visitor) const {
58632b9e234STed Kremenek   ScanReachableSymbols S(this, visitor);
58732b9e234STed Kremenek   return S.scan(val);
58832b9e234STed Kremenek }
58932b9e234STed Kremenek 
59032b9e234STed Kremenek bool ProgramState::scanReachableSymbols(const SVal *I, const SVal *E,
59132b9e234STed Kremenek                                    SymbolVisitor &visitor) const {
59232b9e234STed Kremenek   ScanReachableSymbols S(this, visitor);
59332b9e234STed Kremenek   for ( ; I != E; ++I) {
59432b9e234STed Kremenek     if (!S.scan(*I))
59532b9e234STed Kremenek       return false;
59632b9e234STed Kremenek   }
59732b9e234STed Kremenek   return true;
59832b9e234STed Kremenek }
59932b9e234STed Kremenek 
60032b9e234STed Kremenek bool ProgramState::scanReachableSymbols(const MemRegion * const *I,
60132b9e234STed Kremenek                                    const MemRegion * const *E,
60232b9e234STed Kremenek                                    SymbolVisitor &visitor) const {
60332b9e234STed Kremenek   ScanReachableSymbols S(this, visitor);
60432b9e234STed Kremenek   for ( ; I != E; ++I) {
60532b9e234STed Kremenek     if (!S.scan(*I))
60632b9e234STed Kremenek       return false;
60732b9e234STed Kremenek   }
60832b9e234STed Kremenek   return true;
60932b9e234STed Kremenek }
610ec7dc5c1SAnna Zaks 
61149b1e38eSTed Kremenek ProgramStateRef ProgramState::addTaint(const Stmt *S,
612632e3b7eSTed Kremenek                                            const LocationContext *LCtx,
613ec7dc5c1SAnna Zaks                                            TaintTagType Kind) const {
614e48ee503SAnna Zaks   if (const Expr *E = dyn_cast_or_null<Expr>(S))
615e48ee503SAnna Zaks     S = E->IgnoreParens();
616e48ee503SAnna Zaks 
617632e3b7eSTed Kremenek   SymbolRef Sym = getSVal(S, LCtx).getAsSymbol();
618d6bb3227SAnna Zaks   if (Sym)
619ec7dc5c1SAnna Zaks     return addTaint(Sym, Kind);
620d6bb3227SAnna Zaks 
621632e3b7eSTed Kremenek   const MemRegion *R = getSVal(S, LCtx).getAsRegion();
62204b57c25SAnna Zaks   addTaint(R, Kind);
623d6bb3227SAnna Zaks 
624d6bb3227SAnna Zaks   // Cannot add taint, so just return the state.
625d6bb3227SAnna Zaks   return this;
626ec7dc5c1SAnna Zaks }
627ec7dc5c1SAnna Zaks 
62849b1e38eSTed Kremenek ProgramStateRef ProgramState::addTaint(const MemRegion *R,
62904b57c25SAnna Zaks                                            TaintTagType Kind) const {
63004b57c25SAnna Zaks   if (const SymbolicRegion *SR = dyn_cast_or_null<SymbolicRegion>(R))
63104b57c25SAnna Zaks     return addTaint(SR->getSymbol(), Kind);
63204b57c25SAnna Zaks   return this;
63304b57c25SAnna Zaks }
63404b57c25SAnna Zaks 
63549b1e38eSTed Kremenek ProgramStateRef ProgramState::addTaint(SymbolRef Sym,
636ec7dc5c1SAnna Zaks                                            TaintTagType Kind) const {
637282dc143SAnna Zaks   // If this is a symbol cast, remove the cast before adding the taint. Taint
638282dc143SAnna Zaks   // is cast agnostic.
639282dc143SAnna Zaks   while (const SymbolCast *SC = dyn_cast<SymbolCast>(Sym))
640282dc143SAnna Zaks     Sym = SC->getOperand();
641282dc143SAnna Zaks 
64249b1e38eSTed Kremenek   ProgramStateRef NewState = set<TaintMap>(Sym, Kind);
643ec7dc5c1SAnna Zaks   assert(NewState);
644ec7dc5c1SAnna Zaks   return NewState;
645ec7dc5c1SAnna Zaks }
646ec7dc5c1SAnna Zaks 
647632e3b7eSTed Kremenek bool ProgramState::isTainted(const Stmt *S, const LocationContext *LCtx,
648632e3b7eSTed Kremenek                              TaintTagType Kind) const {
649e48ee503SAnna Zaks   if (const Expr *E = dyn_cast_or_null<Expr>(S))
650e48ee503SAnna Zaks     S = E->IgnoreParens();
651e48ee503SAnna Zaks 
652632e3b7eSTed Kremenek   SVal val = getSVal(S, LCtx);
6539da86ce8SAnna Zaks   return isTainted(val, Kind);
654ec7dc5c1SAnna Zaks }
655ec7dc5c1SAnna Zaks 
656ec7dc5c1SAnna Zaks bool ProgramState::isTainted(SVal V, TaintTagType Kind) const {
657b86fdbe7SAnna Zaks   if (const SymExpr *Sym = V.getAsSymExpr())
658b86fdbe7SAnna Zaks     return isTainted(Sym, Kind);
6599de45554SAnna Zaks   if (const MemRegion *Reg = V.getAsRegion())
6609de45554SAnna Zaks     return isTainted(Reg, Kind);
661b86fdbe7SAnna Zaks   return false;
662b86fdbe7SAnna Zaks }
663b86fdbe7SAnna Zaks 
664b86fdbe7SAnna Zaks bool ProgramState::isTainted(const MemRegion *Reg, TaintTagType K) const {
665b86fdbe7SAnna Zaks   if (!Reg)
666b86fdbe7SAnna Zaks     return false;
667b86fdbe7SAnna Zaks 
668b86fdbe7SAnna Zaks   // Element region (array element) is tainted if either the base or the offset
669b86fdbe7SAnna Zaks   // are tainted.
670b86fdbe7SAnna Zaks   if (const ElementRegion *ER = dyn_cast<ElementRegion>(Reg))
671b86fdbe7SAnna Zaks     return isTainted(ER->getSuperRegion(), K) || isTainted(ER->getIndex(), K);
672b86fdbe7SAnna Zaks 
673b86fdbe7SAnna Zaks   if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(Reg))
674b86fdbe7SAnna Zaks     return isTainted(SR->getSymbol(), K);
675b86fdbe7SAnna Zaks 
676b86fdbe7SAnna Zaks   if (const SubRegion *ER = dyn_cast<SubRegion>(Reg))
677b86fdbe7SAnna Zaks     return isTainted(ER->getSuperRegion(), K);
678b86fdbe7SAnna Zaks 
679b86fdbe7SAnna Zaks   return false;
680ec7dc5c1SAnna Zaks }
681ec7dc5c1SAnna Zaks 
682126a2ef9SAnna Zaks bool ProgramState::isTainted(SymbolRef Sym, TaintTagType Kind) const {
68389c00c9dSAnna Zaks   if (!Sym)
68489c00c9dSAnna Zaks     return false;
68589c00c9dSAnna Zaks 
686b86fdbe7SAnna Zaks   // Traverse all the symbols this symbol depends on to see if any are tainted.
687ee1a4353SAnna Zaks   bool Tainted = false;
688ee1a4353SAnna Zaks   for (SymExpr::symbol_iterator SI = Sym->symbol_begin(), SE =Sym->symbol_end();
689ee1a4353SAnna Zaks        SI != SE; ++SI) {
690*db72e2fcSJordan Rose     if (!isa<SymbolData>(*SI))
691*db72e2fcSJordan Rose       continue;
692*db72e2fcSJordan Rose 
693ee1a4353SAnna Zaks     const TaintTagType *Tag = get<TaintMap>(*SI);
694ee1a4353SAnna Zaks     Tainted = (Tag && *Tag == Kind);
695c25efcccSAnna Zaks 
696ee1a4353SAnna Zaks     // If this is a SymbolDerived with a tainted parent, it's also tainted.
697ee1a4353SAnna Zaks     if (const SymbolDerived *SD = dyn_cast<SymbolDerived>(*SI))
698ee1a4353SAnna Zaks       Tainted = Tainted || isTainted(SD->getParentSymbol(), Kind);
699394256ccSAnna Zaks 
700394256ccSAnna Zaks     // If memory region is tainted, data is also tainted.
701394256ccSAnna Zaks     if (const SymbolRegionValue *SRV = dyn_cast<SymbolRegionValue>(*SI))
702394256ccSAnna Zaks       Tainted = Tainted || isTainted(SRV->getRegion(), Kind);
703394256ccSAnna Zaks 
704282dc143SAnna Zaks     // If If this is a SymbolCast from a tainted value, it's also tainted.
705282dc143SAnna Zaks     if (const SymbolCast *SC = dyn_cast<SymbolCast>(*SI))
706282dc143SAnna Zaks       Tainted = Tainted || isTainted(SC->getOperand(), Kind);
707282dc143SAnna Zaks 
708ee1a4353SAnna Zaks     if (Tainted)
709ee1a4353SAnna Zaks       return true;
710ec7dc5c1SAnna Zaks   }
711ec7dc5c1SAnna Zaks 
712ee1a4353SAnna Zaks   return Tainted;
713ec7dc5c1SAnna Zaks }
71463282aefSAnna Zaks 
715150843b8SAnna Zaks /// The GDM component containing the dynamic type info. This is a map from a
716150843b8SAnna Zaks /// symbol to it's most likely type.
717150843b8SAnna Zaks namespace clang {
718150843b8SAnna Zaks namespace ento {
719e521f932SJordan Rose typedef llvm::ImmutableMap<const MemRegion *, DynamicTypeInfo> DynamicTypeMap;
720150843b8SAnna Zaks template<> struct ProgramStateTrait<DynamicTypeMap>
721e521f932SJordan Rose     : public ProgramStatePartialTrait<DynamicTypeMap> {
722150843b8SAnna Zaks   static void *GDMIndex() { static int index; return &index; }
723150843b8SAnna Zaks };
724150843b8SAnna Zaks }}
725150843b8SAnna Zaks 
72663282aefSAnna Zaks DynamicTypeInfo ProgramState::getDynamicTypeInfo(const MemRegion *Reg) const {
7270f6d63beSJordan Rose   Reg = Reg->StripCasts();
7280f6d63beSJordan Rose 
729150843b8SAnna Zaks   // Look up the dynamic type in the GDM.
730e521f932SJordan Rose   const DynamicTypeInfo *GDMType = get<DynamicTypeMap>(Reg);
731150843b8SAnna Zaks   if (GDMType)
732150843b8SAnna Zaks     return *GDMType;
733150843b8SAnna Zaks 
734e521f932SJordan Rose   // Otherwise, fall back to what we know about the region.
7350f6d63beSJordan Rose   if (const TypedRegion *TR = dyn_cast<TypedRegion>(Reg))
7360f6d63beSJordan Rose     return DynamicTypeInfo(TR->getLocationType(), /*CanBeSubclass=*/false);
737e521f932SJordan Rose 
738e521f932SJordan Rose   if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(Reg)) {
739e521f932SJordan Rose     SymbolRef Sym = SR->getSymbol();
740150843b8SAnna Zaks     return DynamicTypeInfo(Sym->getType(getStateManager().getContext()));
741150843b8SAnna Zaks   }
742e521f932SJordan Rose 
74363282aefSAnna Zaks   return DynamicTypeInfo();
74463282aefSAnna Zaks }
745150843b8SAnna Zaks 
746a0105b23SAnna Zaks ProgramStateRef ProgramState::setDynamicTypeInfo(const MemRegion *Reg,
747472dbcf1SAnna Zaks                                                  DynamicTypeInfo NewTy) const {
7480f6d63beSJordan Rose   Reg = Reg->StripCasts();
749e521f932SJordan Rose   ProgramStateRef NewState = set<DynamicTypeMap>(Reg, NewTy);
750150843b8SAnna Zaks   assert(NewState);
751150843b8SAnna Zaks   return NewState;
752150843b8SAnna Zaks }
753