blob: 3282664cdab77e2ac1a4a056d787966e07d68c86 [file] [log] [blame]
Ted Kremenek53ba0b62009-06-24 23:06:47 +00001//= GRState.cpp - Path-Sensitive "State" for tracking values -----*- C++ -*--=//
Ted Kremenek9153f732008-02-05 07:17:49 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
Ted Kremenek53ba0b62009-06-24 23:06:47 +000010// This file implements GRState and GRStateManager.
Ted Kremenek9153f732008-02-05 07:17:49 +000011//
12//===----------------------------------------------------------------------===//
13
Benjamin Kramer5e2d2c22010-03-27 21:19:47 +000014#include "clang/Analysis/CFG.h"
Ted Kremenek1309f9a2010-01-25 04:41:41 +000015#include "clang/Checker/PathSensitive/GRStateTrait.h"
16#include "clang/Checker/PathSensitive/GRState.h"
Jordy Rose52082af2010-08-15 22:19:33 +000017#include "clang/Checker/PathSensitive/GRSubEngine.h"
Ted Kremenek1309f9a2010-01-25 04:41:41 +000018#include "clang/Checker/PathSensitive/GRTransferFuncs.h"
Chris Lattner405674c2008-08-23 22:23:37 +000019#include "llvm/Support/raw_ostream.h"
Ted Kremenek05125f12008-08-27 23:13:01 +000020
Ted Kremenekf66ea2cd2008-02-04 21:59:22 +000021using namespace clang;
22
Ted Kremenek05125f12008-08-27 23:13:01 +000023// Give the vtable for ConstraintManager somewhere to live.
Ted Kremenek53ba0b62009-06-24 23:06:47 +000024// FIXME: Move this elsewhere.
Ted Kremenek05125f12008-08-27 23:13:01 +000025ConstraintManager::~ConstraintManager() {}
26
Ted Kremenek1c72ef02008-08-16 00:49:49 +000027GRStateManager::~GRStateManager() {
28 for (std::vector<GRState::Printer*>::iterator I=Printers.begin(),
29 E=Printers.end(); I!=E; ++I)
30 delete *I;
Mike Stump1eb44332009-09-09 15:08:12 +000031
Ted Kremenek1c72ef02008-08-16 00:49:49 +000032 for (GDMContextsTy::iterator I=GDMContexts.begin(), E=GDMContexts.end();
33 I!=E; ++I)
34 I->second.second(I->second.first);
35}
36
Ted Kremenek4adc81e2008-08-13 04:27:00 +000037const GRState*
Jordy Rose7dadf792010-07-01 20:09:55 +000038GRStateManager::RemoveDeadBindings(const GRState* state,
Zhongxing Xu17ddf1c2010-03-17 03:35:08 +000039 const StackFrameContext *LCtx,
Ted Kremenek241677a2009-01-21 22:26:05 +000040 SymbolReaper& SymReaper) {
41
Ted Kremenekb87d9092008-02-08 19:17:19 +000042 // This code essentially performs a "mark-and-sweep" of the VariableBindings.
43 // The roots are any Block-level exprs and Decls that our liveness algorithm
44 // tells us are live. We then see what Decls they may reference, and keep
45 // those around. This code more than likely can be made faster, and the
46 // frequency of which this method is called should be experimented with
Ted Kremenek9e240492008-10-04 05:50:14 +000047 // for optimum performance.
48 llvm::SmallVector<const MemRegion*, 10> RegionRoots;
Ted Kremenek2ed14be2008-12-05 00:47:52 +000049 GRState NewState = *state;
Ted Kremenekf59bf482008-07-17 18:38:48 +000050
Jordy Rose7dadf792010-07-01 20:09:55 +000051 NewState.Env = EnvMgr.RemoveDeadBindings(NewState.Env, SymReaper,
Ted Kremenek5dc27462009-03-03 02:51:43 +000052 state, RegionRoots);
Ted Kremenek016f52f2008-02-08 21:10:02 +000053
Ted Kremenekf59bf482008-07-17 18:38:48 +000054 // Clean up the store.
Zhongxing Xu5e4cb342010-08-15 12:45:09 +000055 NewState.St = StoreMgr->RemoveDeadBindings(NewState.St, LCtx,
56 SymReaper, RegionRoots);
57 state = getPersistentState(NewState);
58 return ConstraintMgr->RemoveDeadBindings(state, SymReaper);
Ted Kremenekb87d9092008-02-08 19:17:19 +000059}
Ted Kremenek862d5bb2008-02-06 00:54:14 +000060
Zhongxing Xu2ce43c82010-07-22 13:52:13 +000061const GRState *GRStateManager::MarshalState(const GRState *state,
Zhongxing Xud5ef7b22010-07-23 05:55:01 +000062 const StackFrameContext *InitLoc) {
Zhongxing Xu2ce43c82010-07-22 13:52:13 +000063 // make up an empty state for now.
64 GRState State(this,
65 EnvMgr.getInitialEnvironment(),
66 StoreMgr->getInitialStore(InitLoc),
Ted Kremenek3baf6722010-11-24 00:54:37 +000067 GDMFactory.getEmptyMap());
Zhongxing Xu2ce43c82010-07-22 13:52:13 +000068
69 return getPersistentState(State);
70}
71
Jordy Rose52082af2010-08-15 22:19:33 +000072const GRState *GRState::bindCompoundLiteral(const CompoundLiteralExpr* CL,
73 const LocationContext *LC,
74 SVal V) const {
75 Store new_store =
76 getStateManager().StoreMgr->BindCompoundLiteral(St, CL, LC, V);
77 return makeWithStore(new_store);
78}
79
80const GRState *GRState::bindDecl(const VarRegion* VR, SVal IVal) const {
81 Store new_store = getStateManager().StoreMgr->BindDecl(St, VR, IVal);
82 return makeWithStore(new_store);
83}
84
85const GRState *GRState::bindDeclWithNoInit(const VarRegion* VR) const {
86 Store new_store = getStateManager().StoreMgr->BindDeclWithNoInit(St, VR);
87 return makeWithStore(new_store);
88}
89
90const GRState *GRState::bindLoc(Loc LV, SVal V) const {
91 GRStateManager &Mgr = getStateManager();
92 Store new_store = Mgr.StoreMgr->Bind(St, LV, V);
93 const GRState *new_state = makeWithStore(new_store);
94
95 const MemRegion *MR = LV.getAsRegion();
96 if (MR)
97 return Mgr.getOwningEngine().ProcessRegionChange(new_state, MR);
98
99 return new_state;
100}
101
102const GRState *GRState::bindDefault(SVal loc, SVal V) const {
103 GRStateManager &Mgr = getStateManager();
104 const MemRegion *R = cast<loc::MemRegionVal>(loc).getRegion();
105 Store new_store = Mgr.StoreMgr->BindDefault(St, R, V);
106 const GRState *new_state = makeWithStore(new_store);
107 return Mgr.getOwningEngine().ProcessRegionChange(new_state, R);
108}
109
110const GRState *GRState::InvalidateRegions(const MemRegion * const *Begin,
111 const MemRegion * const *End,
112 const Expr *E, unsigned Count,
113 StoreManager::InvalidatedSymbols *IS,
114 bool invalidateGlobals) const {
115 GRStateManager &Mgr = getStateManager();
116 GRSubEngine &Eng = Mgr.getOwningEngine();
117
118 if (Eng.WantsRegionChangeUpdate(this)) {
119 StoreManager::InvalidatedRegions Regions;
120
121 Store new_store = Mgr.StoreMgr->InvalidateRegions(St, Begin, End,
122 E, Count, IS,
123 invalidateGlobals,
124 &Regions);
125 const GRState *new_state = makeWithStore(new_store);
126
127 return Eng.ProcessRegionChanges(new_state,
128 &Regions.front(),
129 &Regions.back()+1);
130 }
131
132 Store new_store = Mgr.StoreMgr->InvalidateRegions(St, Begin, End,
133 E, Count, IS,
134 invalidateGlobals,
135 NULL);
136 return makeWithStore(new_store);
137}
138
Ted Kremenek76500d02009-06-23 20:38:51 +0000139const GRState *GRState::unbindLoc(Loc LV) const {
Jordy Rosea9c76212010-08-05 03:33:56 +0000140 assert(!isa<loc::MemRegionVal>(LV) && "Use InvalidateRegion instead.");
141
Ted Kremenek76500d02009-06-23 20:38:51 +0000142 Store OldStore = getStore();
Ted Kremenek0fb0bc42009-08-27 01:39:13 +0000143 Store NewStore = getStateManager().StoreMgr->Remove(OldStore, LV);
Mike Stump1eb44332009-09-09 15:08:12 +0000144
Ted Kremenek4323a572008-07-10 22:03:41 +0000145 if (NewStore == OldStore)
Ted Kremenek76500d02009-06-23 20:38:51 +0000146 return this;
Mike Stump1eb44332009-09-09 15:08:12 +0000147
Jordy Rosea9c76212010-08-05 03:33:56 +0000148 return makeWithStore(NewStore);
Ted Kremenek4323a572008-07-10 22:03:41 +0000149}
150
Jordy Rose52082af2010-08-15 22:19:33 +0000151const GRState *GRState::EnterStackFrame(const StackFrameContext *frame) const {
152 Store new_store = getStateManager().StoreMgr->EnterStackFrame(this, frame);
153 return makeWithStore(new_store);
154}
155
Ted Kremenek13976632010-02-08 16:18:51 +0000156SVal GRState::getSValAsScalarOrLoc(const MemRegion *R) const {
Ted Kremenek233e9132009-06-24 22:15:30 +0000157 // We only want to do fetches from regions that we can actually bind
158 // values. For example, SymbolicRegions of type 'id<...>' cannot
159 // have direct bindings (but their can be bindings on their subregions).
160 if (!R->isBoundable())
161 return UnknownVal();
162
163 if (const TypedRegion *TR = dyn_cast<TypedRegion>(R)) {
Zhongxing Xu018220c2010-08-11 06:10:55 +0000164 QualType T = TR->getValueType();
Ted Kremenek233e9132009-06-24 22:15:30 +0000165 if (Loc::IsLocType(T) || T->isIntegerType())
Ted Kremenek13976632010-02-08 16:18:51 +0000166 return getSVal(R);
Ted Kremenek233e9132009-06-24 22:15:30 +0000167 }
168
169 return UnknownVal();
170}
171
Ted Kremenek96ebad62010-09-09 07:13:00 +0000172SVal GRState::getSVal(Loc location, QualType T) const {
173 SVal V = getRawSVal(cast<Loc>(location), T);
174
Ted Kremenek124f5d52010-09-03 01:06:58 +0000175 // If 'V' is a symbolic value that is *perfectly* constrained to
176 // be a constant value, use that value instead to lessen the burden
177 // on later analysis stages (so we have less symbolic values to reason
178 // about).
179 if (!T.isNull()) {
180 if (SymbolRef sym = V.getAsSymbol()) {
181 if (const llvm::APSInt *Int = getSymVal(sym)) {
182 // FIXME: Because we don't correctly model (yet) sign-extension
183 // and truncation of symbolic values, we need to convert
184 // the integer value to the correct signedness and bitwidth.
185 //
186 // This shows up in the following:
187 //
188 // char foo();
189 // unsigned x = foo();
190 // if (x == 54)
191 // ...
192 //
193 // The symbolic value stored to 'x' is actually the conjured
194 // symbol for the call to foo(); the type of that symbol is 'char',
195 // not unsigned.
196 const llvm::APSInt &NewV = getBasicVals().Convert(T, *Int);
197
198 if (isa<Loc>(V))
199 return loc::ConcreteInt(NewV);
200 else
201 return nonloc::ConcreteInt(NewV);
202 }
203 }
204 }
205
206 return V;
207}
Ted Kremenek4f596c22009-06-27 00:24:54 +0000208
Ted Kremenek6d4c0222010-09-03 01:07:02 +0000209const GRState *GRState::BindExpr(const Stmt* S, SVal V, bool Invalidate) const{
210 Environment NewEnv = getStateManager().EnvMgr.bindExpr(Env, S, V,
Mike Stump1eb44332009-09-09 15:08:12 +0000211 Invalidate);
Ted Kremenek4f596c22009-06-27 00:24:54 +0000212 if (NewEnv == Env)
213 return this;
Ted Kremenek6d2c6572009-08-27 22:15:20 +0000214
Ted Kremenek4f596c22009-06-27 00:24:54 +0000215 GRState NewSt = *this;
216 NewSt.Env = NewEnv;
Ted Kremenek0fb0bc42009-08-27 01:39:13 +0000217 return getStateManager().getPersistentState(NewSt);
Ted Kremenek4f596c22009-06-27 00:24:54 +0000218}
219
Ted Kremenek6d4c0222010-09-03 01:07:02 +0000220const GRState *GRState::bindExprAndLocation(const Stmt *S, SVal location,
221 SVal V) const {
222 Environment NewEnv =
223 getStateManager().EnvMgr.bindExprAndLocation(Env, S, location, V);
224
225 if (NewEnv == Env)
226 return this;
227
228 GRState NewSt = *this;
229 NewSt.Env = NewEnv;
230 return getStateManager().getPersistentState(NewSt);
231}
232
Ted Kremenek28f47b92010-12-01 22:16:56 +0000233const GRState *GRState::assumeInBound(DefinedOrUnknownSVal Idx,
Jordy Rose1802eeb2010-08-16 20:34:06 +0000234 DefinedOrUnknownSVal UpperBound,
235 bool Assumption) const {
236 if (Idx.isUnknown() || UpperBound.isUnknown())
237 return this;
238
239 // Build an expression for 0 <= Idx < UpperBound.
240 // This is the same as Idx + MIN < UpperBound + MIN, if overflow is allowed.
Ted Kremenek846eabd2010-12-01 21:28:31 +0000241 // FIXME: This should probably be part of SValBuilder.
Jordy Rose1802eeb2010-08-16 20:34:06 +0000242 GRStateManager &SM = getStateManager();
Ted Kremenekc8413fd2010-12-02 07:49:45 +0000243 SValBuilder &svalBuilder = SM.getSValBuilder();
244 ASTContext &Ctx = svalBuilder.getContext();
Jordy Rose1802eeb2010-08-16 20:34:06 +0000245
246 // Get the offset: the minimum value of the array index type.
Ted Kremenekc8413fd2010-12-02 07:49:45 +0000247 BasicValueFactory &BVF = svalBuilder.getBasicValueFactory();
248 // FIXME: This should be using ValueManager::ArrayindexTy...somehow.
249 QualType indexTy = Ctx.IntTy;
Ted Kremenek0074b482010-12-05 23:36:20 +0000250 nonloc::ConcreteInt Min(BVF.getMinValue(indexTy));
Jordy Rose1802eeb2010-08-16 20:34:06 +0000251
252 // Adjust the index.
Ted Kremenekc8413fd2010-12-02 07:49:45 +0000253 SVal newIdx = svalBuilder.evalBinOpNN(this, BO_Add,
254 cast<NonLoc>(Idx), Min, indexTy);
Ted Kremenek9c149532010-12-01 21:57:22 +0000255 if (newIdx.isUnknownOrUndef())
Jordy Rose1802eeb2010-08-16 20:34:06 +0000256 return this;
257
258 // Adjust the upper bound.
Ted Kremenekc8413fd2010-12-02 07:49:45 +0000259 SVal newBound =
260 svalBuilder.evalBinOpNN(this, BO_Add, cast<NonLoc>(UpperBound),
261 Min, indexTy);
262
263 if (newBound.isUnknownOrUndef())
Jordy Rose1802eeb2010-08-16 20:34:06 +0000264 return this;
265
266 // Build the actual comparison.
Ted Kremenekc8413fd2010-12-02 07:49:45 +0000267 SVal inBound = svalBuilder.evalBinOpNN(this, BO_LT,
268 cast<NonLoc>(newIdx), cast<NonLoc>(newBound),
Jordy Rose1802eeb2010-08-16 20:34:06 +0000269 Ctx.IntTy);
Ted Kremenek9c149532010-12-01 21:57:22 +0000270 if (inBound.isUnknownOrUndef())
Jordy Rose1802eeb2010-08-16 20:34:06 +0000271 return this;
272
273 // Finally, let the constraint manager take care of it.
274 ConstraintManager &CM = SM.getConstraintManager();
Ted Kremenek28f47b92010-12-01 22:16:56 +0000275 return CM.assume(this, cast<DefinedSVal>(inBound), Assumption);
Jordy Rose1802eeb2010-08-16 20:34:06 +0000276}
277
Zhongxing Xu17fd8632009-08-17 06:19:58 +0000278const GRState* GRStateManager::getInitialState(const LocationContext *InitLoc) {
Ted Kremenek6d2c6572009-08-27 22:15:20 +0000279 GRState State(this,
Zhongxing Xuc179a7f2010-03-05 04:45:36 +0000280 EnvMgr.getInitialEnvironment(),
Zhongxing Xu17fd8632009-08-17 06:19:58 +0000281 StoreMgr->getInitialStore(InitLoc),
Ted Kremenek3baf6722010-11-24 00:54:37 +0000282 GDMFactory.getEmptyMap());
Ted Kremenekcaa37242008-08-19 16:51:45 +0000283
Zhongxing Xu17fd8632009-08-17 06:19:58 +0000284 return getPersistentState(State);
Ted Kremenek9153f732008-02-05 07:17:49 +0000285}
286
Ted Kremenek4adc81e2008-08-13 04:27:00 +0000287const GRState* GRStateManager::getPersistentState(GRState& State) {
Mike Stump1eb44332009-09-09 15:08:12 +0000288
Ted Kremenek9153f732008-02-05 07:17:49 +0000289 llvm::FoldingSetNodeID ID;
Mike Stump1eb44332009-09-09 15:08:12 +0000290 State.Profile(ID);
Ted Kremeneke7d22112008-02-11 19:21:59 +0000291 void* InsertPos;
Mike Stump1eb44332009-09-09 15:08:12 +0000292
Ted Kremenek4adc81e2008-08-13 04:27:00 +0000293 if (GRState* I = StateSet.FindNodeOrInsertPos(ID, InsertPos))
Ted Kremenek9153f732008-02-05 07:17:49 +0000294 return I;
Mike Stump1eb44332009-09-09 15:08:12 +0000295
Ted Kremenek4adc81e2008-08-13 04:27:00 +0000296 GRState* I = (GRState*) Alloc.Allocate<GRState>();
Mike Stump1eb44332009-09-09 15:08:12 +0000297 new (I) GRState(State);
Ted Kremenek9153f732008-02-05 07:17:49 +0000298 StateSet.InsertNode(I, InsertPos);
299 return I;
300}
Ted Kremeneke7d22112008-02-11 19:21:59 +0000301
Ted Kremenek67f28532009-06-17 22:02:04 +0000302const GRState* GRState::makeWithStore(Store store) const {
303 GRState NewSt = *this;
Zhongxing Xu4193eca2008-12-20 06:32:12 +0000304 NewSt.St = store;
Ted Kremenek0fb0bc42009-08-27 01:39:13 +0000305 return getStateManager().getPersistentState(NewSt);
Zhongxing Xu4193eca2008-12-20 06:32:12 +0000306}
307
Ted Kremenek1c72ef02008-08-16 00:49:49 +0000308//===----------------------------------------------------------------------===//
309// State pretty-printing.
310//===----------------------------------------------------------------------===//
Ted Kremenek461f9772008-03-11 18:57:24 +0000311
Ted Kremenek6d4c0222010-09-03 01:07:02 +0000312static bool IsEnvLoc(const Stmt *S) {
313 // FIXME: This is a layering violation. Should be in environment.
314 return (bool) (((uintptr_t) S) & 0x1);
315}
316
Zhongxing Xuc179a7f2010-03-05 04:45:36 +0000317void GRState::print(llvm::raw_ostream& Out, CFG &C, const char* nl,
Mike Stump1eb44332009-09-09 15:08:12 +0000318 const char* sep) const {
Ted Kremeneka622d8c2008-08-19 22:24:03 +0000319 // Print the store.
Ted Kremenek0fb0bc42009-08-27 01:39:13 +0000320 GRStateManager &Mgr = getStateManager();
321 Mgr.getStoreManager().print(getStore(), Out, nl, sep);
Mike Stump1eb44332009-09-09 15:08:12 +0000322
Ted Kremeneke7d22112008-02-11 19:21:59 +0000323 // Print Subexpression bindings.
Ted Kremeneka622d8c2008-08-19 22:24:03 +0000324 bool isFirst = true;
Mike Stump1eb44332009-09-09 15:08:12 +0000325
Ted Kremenek6d4c0222010-09-03 01:07:02 +0000326 // FIXME: All environment printing should be moved inside Environment.
Mike Stump1eb44332009-09-09 15:08:12 +0000327 for (Environment::iterator I = Env.begin(), E = Env.end(); I != E; ++I) {
Ted Kremenek6d4c0222010-09-03 01:07:02 +0000328 if (C.isBlkExpr(I.getKey()) || IsEnvLoc(I.getKey()))
Ted Kremenek0fb0bc42009-08-27 01:39:13 +0000329 continue;
Mike Stump1eb44332009-09-09 15:08:12 +0000330
Ted Kremeneke7d22112008-02-11 19:21:59 +0000331 if (isFirst) {
Ted Kremenek59894f92008-03-04 18:30:35 +0000332 Out << nl << nl << "Sub-Expressions:" << nl;
Ted Kremeneke7d22112008-02-11 19:21:59 +0000333 isFirst = false;
334 }
Ted Kremenek59894f92008-03-04 18:30:35 +0000335 else { Out << nl; }
Mike Stump1eb44332009-09-09 15:08:12 +0000336
Ted Kremeneke7d22112008-02-11 19:21:59 +0000337 Out << " (" << (void*) I.getKey() << ") ";
Chris Lattnere4f21422009-06-30 01:26:17 +0000338 LangOptions LO; // FIXME.
339 I.getKey()->printPretty(Out, 0, PrintingPolicy(LO));
Ted Kremenek6f9b3a42009-07-13 23:53:06 +0000340 Out << " : " << I.getData();
Ted Kremeneke7d22112008-02-11 19:21:59 +0000341 }
Mike Stump1eb44332009-09-09 15:08:12 +0000342
Ted Kremeneke7d22112008-02-11 19:21:59 +0000343 // Print block-expression bindings.
Ted Kremeneke7d22112008-02-11 19:21:59 +0000344 isFirst = true;
Ted Kremenek0fb0bc42009-08-27 01:39:13 +0000345
346 for (Environment::iterator I = Env.begin(), E = Env.end(); I != E; ++I) {
347 if (!C.isBlkExpr(I.getKey()))
348 continue;
Ted Kremeneke7d22112008-02-11 19:21:59 +0000349
350 if (isFirst) {
Ted Kremenek59894f92008-03-04 18:30:35 +0000351 Out << nl << nl << "Block-level Expressions:" << nl;
Ted Kremeneke7d22112008-02-11 19:21:59 +0000352 isFirst = false;
353 }
Ted Kremenek59894f92008-03-04 18:30:35 +0000354 else { Out << nl; }
Mike Stump1eb44332009-09-09 15:08:12 +0000355
Ted Kremeneke7d22112008-02-11 19:21:59 +0000356 Out << " (" << (void*) I.getKey() << ") ";
Chris Lattnere4f21422009-06-30 01:26:17 +0000357 LangOptions LO; // FIXME.
358 I.getKey()->printPretty(Out, 0, PrintingPolicy(LO));
Ted Kremenek6f9b3a42009-07-13 23:53:06 +0000359 Out << " : " << I.getData();
Ted Kremeneke7d22112008-02-11 19:21:59 +0000360 }
Ted Kremenek6d4c0222010-09-03 01:07:02 +0000361
362 // Print locations.
363 isFirst = true;
364
365 for (Environment::iterator I = Env.begin(), E = Env.end(); I != E; ++I) {
366 if (!IsEnvLoc(I.getKey()))
367 continue;
368
369 if (isFirst) {
370 Out << nl << nl << "Load/store locations:" << nl;
371 isFirst = false;
372 }
373 else { Out << nl; }
374
375 const Stmt *S = (Stmt*) (((uintptr_t) I.getKey()) & ((uintptr_t) ~0x1));
376
377 Out << " (" << (void*) S << ") ";
378 LangOptions LO; // FIXME.
379 S->printPretty(Out, 0, PrintingPolicy(LO));
380 Out << " : " << I.getData();
381 }
Mike Stump1eb44332009-09-09 15:08:12 +0000382
Ted Kremenek0fb0bc42009-08-27 01:39:13 +0000383 Mgr.getConstraintManager().print(this, Out, nl, sep);
Mike Stump1eb44332009-09-09 15:08:12 +0000384
Ted Kremenekb65be702009-06-18 01:23:53 +0000385 // Print checker-specific data.
Ted Kremenek0fb0bc42009-08-27 01:39:13 +0000386 for (std::vector<Printer*>::iterator I = Mgr.Printers.begin(),
387 E = Mgr.Printers.end(); I != E; ++I) {
Ted Kremenekb65be702009-06-18 01:23:53 +0000388 (*I)->Print(Out, this, nl, sep);
389 }
Ted Kremeneke7d22112008-02-11 19:21:59 +0000390}
Ted Kremenek729a9a22008-07-17 23:15:45 +0000391
Zhongxing Xuc179a7f2010-03-05 04:45:36 +0000392void GRState::printDOT(llvm::raw_ostream& Out, CFG &C) const {
393 print(Out, C, "\\l", "\\|");
Ted Kremenek1c72ef02008-08-16 00:49:49 +0000394}
395
Zhongxing Xuc179a7f2010-03-05 04:45:36 +0000396void GRState::printStdErr(CFG &C) const {
397 print(llvm::errs(), C);
Ted Kremenek1c72ef02008-08-16 00:49:49 +0000398}
399
Ted Kremenek72cd17f2008-08-14 21:16:54 +0000400//===----------------------------------------------------------------------===//
401// Generic Data Map.
402//===----------------------------------------------------------------------===//
403
404void* const* GRState::FindGDM(void* K) const {
405 return GDM.lookup(K);
406}
407
Ted Kremenek1c72ef02008-08-16 00:49:49 +0000408void*
409GRStateManager::FindGDMContext(void* K,
410 void* (*CreateContext)(llvm::BumpPtrAllocator&),
411 void (*DeleteContext)(void*)) {
Mike Stump1eb44332009-09-09 15:08:12 +0000412
Ted Kremenek1c72ef02008-08-16 00:49:49 +0000413 std::pair<void*, void (*)(void*)>& p = GDMContexts[K];
414 if (!p.first) {
415 p.first = CreateContext(Alloc);
416 p.second = DeleteContext;
417 }
Mike Stump1eb44332009-09-09 15:08:12 +0000418
Ted Kremenek1c72ef02008-08-16 00:49:49 +0000419 return p.first;
420}
421
Zhongxing Xu4230da62008-11-03 05:18:34 +0000422const GRState* GRStateManager::addGDM(const GRState* St, void* Key, void* Data){
Ted Kremenek72cd17f2008-08-14 21:16:54 +0000423 GRState::GenericDataMap M1 = St->getGDM();
Ted Kremenek3baf6722010-11-24 00:54:37 +0000424 GRState::GenericDataMap M2 = GDMFactory.add(M1, Key, Data);
Mike Stump1eb44332009-09-09 15:08:12 +0000425
Ted Kremenek72cd17f2008-08-14 21:16:54 +0000426 if (M1 == M2)
427 return St;
Mike Stump1eb44332009-09-09 15:08:12 +0000428
Ted Kremenek72cd17f2008-08-14 21:16:54 +0000429 GRState NewSt = *St;
430 NewSt.GDM = M2;
431 return getPersistentState(NewSt);
432}
Ted Kremenek584def72008-07-22 00:46:16 +0000433
Zhongxing Xu0541d102010-03-25 01:39:39 +0000434const GRState *GRStateManager::removeGDM(const GRState *state, void *Key) {
435 GRState::GenericDataMap OldM = state->getGDM();
Ted Kremenek3baf6722010-11-24 00:54:37 +0000436 GRState::GenericDataMap NewM = GDMFactory.remove(OldM, Key);
Zhongxing Xu0541d102010-03-25 01:39:39 +0000437
438 if (NewM == OldM)
439 return state;
440
441 GRState NewState = *state;
442 NewState.GDM = NewM;
443 return getPersistentState(NewState);
444}
445
Ted Kremenek584def72008-07-22 00:46:16 +0000446//===----------------------------------------------------------------------===//
Ted Kremenek5216ad72009-02-14 03:16:10 +0000447// Utility.
448//===----------------------------------------------------------------------===//
449
Ted Kremenek5dc27462009-03-03 02:51:43 +0000450namespace {
Kovarththanan Rajaratnamba5fb5a2009-11-28 06:07:30 +0000451class ScanReachableSymbols : public SubRegionMap::Visitor {
Ted Kremenek5dc27462009-03-03 02:51:43 +0000452 typedef llvm::DenseSet<const MemRegion*> VisitedRegionsTy;
453
454 VisitedRegionsTy visited;
Ted Kremenek47fed902009-06-18 01:33:24 +0000455 const GRState *state;
Ted Kremenek5dc27462009-03-03 02:51:43 +0000456 SymbolVisitor &visitor;
457 llvm::OwningPtr<SubRegionMap> SRM;
458public:
Mike Stump1eb44332009-09-09 15:08:12 +0000459
Ted Kremenek47fed902009-06-18 01:33:24 +0000460 ScanReachableSymbols(const GRState *st, SymbolVisitor& v)
461 : state(st), visitor(v) {}
Mike Stump1eb44332009-09-09 15:08:12 +0000462
Ted Kremenek5dc27462009-03-03 02:51:43 +0000463 bool scan(nonloc::CompoundVal val);
464 bool scan(SVal val);
465 bool scan(const MemRegion *R);
Mike Stump1eb44332009-09-09 15:08:12 +0000466
Ted Kremenek5dc27462009-03-03 02:51:43 +0000467 // From SubRegionMap::Visitor.
468 bool Visit(const MemRegion* Parent, const MemRegion* SubRegion) {
469 return scan(SubRegion);
470 }
471};
472}
473
474bool ScanReachableSymbols::scan(nonloc::CompoundVal val) {
Ted Kremenek5216ad72009-02-14 03:16:10 +0000475 for (nonloc::CompoundVal::iterator I=val.begin(), E=val.end(); I!=E; ++I)
Ted Kremenek5dc27462009-03-03 02:51:43 +0000476 if (!scan(*I))
477 return false;
Ted Kremenek5216ad72009-02-14 03:16:10 +0000478
479 return true;
480}
Mike Stump1eb44332009-09-09 15:08:12 +0000481
Ted Kremenek5dc27462009-03-03 02:51:43 +0000482bool ScanReachableSymbols::scan(SVal val) {
483 if (loc::MemRegionVal *X = dyn_cast<loc::MemRegionVal>(&val))
484 return scan(X->getRegion());
Ted Kremenek380022d2009-03-30 18:45:36 +0000485
Zhongxing Xu951b3342010-01-11 07:40:00 +0000486 if (nonloc::LocAsInteger *X = dyn_cast<nonloc::LocAsInteger>(&val))
487 return scan(X->getLoc());
488
Ted Kremenek380022d2009-03-30 18:45:36 +0000489 if (SymbolRef Sym = val.getAsSymbol())
490 return visitor.VisitSymbol(Sym);
Mike Stump1eb44332009-09-09 15:08:12 +0000491
Ted Kremenek5216ad72009-02-14 03:16:10 +0000492 if (nonloc::CompoundVal *X = dyn_cast<nonloc::CompoundVal>(&val))
Ted Kremenek5dc27462009-03-03 02:51:43 +0000493 return scan(*X);
Mike Stump1eb44332009-09-09 15:08:12 +0000494
Ted Kremenek5216ad72009-02-14 03:16:10 +0000495 return true;
496}
Mike Stump1eb44332009-09-09 15:08:12 +0000497
Ted Kremenek5dc27462009-03-03 02:51:43 +0000498bool ScanReachableSymbols::scan(const MemRegion *R) {
Ted Kremenek1cb151e2009-03-04 00:13:10 +0000499 if (isa<MemSpaceRegion>(R) || visited.count(R))
Ted Kremenek5dc27462009-03-03 02:51:43 +0000500 return true;
Mike Stump1eb44332009-09-09 15:08:12 +0000501
Ted Kremenek5dc27462009-03-03 02:51:43 +0000502 visited.insert(R);
503
504 // If this is a symbolic region, visit the symbol for the region.
505 if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(R))
506 if (!visitor.VisitSymbol(SR->getSymbol()))
507 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000508
Ted Kremenek5dc27462009-03-03 02:51:43 +0000509 // If this is a subregion, also visit the parent regions.
510 if (const SubRegion *SR = dyn_cast<SubRegion>(R))
Ted Kremenek6076e0a2009-03-03 18:15:30 +0000511 if (!scan(SR->getSuperRegion()))
Ted Kremenek5dc27462009-03-03 02:51:43 +0000512 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000513
Ted Kremenek5dc27462009-03-03 02:51:43 +0000514 // Now look at the binding to this region (if any).
Ted Kremenek13976632010-02-08 16:18:51 +0000515 if (!scan(state->getSValAsScalarOrLoc(R)))
Ted Kremenek5dc27462009-03-03 02:51:43 +0000516 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000517
Ted Kremenek5dc27462009-03-03 02:51:43 +0000518 // Now look at the subregions.
519 if (!SRM.get())
Zhongxing Xuf5416bd2010-02-05 05:18:47 +0000520 SRM.reset(state->getStateManager().getStoreManager().
521 getSubRegionMap(state->getStore()));
Mike Stump1eb44332009-09-09 15:08:12 +0000522
Ted Kremenek5dc27462009-03-03 02:51:43 +0000523 return SRM->iterSubRegions(R, *this);
524}
525
Ted Kremenek47fed902009-06-18 01:33:24 +0000526bool GRState::scanReachableSymbols(SVal val, SymbolVisitor& visitor) const {
527 ScanReachableSymbols S(this, visitor);
Ted Kremenek5dc27462009-03-03 02:51:43 +0000528 return S.scan(val);
529}
Ted Kremenek5216ad72009-02-14 03:16:10 +0000530
Ted Kremenek9dce71f2009-11-26 02:32:19 +0000531bool GRState::scanReachableSymbols(const SVal *I, const SVal *E,
532 SymbolVisitor &visitor) const {
533 ScanReachableSymbols S(this, visitor);
534 for ( ; I != E; ++I) {
Ted Kremenek43f19f72009-12-01 17:50:25 +0000535 if (!S.scan(*I))
536 return false;
Ted Kremenek9dce71f2009-11-26 02:32:19 +0000537 }
Ted Kremenek43f19f72009-12-01 17:50:25 +0000538 return true;
Ted Kremenek9dce71f2009-11-26 02:32:19 +0000539}
540
541bool GRState::scanReachableSymbols(const MemRegion * const *I,
542 const MemRegion * const *E,
543 SymbolVisitor &visitor) const {
544 ScanReachableSymbols S(this, visitor);
545 for ( ; I != E; ++I) {
Ted Kremenek43f19f72009-12-01 17:50:25 +0000546 if (!S.scan(*I))
547 return false;
Ted Kremenek9dce71f2009-11-26 02:32:19 +0000548 }
Ted Kremenek43f19f72009-12-01 17:50:25 +0000549 return true;
Ted Kremenek9dce71f2009-11-26 02:32:19 +0000550}