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 
143a02247dSChandler Carruth #include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState.h"
1532b9e234STed Kremenek #include "clang/Analysis/CFG.h"
16d457ca92SJordan Rose #include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h"
1732b9e234STed Kremenek #include "clang/StaticAnalyzer/Core/PathSensitive/ProgramStateTrait.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,
74d63f04d8SJordan Rose                                          SubEngine *SubEng)
75d63f04d8SJordan 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 
110db72e2fcSJordan Rose   ProgramStateRef Result = getPersistentState(NewState);
111db72e2fcSJordan 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();
135*2fdacbc5SDavid Blaikie   const MemRegion *R = loc.castAs<loc::MemRegionVal>().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,
1479747febbSAnna Zaks                                 bool CausedByPointerEscape,
148dc15415dSAnna Zaks                                 InvalidatedSymbols *IS,
149742920c8SJordan Rose                                 const CallEvent *Call) const {
15032b9e234STed Kremenek   if (!IS) {
151dc15415dSAnna Zaks     InvalidatedSymbols invalidated;
152d519cae8STed Kremenek     return invalidateRegionsImpl(Regions, E, Count, LCtx,
1539747febbSAnna Zaks                                  CausedByPointerEscape,
1548158ef0dSAnna Zaks                                  invalidated, Call);
15532b9e234STed Kremenek   }
1569747febbSAnna Zaks   return invalidateRegionsImpl(Regions, E, Count, LCtx, CausedByPointerEscape,
157dc15415dSAnna Zaks                                *IS, Call);
15832b9e234STed Kremenek }
15932b9e234STed Kremenek 
16049b1e38eSTed Kremenek ProgramStateRef
1611fad6631SJordy Rose ProgramState::invalidateRegionsImpl(ArrayRef<const MemRegion *> Regions,
16232b9e234STed Kremenek                                     const Expr *E, unsigned Count,
163d519cae8STed Kremenek                                     const LocationContext *LCtx,
1649747febbSAnna Zaks                                     bool CausedByPointerEscape,
165dc15415dSAnna Zaks                                     InvalidatedSymbols &IS,
166742920c8SJordan Rose                                     const CallEvent *Call) const {
16732b9e234STed Kremenek   ProgramStateManager &Mgr = getStateManager();
16832b9e234STed Kremenek   SubEngine* Eng = Mgr.getOwningEngine();
16932b9e234STed Kremenek 
170dc15415dSAnna Zaks   if (Eng) {
1711fad6631SJordy Rose     StoreManager::InvalidatedRegions Invalidated;
17232b9e234STed Kremenek     const StoreRef &newStore
173d519cae8STed Kremenek       = Mgr.StoreMgr->invalidateRegions(getStore(), Regions, E, Count, LCtx, IS,
1748158ef0dSAnna Zaks                                         Call, &Invalidated);
175dc15415dSAnna Zaks 
17649b1e38eSTed Kremenek     ProgramStateRef newState = makeWithStore(newStore);
177dc15415dSAnna Zaks 
1789747febbSAnna Zaks     if (CausedByPointerEscape)
179dc15415dSAnna Zaks       newState = Eng->processPointerEscapedOnInvalidateRegions(newState,
180dc15415dSAnna Zaks                                                &IS, Regions, Invalidated, Call);
181dc15415dSAnna Zaks 
1823d34834bSAnna Zaks     return Eng->processRegionChanges(newState, &IS, Regions, Invalidated, Call);
18332b9e234STed Kremenek   }
18432b9e234STed Kremenek 
18532b9e234STed Kremenek   const StoreRef &newStore =
186d519cae8STed Kremenek     Mgr.StoreMgr->invalidateRegions(getStore(), Regions, E, Count, LCtx, IS,
1878158ef0dSAnna Zaks                                     Call, NULL);
18832b9e234STed Kremenek   return makeWithStore(newStore);
18932b9e234STed Kremenek }
19032b9e234STed Kremenek 
19162698881STed Kremenek ProgramStateRef ProgramState::killBinding(Loc LV) const {
192*2fdacbc5SDavid Blaikie   assert(!LV.getAs<loc::MemRegionVal>() && "Use invalidateRegion instead.");
19332b9e234STed Kremenek 
19432b9e234STed Kremenek   Store OldStore = getStore();
19562698881STed Kremenek   const StoreRef &newStore =
19662698881STed Kremenek     getStateManager().StoreMgr->killBinding(OldStore, LV);
19732b9e234STed Kremenek 
19832b9e234STed Kremenek   if (newStore.getStore() == OldStore)
19932b9e234STed Kremenek     return this;
20032b9e234STed Kremenek 
20132b9e234STed Kremenek   return makeWithStore(newStore);
20232b9e234STed Kremenek }
20332b9e234STed Kremenek 
20449b1e38eSTed Kremenek ProgramStateRef
205d1d54aa1SJordan Rose ProgramState::enterStackFrame(const CallEvent &Call,
206d1d54aa1SJordan Rose                               const StackFrameContext *CalleeCtx) const {
207d1d54aa1SJordan Rose   const StoreRef &NewStore =
208d1d54aa1SJordan Rose     getStateManager().StoreMgr->enterStackFrame(getStore(), Call, CalleeCtx);
209d1d54aa1SJordan Rose   return makeWithStore(NewStore);
21032b9e234STed Kremenek }
21132b9e234STed Kremenek 
21232b9e234STed Kremenek SVal ProgramState::getSValAsScalarOrLoc(const MemRegion *R) const {
21332b9e234STed Kremenek   // We only want to do fetches from regions that we can actually bind
21432b9e234STed Kremenek   // values.  For example, SymbolicRegions of type 'id<...>' cannot
21532b9e234STed Kremenek   // have direct bindings (but their can be bindings on their subregions).
21632b9e234STed Kremenek   if (!R->isBoundable())
21732b9e234STed Kremenek     return UnknownVal();
21832b9e234STed Kremenek 
21932b9e234STed Kremenek   if (const TypedValueRegion *TR = dyn_cast<TypedValueRegion>(R)) {
22032b9e234STed Kremenek     QualType T = TR->getValueType();
22132b9e234STed Kremenek     if (Loc::isLocType(T) || T->isIntegerType())
22232b9e234STed Kremenek       return getSVal(R);
22332b9e234STed Kremenek   }
22432b9e234STed Kremenek 
22532b9e234STed Kremenek   return UnknownVal();
22632b9e234STed Kremenek }
22732b9e234STed Kremenek 
22832b9e234STed Kremenek SVal ProgramState::getSVal(Loc location, QualType T) const {
22932b9e234STed Kremenek   SVal V = getRawSVal(cast<Loc>(location), T);
23032b9e234STed Kremenek 
23132b9e234STed Kremenek   // If 'V' is a symbolic value that is *perfectly* constrained to
23232b9e234STed Kremenek   // be a constant value, use that value instead to lessen the burden
23332b9e234STed Kremenek   // on later analysis stages (so we have less symbolic values to reason
23432b9e234STed Kremenek   // about).
23532b9e234STed Kremenek   if (!T.isNull()) {
23632b9e234STed Kremenek     if (SymbolRef sym = V.getAsSymbol()) {
237244e1d7dSTed Kremenek       if (const llvm::APSInt *Int = getStateManager()
238244e1d7dSTed Kremenek                                     .getConstraintManager()
239244e1d7dSTed Kremenek                                     .getSymVal(this, sym)) {
24032b9e234STed Kremenek         // FIXME: Because we don't correctly model (yet) sign-extension
24132b9e234STed Kremenek         // and truncation of symbolic values, we need to convert
24232b9e234STed Kremenek         // the integer value to the correct signedness and bitwidth.
24332b9e234STed Kremenek         //
24432b9e234STed Kremenek         // This shows up in the following:
24532b9e234STed Kremenek         //
24632b9e234STed Kremenek         //   char foo();
24732b9e234STed Kremenek         //   unsigned x = foo();
24832b9e234STed Kremenek         //   if (x == 54)
24932b9e234STed Kremenek         //     ...
25032b9e234STed Kremenek         //
25132b9e234STed Kremenek         //  The symbolic value stored to 'x' is actually the conjured
25232b9e234STed Kremenek         //  symbol for the call to foo(); the type of that symbol is 'char',
25332b9e234STed Kremenek         //  not unsigned.
25432b9e234STed Kremenek         const llvm::APSInt &NewV = getBasicVals().Convert(T, *Int);
25532b9e234STed Kremenek 
256*2fdacbc5SDavid Blaikie         if (V.getAs<Loc>())
25732b9e234STed Kremenek           return loc::ConcreteInt(NewV);
25832b9e234STed Kremenek         else
25932b9e234STed Kremenek           return nonloc::ConcreteInt(NewV);
26032b9e234STed Kremenek       }
26132b9e234STed Kremenek     }
26232b9e234STed Kremenek   }
26332b9e234STed Kremenek 
26432b9e234STed Kremenek   return V;
26532b9e234STed Kremenek }
26632b9e234STed Kremenek 
26749b1e38eSTed Kremenek ProgramStateRef ProgramState::BindExpr(const Stmt *S,
268632e3b7eSTed Kremenek                                            const LocationContext *LCtx,
269632e3b7eSTed Kremenek                                            SVal V, bool Invalidate) const{
270632e3b7eSTed Kremenek   Environment NewEnv =
271632e3b7eSTed Kremenek     getStateManager().EnvMgr.bindExpr(Env, EnvironmentEntry(S, LCtx), V,
27232b9e234STed Kremenek                                       Invalidate);
27332b9e234STed Kremenek   if (NewEnv == Env)
27432b9e234STed Kremenek     return this;
27532b9e234STed Kremenek 
27632b9e234STed Kremenek   ProgramState NewSt = *this;
27732b9e234STed Kremenek   NewSt.Env = NewEnv;
27832b9e234STed Kremenek   return getStateManager().getPersistentState(NewSt);
27932b9e234STed Kremenek }
28032b9e234STed Kremenek 
28149b1e38eSTed Kremenek ProgramStateRef ProgramState::assumeInBound(DefinedOrUnknownSVal Idx,
28232b9e234STed Kremenek                                       DefinedOrUnknownSVal UpperBound,
2834f870e65SAnna Zaks                                       bool Assumption,
2844f870e65SAnna Zaks                                       QualType indexTy) const {
28532b9e234STed Kremenek   if (Idx.isUnknown() || UpperBound.isUnknown())
28632b9e234STed Kremenek     return this;
28732b9e234STed Kremenek 
28832b9e234STed Kremenek   // Build an expression for 0 <= Idx < UpperBound.
28932b9e234STed Kremenek   // This is the same as Idx + MIN < UpperBound + MIN, if overflow is allowed.
29032b9e234STed Kremenek   // FIXME: This should probably be part of SValBuilder.
29132b9e234STed Kremenek   ProgramStateManager &SM = getStateManager();
29232b9e234STed Kremenek   SValBuilder &svalBuilder = SM.getSValBuilder();
29332b9e234STed Kremenek   ASTContext &Ctx = svalBuilder.getContext();
29432b9e234STed Kremenek 
29532b9e234STed Kremenek   // Get the offset: the minimum value of the array index type.
29632b9e234STed Kremenek   BasicValueFactory &BVF = svalBuilder.getBasicValueFactory();
29732b9e234STed Kremenek   // FIXME: This should be using ValueManager::ArrayindexTy...somehow.
2984f870e65SAnna Zaks   if (indexTy.isNull())
2994f870e65SAnna Zaks     indexTy = Ctx.IntTy;
30032b9e234STed Kremenek   nonloc::ConcreteInt Min(BVF.getMinValue(indexTy));
30132b9e234STed Kremenek 
30232b9e234STed Kremenek   // Adjust the index.
30332b9e234STed Kremenek   SVal newIdx = svalBuilder.evalBinOpNN(this, BO_Add,
304*2fdacbc5SDavid Blaikie                                         Idx.castAs<NonLoc>(), Min, indexTy);
30532b9e234STed Kremenek   if (newIdx.isUnknownOrUndef())
30632b9e234STed Kremenek     return this;
30732b9e234STed Kremenek 
30832b9e234STed Kremenek   // Adjust the upper bound.
30932b9e234STed Kremenek   SVal newBound =
310*2fdacbc5SDavid Blaikie     svalBuilder.evalBinOpNN(this, BO_Add, UpperBound.castAs<NonLoc>(),
31132b9e234STed Kremenek                             Min, indexTy);
31232b9e234STed Kremenek 
31332b9e234STed Kremenek   if (newBound.isUnknownOrUndef())
31432b9e234STed Kremenek     return this;
31532b9e234STed Kremenek 
31632b9e234STed Kremenek   // Build the actual comparison.
317*2fdacbc5SDavid Blaikie   SVal inBound = svalBuilder.evalBinOpNN(this, BO_LT, newIdx.castAs<NonLoc>(),
318*2fdacbc5SDavid Blaikie                                          newBound.castAs<NonLoc>(), Ctx.IntTy);
31932b9e234STed Kremenek   if (inBound.isUnknownOrUndef())
32032b9e234STed Kremenek     return this;
32132b9e234STed Kremenek 
32232b9e234STed Kremenek   // Finally, let the constraint manager take care of it.
32332b9e234STed Kremenek   ConstraintManager &CM = SM.getConstraintManager();
324*2fdacbc5SDavid Blaikie   return CM.assume(this, inBound.castAs<DefinedSVal>(), Assumption);
32532b9e234STed Kremenek }
32632b9e234STed Kremenek 
32749b1e38eSTed Kremenek ProgramStateRef ProgramStateManager::getInitialState(const LocationContext *InitLoc) {
32832b9e234STed Kremenek   ProgramState State(this,
32932b9e234STed Kremenek                 EnvMgr.getInitialEnvironment(),
33032b9e234STed Kremenek                 StoreMgr->getInitialStore(InitLoc),
33132b9e234STed Kremenek                 GDMFactory.getEmptyMap());
33232b9e234STed Kremenek 
33332b9e234STed Kremenek   return getPersistentState(State);
33432b9e234STed Kremenek }
33532b9e234STed Kremenek 
33649b1e38eSTed Kremenek ProgramStateRef ProgramStateManager::getPersistentStateWithGDM(
33749b1e38eSTed Kremenek                                                      ProgramStateRef FromState,
33849b1e38eSTed Kremenek                                                      ProgramStateRef GDMState) {
3392753ca84SArgyrios Kyrtzidis   ProgramState NewState(*FromState);
34032b9e234STed Kremenek   NewState.GDM = GDMState->GDM;
34132b9e234STed Kremenek   return getPersistentState(NewState);
34232b9e234STed Kremenek }
34332b9e234STed Kremenek 
34449b1e38eSTed Kremenek ProgramStateRef ProgramStateManager::getPersistentState(ProgramState &State) {
34532b9e234STed Kremenek 
34632b9e234STed Kremenek   llvm::FoldingSetNodeID ID;
34732b9e234STed Kremenek   State.Profile(ID);
34832b9e234STed Kremenek   void *InsertPos;
34932b9e234STed Kremenek 
35032b9e234STed Kremenek   if (ProgramState *I = StateSet.FindNodeOrInsertPos(ID, InsertPos))
35132b9e234STed Kremenek     return I;
35232b9e234STed Kremenek 
35332b9e234STed Kremenek   ProgramState *newState = 0;
35432b9e234STed Kremenek   if (!freeStates.empty()) {
35532b9e234STed Kremenek     newState = freeStates.back();
35632b9e234STed Kremenek     freeStates.pop_back();
35732b9e234STed Kremenek   }
35832b9e234STed Kremenek   else {
35932b9e234STed Kremenek     newState = (ProgramState*) Alloc.Allocate<ProgramState>();
36032b9e234STed Kremenek   }
36132b9e234STed Kremenek   new (newState) ProgramState(State);
36232b9e234STed Kremenek   StateSet.InsertNode(newState, InsertPos);
36332b9e234STed Kremenek   return newState;
36432b9e234STed Kremenek }
36532b9e234STed Kremenek 
36649b1e38eSTed Kremenek ProgramStateRef ProgramState::makeWithStore(const StoreRef &store) const {
3672753ca84SArgyrios Kyrtzidis   ProgramState NewSt(*this);
36832b9e234STed Kremenek   NewSt.setStore(store);
36932b9e234STed Kremenek   return getStateManager().getPersistentState(NewSt);
37032b9e234STed Kremenek }
37132b9e234STed Kremenek 
37232b9e234STed Kremenek void ProgramState::setStore(const StoreRef &newStore) {
37332b9e234STed Kremenek   Store newStoreStore = newStore.getStore();
37432b9e234STed Kremenek   if (newStoreStore)
37532b9e234STed Kremenek     stateMgr->getStoreManager().incrementReferenceCount(newStoreStore);
37632b9e234STed Kremenek   if (store)
37732b9e234STed Kremenek     stateMgr->getStoreManager().decrementReferenceCount(store);
37832b9e234STed Kremenek   store = newStoreStore;
37932b9e234STed Kremenek }
38032b9e234STed Kremenek 
38132b9e234STed Kremenek //===----------------------------------------------------------------------===//
38232b9e234STed Kremenek //  State pretty-printing.
38332b9e234STed Kremenek //===----------------------------------------------------------------------===//
38432b9e234STed Kremenek 
385632e3b7eSTed Kremenek void ProgramState::print(raw_ostream &Out,
38658a20d31SJordy Rose                          const char *NL, const char *Sep) const {
38732b9e234STed Kremenek   // Print the store.
38832b9e234STed Kremenek   ProgramStateManager &Mgr = getStateManager();
38958a20d31SJordy Rose   Mgr.getStoreManager().print(getStore(), Out, NL, Sep);
39032b9e234STed Kremenek 
391632e3b7eSTed Kremenek   // Print out the environment.
392632e3b7eSTed Kremenek   Env.print(Out, NL, Sep);
39332b9e234STed Kremenek 
394632e3b7eSTed Kremenek   // Print out the constraints.
39558a20d31SJordy Rose   Mgr.getConstraintManager().print(this, Out, NL, Sep);
39632b9e234STed Kremenek 
39732b9e234STed Kremenek   // Print checker-specific data.
39858a20d31SJordy Rose   Mgr.getOwningEngine()->printState(Out, this, NL, Sep);
39932b9e234STed Kremenek }
40032b9e234STed Kremenek 
401632e3b7eSTed Kremenek void ProgramState::printDOT(raw_ostream &Out) const {
402632e3b7eSTed Kremenek   print(Out, "\\l", "\\|");
403f784d08dSAnna Zaks }
404f784d08dSAnna Zaks 
405f784d08dSAnna Zaks void ProgramState::dump() const {
406632e3b7eSTed Kremenek   print(llvm::errs());
40732b9e234STed Kremenek }
40832b9e234STed Kremenek 
409282dc143SAnna Zaks void ProgramState::printTaint(raw_ostream &Out,
410282dc143SAnna Zaks                               const char *NL, const char *Sep) const {
411282dc143SAnna Zaks   TaintMapImpl TM = get<TaintMap>();
412282dc143SAnna Zaks 
413282dc143SAnna Zaks   if (!TM.isEmpty())
414282dc143SAnna Zaks     Out <<"Tainted Symbols:" << NL;
415282dc143SAnna Zaks 
416282dc143SAnna Zaks   for (TaintMapImpl::iterator I = TM.begin(), E = TM.end(); I != E; ++I) {
417282dc143SAnna Zaks     Out << I->first << " : " << I->second << NL;
418282dc143SAnna Zaks   }
419282dc143SAnna Zaks }
420282dc143SAnna Zaks 
421282dc143SAnna Zaks void ProgramState::dumpTaint() const {
422282dc143SAnna Zaks   printTaint(llvm::errs());
423282dc143SAnna Zaks }
424282dc143SAnna Zaks 
42532b9e234STed Kremenek //===----------------------------------------------------------------------===//
42632b9e234STed Kremenek // Generic Data Map.
42732b9e234STed Kremenek //===----------------------------------------------------------------------===//
42832b9e234STed Kremenek 
42932b9e234STed Kremenek void *const* ProgramState::FindGDM(void *K) const {
43032b9e234STed Kremenek   return GDM.lookup(K);
43132b9e234STed Kremenek }
43232b9e234STed Kremenek 
43332b9e234STed Kremenek void*
43432b9e234STed Kremenek ProgramStateManager::FindGDMContext(void *K,
43532b9e234STed Kremenek                                void *(*CreateContext)(llvm::BumpPtrAllocator&),
43632b9e234STed Kremenek                                void (*DeleteContext)(void*)) {
43732b9e234STed Kremenek 
43832b9e234STed Kremenek   std::pair<void*, void (*)(void*)>& p = GDMContexts[K];
43932b9e234STed Kremenek   if (!p.first) {
44032b9e234STed Kremenek     p.first = CreateContext(Alloc);
44132b9e234STed Kremenek     p.second = DeleteContext;
44232b9e234STed Kremenek   }
44332b9e234STed Kremenek 
44432b9e234STed Kremenek   return p.first;
44532b9e234STed Kremenek }
44632b9e234STed Kremenek 
44749b1e38eSTed Kremenek ProgramStateRef ProgramStateManager::addGDM(ProgramStateRef St, void *Key, void *Data){
44832b9e234STed Kremenek   ProgramState::GenericDataMap M1 = St->getGDM();
44932b9e234STed Kremenek   ProgramState::GenericDataMap M2 = GDMFactory.add(M1, Key, Data);
45032b9e234STed Kremenek 
45132b9e234STed Kremenek   if (M1 == M2)
45232b9e234STed Kremenek     return St;
45332b9e234STed Kremenek 
45432b9e234STed Kremenek   ProgramState NewSt = *St;
45532b9e234STed Kremenek   NewSt.GDM = M2;
45632b9e234STed Kremenek   return getPersistentState(NewSt);
45732b9e234STed Kremenek }
45832b9e234STed Kremenek 
45949b1e38eSTed Kremenek ProgramStateRef ProgramStateManager::removeGDM(ProgramStateRef state, void *Key) {
46032b9e234STed Kremenek   ProgramState::GenericDataMap OldM = state->getGDM();
46132b9e234STed Kremenek   ProgramState::GenericDataMap NewM = GDMFactory.remove(OldM, Key);
46232b9e234STed Kremenek 
46332b9e234STed Kremenek   if (NewM == OldM)
46432b9e234STed Kremenek     return state;
46532b9e234STed Kremenek 
46632b9e234STed Kremenek   ProgramState NewState = *state;
46732b9e234STed Kremenek   NewState.GDM = NewM;
46832b9e234STed Kremenek   return getPersistentState(NewState);
46932b9e234STed Kremenek }
47032b9e234STed Kremenek 
47132b9e234STed Kremenek bool ScanReachableSymbols::scan(nonloc::CompoundVal val) {
47232b9e234STed Kremenek   for (nonloc::CompoundVal::iterator I=val.begin(), E=val.end(); I!=E; ++I)
47332b9e234STed Kremenek     if (!scan(*I))
47432b9e234STed Kremenek       return false;
47532b9e234STed Kremenek 
47632b9e234STed Kremenek   return true;
47732b9e234STed Kremenek }
47832b9e234STed Kremenek 
47932b9e234STed Kremenek bool ScanReachableSymbols::scan(const SymExpr *sym) {
48032b9e234STed Kremenek   unsigned &isVisited = visited[sym];
48132b9e234STed Kremenek   if (isVisited)
48232b9e234STed Kremenek     return true;
48332b9e234STed Kremenek   isVisited = 1;
48432b9e234STed Kremenek 
485a636fbe7SAnna Zaks   if (!visitor.VisitSymbol(sym))
48632b9e234STed Kremenek     return false;
48732b9e234STed Kremenek 
48852fb9c08SAnna Zaks   // TODO: should be rewritten using SymExpr::symbol_iterator.
48932b9e234STed Kremenek   switch (sym->getKind()) {
49032b9e234STed Kremenek     case SymExpr::RegionValueKind:
49132b9e234STed Kremenek     case SymExpr::ConjuredKind:
49232b9e234STed Kremenek     case SymExpr::DerivedKind:
49332b9e234STed Kremenek     case SymExpr::ExtentKind:
49432b9e234STed Kremenek     case SymExpr::MetadataKind:
49532b9e234STed Kremenek       break;
496c25efcccSAnna Zaks     case SymExpr::CastSymbolKind:
497c25efcccSAnna Zaks       return scan(cast<SymbolCast>(sym)->getOperand());
49832b9e234STed Kremenek     case SymExpr::SymIntKind:
49932b9e234STed Kremenek       return scan(cast<SymIntExpr>(sym)->getLHS());
500ecd73008SAnna Zaks     case SymExpr::IntSymKind:
501ecd73008SAnna Zaks       return scan(cast<IntSymExpr>(sym)->getRHS());
50232b9e234STed Kremenek     case SymExpr::SymSymKind: {
50332b9e234STed Kremenek       const SymSymExpr *x = cast<SymSymExpr>(sym);
50432b9e234STed Kremenek       return scan(x->getLHS()) && scan(x->getRHS());
50532b9e234STed Kremenek     }
50632b9e234STed Kremenek   }
50732b9e234STed Kremenek   return true;
50832b9e234STed Kremenek }
50932b9e234STed Kremenek 
51032b9e234STed Kremenek bool ScanReachableSymbols::scan(SVal val) {
511*2fdacbc5SDavid Blaikie   if (llvm::Optional<loc::MemRegionVal> X = val.getAs<loc::MemRegionVal>())
51232b9e234STed Kremenek     return scan(X->getRegion());
51332b9e234STed Kremenek 
514*2fdacbc5SDavid Blaikie   if (llvm::Optional<nonloc::LazyCompoundVal> X =
515*2fdacbc5SDavid Blaikie           val.getAs<nonloc::LazyCompoundVal>()) {
5163dc0509eSJordan Rose     StoreManager &StoreMgr = state->getStateManager().getStoreManager();
5173dc0509eSJordan Rose     // FIXME: We don't really want to use getBaseRegion() here because pointer
5183dc0509eSJordan Rose     // arithmetic doesn't apply, but scanReachableSymbols only accepts base
5193dc0509eSJordan Rose     // regions right now.
5203dc0509eSJordan Rose     if (!StoreMgr.scanReachableSymbols(X->getStore(),
5213dc0509eSJordan Rose                                        X->getRegion()->getBaseRegion(),
5223dc0509eSJordan Rose                                        *this))
5233dc0509eSJordan Rose       return false;
5243dc0509eSJordan Rose   }
525356279caSJordan Rose 
526*2fdacbc5SDavid Blaikie   if (llvm::Optional<nonloc::LocAsInteger> X =
527*2fdacbc5SDavid Blaikie           val.getAs<nonloc::LocAsInteger>())
52832b9e234STed Kremenek     return scan(X->getLoc());
52932b9e234STed Kremenek 
53032b9e234STed Kremenek   if (SymbolRef Sym = val.getAsSymbol())
53132b9e234STed Kremenek     return scan(Sym);
53232b9e234STed Kremenek 
53332b9e234STed Kremenek   if (const SymExpr *Sym = val.getAsSymbolicExpression())
53432b9e234STed Kremenek     return scan(Sym);
53532b9e234STed Kremenek 
536*2fdacbc5SDavid Blaikie   if (llvm::Optional<nonloc::CompoundVal> X = val.getAs<nonloc::CompoundVal>())
53732b9e234STed Kremenek     return scan(*X);
53832b9e234STed Kremenek 
53932b9e234STed Kremenek   return true;
54032b9e234STed Kremenek }
54132b9e234STed Kremenek 
54232b9e234STed Kremenek bool ScanReachableSymbols::scan(const MemRegion *R) {
54332b9e234STed Kremenek   if (isa<MemSpaceRegion>(R))
54432b9e234STed Kremenek     return true;
54532b9e234STed Kremenek 
54632b9e234STed Kremenek   unsigned &isVisited = visited[R];
54732b9e234STed Kremenek   if (isVisited)
54832b9e234STed Kremenek     return true;
54932b9e234STed Kremenek   isVisited = 1;
550b14b42d4STed Kremenek 
551b14b42d4STed Kremenek 
552b14b42d4STed Kremenek   if (!visitor.VisitMemRegion(R))
553b14b42d4STed Kremenek     return false;
55432b9e234STed Kremenek 
55532b9e234STed Kremenek   // If this is a symbolic region, visit the symbol for the region.
55632b9e234STed Kremenek   if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(R))
55732b9e234STed Kremenek     if (!visitor.VisitSymbol(SR->getSymbol()))
55832b9e234STed Kremenek       return false;
55932b9e234STed Kremenek 
56032b9e234STed Kremenek   // If this is a subregion, also visit the parent regions.
5613a80cec5SJordan Rose   if (const SubRegion *SR = dyn_cast<SubRegion>(R)) {
5623a80cec5SJordan Rose     const MemRegion *Super = SR->getSuperRegion();
5633a80cec5SJordan Rose     if (!scan(Super))
56432b9e234STed Kremenek       return false;
56532b9e234STed Kremenek 
5663a80cec5SJordan Rose     // When we reach the topmost region, scan all symbols in it.
5673a80cec5SJordan Rose     if (isa<MemSpaceRegion>(Super)) {
5683a80cec5SJordan Rose       StoreManager &StoreMgr = state->getStateManager().getStoreManager();
5693a80cec5SJordan Rose       if (!StoreMgr.scanReachableSymbols(state->getStore(), SR, *this))
5703a80cec5SJordan Rose         return false;
5713a80cec5SJordan Rose     }
5723a80cec5SJordan Rose   }
5733a80cec5SJordan Rose 
574c3da376fSTed Kremenek   // Regions captured by a block are also implicitly reachable.
575c3da376fSTed Kremenek   if (const BlockDataRegion *BDR = dyn_cast<BlockDataRegion>(R)) {
576c3da376fSTed Kremenek     BlockDataRegion::referenced_vars_iterator I = BDR->referenced_vars_begin(),
577c3da376fSTed Kremenek                                               E = BDR->referenced_vars_end();
578c3da376fSTed Kremenek     for ( ; I != E; ++I) {
579c3da376fSTed Kremenek       if (!scan(I.getCapturedRegion()))
580c3da376fSTed Kremenek         return false;
581c3da376fSTed Kremenek     }
582c3da376fSTed Kremenek   }
583c3da376fSTed Kremenek 
5843a80cec5SJordan Rose   return true;
58532b9e234STed Kremenek }
58632b9e234STed Kremenek 
58732b9e234STed Kremenek bool ProgramState::scanReachableSymbols(SVal val, SymbolVisitor& visitor) const {
58832b9e234STed Kremenek   ScanReachableSymbols S(this, visitor);
58932b9e234STed Kremenek   return S.scan(val);
59032b9e234STed Kremenek }
59132b9e234STed Kremenek 
59232b9e234STed Kremenek bool ProgramState::scanReachableSymbols(const SVal *I, const SVal *E,
59332b9e234STed Kremenek                                    SymbolVisitor &visitor) const {
59432b9e234STed Kremenek   ScanReachableSymbols S(this, visitor);
59532b9e234STed Kremenek   for ( ; I != E; ++I) {
59632b9e234STed Kremenek     if (!S.scan(*I))
59732b9e234STed Kremenek       return false;
59832b9e234STed Kremenek   }
59932b9e234STed Kremenek   return true;
60032b9e234STed Kremenek }
60132b9e234STed Kremenek 
60232b9e234STed Kremenek bool ProgramState::scanReachableSymbols(const MemRegion * const *I,
60332b9e234STed Kremenek                                    const MemRegion * const *E,
60432b9e234STed Kremenek                                    SymbolVisitor &visitor) const {
60532b9e234STed Kremenek   ScanReachableSymbols S(this, visitor);
60632b9e234STed Kremenek   for ( ; I != E; ++I) {
60732b9e234STed Kremenek     if (!S.scan(*I))
60832b9e234STed Kremenek       return false;
60932b9e234STed Kremenek   }
61032b9e234STed Kremenek   return true;
61132b9e234STed Kremenek }
612ec7dc5c1SAnna Zaks 
61349b1e38eSTed Kremenek ProgramStateRef ProgramState::addTaint(const Stmt *S,
614632e3b7eSTed Kremenek                                            const LocationContext *LCtx,
615ec7dc5c1SAnna Zaks                                            TaintTagType Kind) const {
616e48ee503SAnna Zaks   if (const Expr *E = dyn_cast_or_null<Expr>(S))
617e48ee503SAnna Zaks     S = E->IgnoreParens();
618e48ee503SAnna Zaks 
619632e3b7eSTed Kremenek   SymbolRef Sym = getSVal(S, LCtx).getAsSymbol();
620d6bb3227SAnna Zaks   if (Sym)
621ec7dc5c1SAnna Zaks     return addTaint(Sym, Kind);
622d6bb3227SAnna Zaks 
623632e3b7eSTed Kremenek   const MemRegion *R = getSVal(S, LCtx).getAsRegion();
62404b57c25SAnna Zaks   addTaint(R, Kind);
625d6bb3227SAnna Zaks 
626d6bb3227SAnna Zaks   // Cannot add taint, so just return the state.
627d6bb3227SAnna Zaks   return this;
628ec7dc5c1SAnna Zaks }
629ec7dc5c1SAnna Zaks 
63049b1e38eSTed Kremenek ProgramStateRef ProgramState::addTaint(const MemRegion *R,
63104b57c25SAnna Zaks                                            TaintTagType Kind) const {
63204b57c25SAnna Zaks   if (const SymbolicRegion *SR = dyn_cast_or_null<SymbolicRegion>(R))
63304b57c25SAnna Zaks     return addTaint(SR->getSymbol(), Kind);
63404b57c25SAnna Zaks   return this;
63504b57c25SAnna Zaks }
63604b57c25SAnna Zaks 
63749b1e38eSTed Kremenek ProgramStateRef ProgramState::addTaint(SymbolRef Sym,
638ec7dc5c1SAnna Zaks                                            TaintTagType Kind) const {
639282dc143SAnna Zaks   // If this is a symbol cast, remove the cast before adding the taint. Taint
640282dc143SAnna Zaks   // is cast agnostic.
641282dc143SAnna Zaks   while (const SymbolCast *SC = dyn_cast<SymbolCast>(Sym))
642282dc143SAnna Zaks     Sym = SC->getOperand();
643282dc143SAnna Zaks 
64449b1e38eSTed Kremenek   ProgramStateRef NewState = set<TaintMap>(Sym, Kind);
645ec7dc5c1SAnna Zaks   assert(NewState);
646ec7dc5c1SAnna Zaks   return NewState;
647ec7dc5c1SAnna Zaks }
648ec7dc5c1SAnna Zaks 
649632e3b7eSTed Kremenek bool ProgramState::isTainted(const Stmt *S, const LocationContext *LCtx,
650632e3b7eSTed Kremenek                              TaintTagType Kind) const {
651e48ee503SAnna Zaks   if (const Expr *E = dyn_cast_or_null<Expr>(S))
652e48ee503SAnna Zaks     S = E->IgnoreParens();
653e48ee503SAnna Zaks 
654632e3b7eSTed Kremenek   SVal val = getSVal(S, LCtx);
6559da86ce8SAnna Zaks   return isTainted(val, Kind);
656ec7dc5c1SAnna Zaks }
657ec7dc5c1SAnna Zaks 
658ec7dc5c1SAnna Zaks bool ProgramState::isTainted(SVal V, TaintTagType Kind) const {
659b86fdbe7SAnna Zaks   if (const SymExpr *Sym = V.getAsSymExpr())
660b86fdbe7SAnna Zaks     return isTainted(Sym, Kind);
6619de45554SAnna Zaks   if (const MemRegion *Reg = V.getAsRegion())
6629de45554SAnna Zaks     return isTainted(Reg, Kind);
663b86fdbe7SAnna Zaks   return false;
664b86fdbe7SAnna Zaks }
665b86fdbe7SAnna Zaks 
666b86fdbe7SAnna Zaks bool ProgramState::isTainted(const MemRegion *Reg, TaintTagType K) const {
667b86fdbe7SAnna Zaks   if (!Reg)
668b86fdbe7SAnna Zaks     return false;
669b86fdbe7SAnna Zaks 
670b86fdbe7SAnna Zaks   // Element region (array element) is tainted if either the base or the offset
671b86fdbe7SAnna Zaks   // are tainted.
672b86fdbe7SAnna Zaks   if (const ElementRegion *ER = dyn_cast<ElementRegion>(Reg))
673b86fdbe7SAnna Zaks     return isTainted(ER->getSuperRegion(), K) || isTainted(ER->getIndex(), K);
674b86fdbe7SAnna Zaks 
675b86fdbe7SAnna Zaks   if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(Reg))
676b86fdbe7SAnna Zaks     return isTainted(SR->getSymbol(), K);
677b86fdbe7SAnna Zaks 
678b86fdbe7SAnna Zaks   if (const SubRegion *ER = dyn_cast<SubRegion>(Reg))
679b86fdbe7SAnna Zaks     return isTainted(ER->getSuperRegion(), K);
680b86fdbe7SAnna Zaks 
681b86fdbe7SAnna Zaks   return false;
682ec7dc5c1SAnna Zaks }
683ec7dc5c1SAnna Zaks 
684126a2ef9SAnna Zaks bool ProgramState::isTainted(SymbolRef Sym, TaintTagType Kind) const {
68589c00c9dSAnna Zaks   if (!Sym)
68689c00c9dSAnna Zaks     return false;
68789c00c9dSAnna Zaks 
688b86fdbe7SAnna Zaks   // Traverse all the symbols this symbol depends on to see if any are tainted.
689ee1a4353SAnna Zaks   bool Tainted = false;
690ee1a4353SAnna Zaks   for (SymExpr::symbol_iterator SI = Sym->symbol_begin(), SE =Sym->symbol_end();
691ee1a4353SAnna Zaks        SI != SE; ++SI) {
692db72e2fcSJordan Rose     if (!isa<SymbolData>(*SI))
693db72e2fcSJordan Rose       continue;
694db72e2fcSJordan Rose 
695ee1a4353SAnna Zaks     const TaintTagType *Tag = get<TaintMap>(*SI);
696ee1a4353SAnna Zaks     Tainted = (Tag && *Tag == Kind);
697c25efcccSAnna Zaks 
698ee1a4353SAnna Zaks     // If this is a SymbolDerived with a tainted parent, it's also tainted.
699ee1a4353SAnna Zaks     if (const SymbolDerived *SD = dyn_cast<SymbolDerived>(*SI))
700ee1a4353SAnna Zaks       Tainted = Tainted || isTainted(SD->getParentSymbol(), Kind);
701394256ccSAnna Zaks 
702394256ccSAnna Zaks     // If memory region is tainted, data is also tainted.
703394256ccSAnna Zaks     if (const SymbolRegionValue *SRV = dyn_cast<SymbolRegionValue>(*SI))
704394256ccSAnna Zaks       Tainted = Tainted || isTainted(SRV->getRegion(), Kind);
705394256ccSAnna Zaks 
706282dc143SAnna Zaks     // If If this is a SymbolCast from a tainted value, it's also tainted.
707282dc143SAnna Zaks     if (const SymbolCast *SC = dyn_cast<SymbolCast>(*SI))
708282dc143SAnna Zaks       Tainted = Tainted || isTainted(SC->getOperand(), Kind);
709282dc143SAnna Zaks 
710ee1a4353SAnna Zaks     if (Tainted)
711ee1a4353SAnna Zaks       return true;
712ec7dc5c1SAnna Zaks   }
713ec7dc5c1SAnna Zaks 
714ee1a4353SAnna Zaks   return Tainted;
715ec7dc5c1SAnna Zaks }
71663282aefSAnna Zaks 
717150843b8SAnna Zaks /// The GDM component containing the dynamic type info. This is a map from a
7180c153cb2SJordan Rose /// symbol to its most likely type.
719520a30fdSJordan Rose REGISTER_TRAIT_WITH_PROGRAMSTATE(DynamicTypeMap,
720520a30fdSJordan Rose                                  CLANG_ENTO_PROGRAMSTATE_MAP(const MemRegion *,
721520a30fdSJordan Rose                                                              DynamicTypeInfo))
722150843b8SAnna Zaks 
72363282aefSAnna Zaks DynamicTypeInfo ProgramState::getDynamicTypeInfo(const MemRegion *Reg) const {
7240f6d63beSJordan Rose   Reg = Reg->StripCasts();
7250f6d63beSJordan Rose 
726150843b8SAnna Zaks   // Look up the dynamic type in the GDM.
727e521f932SJordan Rose   const DynamicTypeInfo *GDMType = get<DynamicTypeMap>(Reg);
728150843b8SAnna Zaks   if (GDMType)
729150843b8SAnna Zaks     return *GDMType;
730150843b8SAnna Zaks 
731e521f932SJordan Rose   // Otherwise, fall back to what we know about the region.
7320f6d63beSJordan Rose   if (const TypedRegion *TR = dyn_cast<TypedRegion>(Reg))
7330f6d63beSJordan Rose     return DynamicTypeInfo(TR->getLocationType(), /*CanBeSubclass=*/false);
734e521f932SJordan Rose 
735e521f932SJordan Rose   if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(Reg)) {
736e521f932SJordan Rose     SymbolRef Sym = SR->getSymbol();
737a808e165STed Kremenek     return DynamicTypeInfo(Sym->getType());
738150843b8SAnna Zaks   }
739e521f932SJordan Rose 
74063282aefSAnna Zaks   return DynamicTypeInfo();
74163282aefSAnna Zaks }
742150843b8SAnna Zaks 
743a0105b23SAnna Zaks ProgramStateRef ProgramState::setDynamicTypeInfo(const MemRegion *Reg,
744472dbcf1SAnna Zaks                                                  DynamicTypeInfo NewTy) const {
7450f6d63beSJordan Rose   Reg = Reg->StripCasts();
746e521f932SJordan Rose   ProgramStateRef NewState = set<DynamicTypeMap>(Reg, NewTy);
747150843b8SAnna Zaks   assert(NewState);
748150843b8SAnna Zaks   return NewState;
749150843b8SAnna Zaks }
750