clang 20.0.0git
ProgramState.cpp
Go to the documentation of this file.
1//= ProgramState.cpp - Path-Sensitive "State" for tracking values --*- C++ -*--=
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file implements ProgramState and ProgramStateManager.
10//
11//===----------------------------------------------------------------------===//
12
14#include "clang/Analysis/CFG.h"
21#include "llvm/Support/raw_ostream.h"
22#include <optional>
23
24using namespace clang;
25using namespace ento;
26
27namespace clang { namespace ento {
28/// Increments the number of times this state is referenced.
29
30void ProgramStateRetain(const ProgramState *state) {
31 ++const_cast<ProgramState*>(state)->refCount;
32}
33
34/// Decrement the number of times this state is referenced.
36 assert(state->refCount > 0);
37 ProgramState *s = const_cast<ProgramState*>(state);
38 if (--s->refCount == 0) {
39 ProgramStateManager &Mgr = s->getStateManager();
40 Mgr.StateSet.RemoveNode(s);
41 s->~ProgramState();
42 Mgr.freeStates.push_back(s);
43 }
44}
45}}
46
49 : stateMgr(mgr),
50 Env(env),
51 store(st.getStore()),
52 GDM(gdm),
53 refCount(0) {
55}
56
58 : stateMgr(RHS.stateMgr), Env(RHS.Env), store(RHS.store), GDM(RHS.GDM),
59 PosteriorlyOverconstrained(RHS.PosteriorlyOverconstrained), refCount(0) {
61}
62
64 if (store)
66}
67
68int64_t ProgramState::getID() const {
69 return getStateManager().Alloc.identifyKnownAlignedObject<ProgramState>(this);
70}
71
73 StoreManagerCreator CreateSMgr,
74 ConstraintManagerCreator CreateCMgr,
75 llvm::BumpPtrAllocator &alloc,
76 ExprEngine *ExprEng)
77 : Eng(ExprEng), EnvMgr(alloc), GDMFactory(alloc),
78 svalBuilder(createSimpleSValBuilder(alloc, Ctx, *this)),
79 CallEventMgr(new CallEventManager(alloc)), Alloc(alloc) {
80 StoreMgr = (*CreateSMgr)(*this);
81 ConstraintMgr = (*CreateCMgr)(*this, ExprEng);
82}
83
84
86 for (GDMContextsTy::iterator I=GDMContexts.begin(), E=GDMContexts.end();
87 I!=E; ++I)
88 I->second.second(I->second.first);
89}
90
92 ProgramStateRef state, const StackFrameContext *LCtx,
93 SymbolReaper &SymReaper) {
94
95 // This code essentially performs a "mark-and-sweep" of the VariableBindings.
96 // The roots are any Block-level exprs and Decls that our liveness algorithm
97 // tells us are live. We then see what Decls they may reference, and keep
98 // those around. This code more than likely can be made faster, and the
99 // frequency of which this method is called should be experimented with
100 // for optimum performance.
101 ProgramState NewState = *state;
102
103 NewState.Env = EnvMgr.removeDeadBindings(NewState.Env, SymReaper, state);
104
105 // Clean up the store.
106 StoreRef newStore = StoreMgr->removeDeadBindings(NewState.getStore(), LCtx,
107 SymReaper);
108 NewState.setStore(newStore);
109 SymReaper.setReapedStore(newStore);
110
111 return getPersistentState(NewState);
112}
113
115 SVal V,
116 const LocationContext *LCtx,
117 bool notifyChanges) const {
119 ProgramStateRef newState = makeWithStore(Mgr.StoreMgr->Bind(getStore(),
120 LV, V));
121 const MemRegion *MR = LV.getAsRegion();
122 if (MR && notifyChanges)
123 return Mgr.getOwningEngine().processRegionChange(newState, MR, LCtx);
124
125 return newState;
126}
127
130 const LocationContext *LCtx) const {
132 const MemRegion *R = loc.castAs<loc::MemRegionVal>().getRegion();
133 const StoreRef &newStore = Mgr.StoreMgr->BindDefaultInitial(getStore(), R, V);
134 ProgramStateRef new_state = makeWithStore(newStore);
135 return Mgr.getOwningEngine().processRegionChange(new_state, R, LCtx);
136}
137
141 const MemRegion *R = loc.castAs<loc::MemRegionVal>().getRegion();
142 const StoreRef &newStore = Mgr.StoreMgr->BindDefaultZero(getStore(), R);
143 ProgramStateRef new_state = makeWithStore(newStore);
144 return Mgr.getOwningEngine().processRegionChange(new_state, R, LCtx);
145}
146
149
152 const Expr *E, unsigned Count,
153 const LocationContext *LCtx,
154 bool CausedByPointerEscape,
156 const CallEvent *Call,
157 RegionAndSymbolInvalidationTraits *ITraits) const {
159 for (const MemRegion *Reg : Regions)
160 Values.push_back(loc::MemRegionVal(Reg));
161
162 return invalidateRegions(Values, E, Count, LCtx, CausedByPointerEscape, IS,
163 Call, ITraits);
164}
165
168 const Expr *E, unsigned Count,
169 const LocationContext *LCtx,
170 bool CausedByPointerEscape,
172 const CallEvent *Call,
173 RegionAndSymbolInvalidationTraits *ITraits) const {
174
176 ExprEngine &Eng = Mgr.getOwningEngine();
177
178 InvalidatedSymbols InvalidatedSyms;
179 if (!IS)
180 IS = &InvalidatedSyms;
181
183 if (!ITraits)
184 ITraits = &ITraitsLocal;
185
186 StoreManager::InvalidatedRegions TopLevelInvalidated;
188 const StoreRef &NewStore = Mgr.StoreMgr->invalidateRegions(
189 getStore(), Values, E, Count, LCtx, Call, *IS, *ITraits,
190 &TopLevelInvalidated, &Invalidated);
191
192 ProgramStateRef NewState = makeWithStore(NewStore);
193
194 if (CausedByPointerEscape) {
195 NewState = Eng.notifyCheckersOfPointerEscape(
196 NewState, IS, TopLevelInvalidated, Call, *ITraits);
197 }
198
199 return Eng.processRegionChanges(NewState, IS, TopLevelInvalidated,
200 Invalidated, LCtx, Call);
201}
202
204 Store OldStore = getStore();
205 const StoreRef &newStore =
206 getStateManager().StoreMgr->killBinding(OldStore, LV);
207
208 if (newStore.getStore() == OldStore)
209 return this;
210
211 return makeWithStore(newStore);
212}
213
214/// SymbolicRegions are expected to be wrapped by an ElementRegion as a
215/// canonical representation. As a canonical representation, SymbolicRegions
216/// should be wrapped by ElementRegions before getting a FieldRegion.
217/// See f8643a9b31c4029942f67d4534c9139b45173504 why.
218SVal ProgramState::wrapSymbolicRegion(SVal Val) const {
219 const auto *BaseReg = dyn_cast_or_null<SymbolicRegion>(Val.getAsRegion());
220 if (!BaseReg)
221 return Val;
222
224 QualType ElemTy = BaseReg->getPointeeStaticType();
225 return loc::MemRegionVal{SM.GetElementZeroRegion(BaseReg, ElemTy)};
226}
227
230 const StackFrameContext *CalleeCtx) const {
231 const StoreRef &NewStore =
232 getStateManager().StoreMgr->enterStackFrame(getStore(), Call, CalleeCtx);
233 return makeWithStore(NewStore);
234}
235
237 const ImplicitParamDecl *SelfDecl = LCtx->getSelfDecl();
238 if (!SelfDecl)
239 return SVal();
240 return getSVal(getRegion(SelfDecl, LCtx));
241}
242
244 // We only want to do fetches from regions that we can actually bind
245 // values. For example, SymbolicRegions of type 'id<...>' cannot
246 // have direct bindings (but their can be bindings on their subregions).
247 if (!R->isBoundable())
248 return UnknownVal();
249
250 if (const TypedValueRegion *TR = dyn_cast<TypedValueRegion>(R)) {
251 QualType T = TR->getValueType();
253 return getSVal(R);
254 }
255
256 return UnknownVal();
257}
258
260 SVal V = getRawSVal(location, T);
261
262 // If 'V' is a symbolic value that is *perfectly* constrained to
263 // be a constant value, use that value instead to lessen the burden
264 // on later analysis stages (so we have less symbolic values to reason
265 // about).
266 // We only go into this branch if we can convert the APSInt value we have
267 // to the type of T, which is not always the case (e.g. for void).
268 if (!T.isNull() && (T->isIntegralOrEnumerationType() || Loc::isLocType(T))) {
269 if (SymbolRef sym = V.getAsSymbol()) {
270 if (const llvm::APSInt *Int = getStateManager()
272 .getSymVal(this, sym)) {
273 // FIXME: Because we don't correctly model (yet) sign-extension
274 // and truncation of symbolic values, we need to convert
275 // the integer value to the correct signedness and bitwidth.
276 //
277 // This shows up in the following:
278 //
279 // char foo();
280 // unsigned x = foo();
281 // if (x == 54)
282 // ...
283 //
284 // The symbolic value stored to 'x' is actually the conjured
285 // symbol for the call to foo(); the type of that symbol is 'char',
286 // not unsigned.
287 const llvm::APSInt &NewV = getBasicVals().Convert(T, *Int);
288
289 if (V.getAs<Loc>())
290 return loc::ConcreteInt(NewV);
291 else
292 return nonloc::ConcreteInt(NewV);
293 }
294 }
295 }
296
297 return V;
298}
299
301 const LocationContext *LCtx,
302 SVal V, bool Invalidate) const{
303 Environment NewEnv =
304 getStateManager().EnvMgr.bindExpr(Env, EnvironmentEntry(S, LCtx), V,
305 Invalidate);
306 if (NewEnv == Env)
307 return this;
308
309 ProgramState NewSt = *this;
310 NewSt.Env = NewEnv;
311 return getStateManager().getPersistentState(NewSt);
312}
313
314[[nodiscard]] std::pair<ProgramStateRef, ProgramStateRef>
316 DefinedOrUnknownSVal UpperBound,
317 QualType indexTy) const {
318 if (Idx.isUnknown() || UpperBound.isUnknown())
319 return {this, this};
320
321 // Build an expression for 0 <= Idx < UpperBound.
322 // This is the same as Idx + MIN < UpperBound + MIN, if overflow is allowed.
323 // FIXME: This should probably be part of SValBuilder.
325 SValBuilder &svalBuilder = SM.getSValBuilder();
326 ASTContext &Ctx = svalBuilder.getContext();
327
328 // Get the offset: the minimum value of the array index type.
329 BasicValueFactory &BVF = svalBuilder.getBasicValueFactory();
330 if (indexTy.isNull())
331 indexTy = svalBuilder.getArrayIndexType();
332 nonloc::ConcreteInt Min(BVF.getMinValue(indexTy));
333
334 // Adjust the index.
335 SVal newIdx = svalBuilder.evalBinOpNN(this, BO_Add,
336 Idx.castAs<NonLoc>(), Min, indexTy);
337 if (newIdx.isUnknownOrUndef())
338 return {this, this};
339
340 // Adjust the upper bound.
341 SVal newBound =
342 svalBuilder.evalBinOpNN(this, BO_Add, UpperBound.castAs<NonLoc>(),
343 Min, indexTy);
344
345 if (newBound.isUnknownOrUndef())
346 return {this, this};
347
348 // Build the actual comparison.
349 SVal inBound = svalBuilder.evalBinOpNN(this, BO_LT, newIdx.castAs<NonLoc>(),
350 newBound.castAs<NonLoc>(), Ctx.IntTy);
351 if (inBound.isUnknownOrUndef())
352 return {this, this};
353
354 // Finally, let the constraint manager take care of it.
355 ConstraintManager &CM = SM.getConstraintManager();
356 return CM.assumeDual(this, inBound.castAs<DefinedSVal>());
357}
358
360 DefinedOrUnknownSVal UpperBound,
361 bool Assumption,
362 QualType indexTy) const {
363 std::pair<ProgramStateRef, ProgramStateRef> R =
364 assumeInBoundDual(Idx, UpperBound, indexTy);
365 return Assumption ? R.first : R.second;
366}
367
370 if (IsNull.isUnderconstrained())
371 return IsNull;
372 return ConditionTruthVal(!IsNull.getValue());
373}
374
376 return stateMgr->getSValBuilder().areEqual(this, Lhs, Rhs);
377}
378
380 if (V.isZeroConstant())
381 return true;
382
383 if (V.isConstant())
384 return false;
385
386 SymbolRef Sym = V.getAsSymbol(/* IncludeBaseRegion */ true);
387 if (!Sym)
388 return ConditionTruthVal();
389
390 return getStateManager().ConstraintMgr->isNull(this, Sym);
391}
392
394 ProgramState State(this,
395 EnvMgr.getInitialEnvironment(),
396 StoreMgr->getInitialStore(InitLoc),
397 GDMFactory.getEmptyMap());
398
399 return getPersistentState(State);
400}
401
403 ProgramStateRef FromState,
404 ProgramStateRef GDMState) {
405 ProgramState NewState(*FromState);
406 NewState.GDM = GDMState->GDM;
407 return getPersistentState(NewState);
408}
409
411
412 llvm::FoldingSetNodeID ID;
413 State.Profile(ID);
414 void *InsertPos;
415
416 if (ProgramState *I = StateSet.FindNodeOrInsertPos(ID, InsertPos))
417 return I;
418
419 ProgramState *newState = nullptr;
420 if (!freeStates.empty()) {
421 newState = freeStates.back();
422 freeStates.pop_back();
423 }
424 else {
425 newState = Alloc.Allocate<ProgramState>();
426 }
427 new (newState) ProgramState(State);
428 StateSet.InsertNode(newState, InsertPos);
429 return newState;
430}
431
432ProgramStateRef ProgramState::makeWithStore(const StoreRef &store) const {
433 ProgramState NewSt(*this);
434 NewSt.setStore(store);
435 return getStateManager().getPersistentState(NewSt);
436}
437
438ProgramStateRef ProgramState::cloneAsPosteriorlyOverconstrained() const {
439 ProgramState NewSt(*this);
440 NewSt.PosteriorlyOverconstrained = true;
441 return getStateManager().getPersistentState(NewSt);
442}
443
444void ProgramState::setStore(const StoreRef &newStore) {
445 Store newStoreStore = newStore.getStore();
446 if (newStoreStore)
447 stateMgr->getStoreManager().incrementReferenceCount(newStoreStore);
448 if (store)
449 stateMgr->getStoreManager().decrementReferenceCount(store);
450 store = newStoreStore;
451}
452
454 Base = wrapSymbolicRegion(Base);
455 return getStateManager().StoreMgr->getLValueField(D, Base);
456}
457
459 StoreManager &SM = *getStateManager().StoreMgr;
460 Base = wrapSymbolicRegion(Base);
461
462 // FIXME: This should work with `SM.getLValueField(D->getAnonField(), Base)`,
463 // but that would break some tests. There is probably a bug somewhere that it
464 // would expose.
465 for (const auto *I : D->chain()) {
466 Base = SM.getLValueField(cast<FieldDecl>(I), Base);
467 }
468 return Base;
469}
470
471//===----------------------------------------------------------------------===//
472// State pretty-printing.
473//===----------------------------------------------------------------------===//
474
475void ProgramState::printJson(raw_ostream &Out, const LocationContext *LCtx,
476 const char *NL, unsigned int Space,
477 bool IsDot) const {
478 Indent(Out, Space, IsDot) << "\"program_state\": {" << NL;
479 ++Space;
480
482
483 // Print the store.
484 Mgr.getStoreManager().printJson(Out, getStore(), NL, Space, IsDot);
485
486 // Print out the environment.
487 Env.printJson(Out, Mgr.getContext(), LCtx, NL, Space, IsDot);
488
489 // Print out the constraints.
490 Mgr.getConstraintManager().printJson(Out, this, NL, Space, IsDot);
491
492 // Print out the tracked dynamic types.
493 printDynamicTypeInfoJson(Out, this, NL, Space, IsDot);
494
495 // Print checker-specific data.
496 Mgr.getOwningEngine().printJson(Out, this, LCtx, NL, Space, IsDot);
497
498 --Space;
499 Indent(Out, Space, IsDot) << '}';
500}
501
502void ProgramState::printDOT(raw_ostream &Out, const LocationContext *LCtx,
503 unsigned int Space) const {
504 printJson(Out, LCtx, /*NL=*/"\\l", Space, /*IsDot=*/true);
505}
506
507LLVM_DUMP_METHOD void ProgramState::dump() const {
508 printJson(llvm::errs());
509}
510
512 return stateMgr->getOwningEngine().getAnalysisManager();
513}
514
515//===----------------------------------------------------------------------===//
516// Generic Data Map.
517//===----------------------------------------------------------------------===//
518
519void *const* ProgramState::FindGDM(void *K) const {
520 return GDM.lookup(K);
521}
522
523void*
525 void *(*CreateContext)(llvm::BumpPtrAllocator&),
526 void (*DeleteContext)(void*)) {
527
528 std::pair<void*, void (*)(void*)>& p = GDMContexts[K];
529 if (!p.first) {
530 p.first = CreateContext(Alloc);
531 p.second = DeleteContext;
532 }
533
534 return p.first;
535}
536
538 ProgramState::GenericDataMap M1 = St->getGDM();
539 ProgramState::GenericDataMap M2 = GDMFactory.add(M1, Key, Data);
540
541 if (M1 == M2)
542 return St;
543
544 ProgramState NewSt = *St;
545 NewSt.GDM = M2;
546 return getPersistentState(NewSt);
547}
548
550 ProgramState::GenericDataMap OldM = state->getGDM();
551 ProgramState::GenericDataMap NewM = GDMFactory.remove(OldM, Key);
552
553 if (NewM == OldM)
554 return state;
555
556 ProgramState NewState = *state;
557 NewState.GDM = NewM;
558 return getPersistentState(NewState);
559}
560
562 bool wasVisited = !visited.insert(val.getCVData()).second;
563 if (wasVisited)
564 return true;
565
566 StoreManager &StoreMgr = state->getStateManager().getStoreManager();
567 // FIXME: We don't really want to use getBaseRegion() here because pointer
568 // arithmetic doesn't apply, but scanReachableSymbols only accepts base
569 // regions right now.
570 const MemRegion *R = val.getRegion()->getBaseRegion();
571 return StoreMgr.scanReachableSymbols(val.getStore(), R, *this);
572}
573
575 for (SVal V : val)
576 if (!scan(V))
577 return false;
578
579 return true;
580}
581
583 for (SymbolRef SubSym : sym->symbols()) {
584 bool wasVisited = !visited.insert(SubSym).second;
585 if (wasVisited)
586 continue;
587
588 if (!visitor.VisitSymbol(SubSym))
589 return false;
590 }
591
592 return true;
593}
594
596 if (std::optional<loc::MemRegionVal> X = val.getAs<loc::MemRegionVal>())
597 return scan(X->getRegion());
598
599 if (std::optional<nonloc::LazyCompoundVal> X =
601 return scan(*X);
602
603 if (std::optional<nonloc::LocAsInteger> X = val.getAs<nonloc::LocAsInteger>())
604 return scan(X->getLoc());
605
606 if (SymbolRef Sym = val.getAsSymbol())
607 return scan(Sym);
608
609 if (std::optional<nonloc::CompoundVal> X = val.getAs<nonloc::CompoundVal>())
610 return scan(*X);
611
612 return true;
613}
614
616 if (isa<MemSpaceRegion>(R))
617 return true;
618
619 bool wasVisited = !visited.insert(R).second;
620 if (wasVisited)
621 return true;
622
623 if (!visitor.VisitMemRegion(R))
624 return false;
625
626 // If this is a symbolic region, visit the symbol for the region.
627 if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(R))
628 if (!visitor.VisitSymbol(SR->getSymbol()))
629 return false;
630
631 // If this is a subregion, also visit the parent regions.
632 if (const SubRegion *SR = dyn_cast<SubRegion>(R)) {
633 const MemRegion *Super = SR->getSuperRegion();
634 if (!scan(Super))
635 return false;
636
637 // When we reach the topmost region, scan all symbols in it.
638 if (isa<MemSpaceRegion>(Super)) {
639 StoreManager &StoreMgr = state->getStateManager().getStoreManager();
640 if (!StoreMgr.scanReachableSymbols(state->getStore(), SR, *this))
641 return false;
642 }
643 }
644
645 // Regions captured by a block are also implicitly reachable.
646 if (const BlockDataRegion *BDR = dyn_cast<BlockDataRegion>(R)) {
647 for (auto Var : BDR->referenced_vars()) {
648 if (!scan(Var.getCapturedRegion()))
649 return false;
650 }
651 }
652
653 return true;
654}
655
657 ScanReachableSymbols S(this, visitor);
658 return S.scan(val);
659}
660
662 llvm::iterator_range<region_iterator> Reachable,
663 SymbolVisitor &visitor) const {
664 ScanReachableSymbols S(this, visitor);
665 for (const MemRegion *R : Reachable) {
666 if (!S.scan(R))
667 return false;
668 }
669 return true;
670}
#define V(N, I)
Definition: ASTContext.h:3341
#define SM(sm)
Definition: Cuda.cpp:83
const Decl * D
Expr * E
const Environment & Env
Definition: HTMLLogger.cpp:148
#define X(type, name)
Definition: Value.h:143
ArrayRef< const MemRegion * > RegionList
ArrayRef< SVal > ValueList
__device__ __2f16 float __ockl_bool s
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:187
CanQualType IntTy
Definition: ASTContext.h:1128
This represents one expression.
Definition: Expr.h:110
Represents a member of a struct/union/class.
Definition: Decl.h:3030
Represents a field injected from an anonymous union/struct into the parent scope.
Definition: Decl.h:3314
It wraps the AnalysisDeclContext to represent both the call stack with the help of StackFrameContext ...
const ImplicitParamDecl * getSelfDecl() const
A (possibly-)qualified type.
Definition: Type.h:941
bool isNull() const
Return true if this QualType doesn't point to a type yet.
Definition: Type.h:1008
It represents a stack frame of the call stack (based on CallEvent).
Stmt - This represents one statement.
Definition: Stmt.h:84
bool isIntegralOrEnumerationType() const
Determine whether this type is an integral or enumeration type.
Definition: Type.h:8434
const llvm::APSInt & Convert(const llvm::APSInt &To, const llvm::APSInt &From)
Convert - Create a new persistent APSInt with the same value as 'From' but with the bitwidth and sign...
const llvm::APSInt & getMinValue(const llvm::APSInt &v)
BlockDataRegion - A region that represents a block instance.
Definition: MemRegion.h:678
Manages the lifetime of CallEvent objects.
Definition: CallEvent.h:1356
Represents an abstract call to a function or method along a particular path.
Definition: CallEvent.h:153
ProgramStatePair assumeDual(ProgramStateRef State, DefinedSVal Cond)
Returns a pair of states (StTrue, StFalse) where the given condition is assumed to be true or false,...
virtual void printJson(raw_ostream &Out, ProgramStateRef State, const char *NL, unsigned int Space, bool IsDot) const =0
An entry in the environment consists of a Stmt and an LocationContext.
Definition: Environment.h:36
Environment bindExpr(Environment Env, const EnvironmentEntry &E, SVal V, bool Invalidate)
Bind a symbolic value to the given environment entry.
Environment removeDeadBindings(Environment Env, SymbolReaper &SymReaper, ProgramStateRef state)
An immutable map from EnvironemntEntries to SVals.
Definition: Environment.h:56
void printJson(raw_ostream &Out, const ASTContext &Ctx, const LocationContext *LCtx=nullptr, const char *NL="\n", unsigned int Space=0, bool IsDot=false) const
ProgramStateRef processRegionChange(ProgramStateRef state, const MemRegion *MR, const LocationContext *LCtx)
Definition: ExprEngine.h:399
void printJson(raw_ostream &Out, ProgramStateRef State, const LocationContext *LCtx, const char *NL, unsigned int Space, bool IsDot) const
printJson - Called by ProgramStateManager to print checker-specific data.
Definition: ExprEngine.cpp:939
ProgramStateRef processRegionChanges(ProgramStateRef state, const InvalidatedSymbols *invalidated, ArrayRef< const MemRegion * > ExplicitRegions, ArrayRef< const MemRegion * > Regions, const LocationContext *LCtx, const CallEvent *Call)
processRegionChanges - Called by ProgramStateManager whenever a change is made to the store.
Definition: ExprEngine.cpp:673
ProgramStateRef notifyCheckersOfPointerEscape(ProgramStateRef State, const InvalidatedSymbols *Invalidated, ArrayRef< const MemRegion * > ExplicitRegions, const CallEvent *Call, RegionAndSymbolInvalidationTraits &ITraits)
Call PointerEscape callback when a value escapes as a result of region invalidation.
AnalysisManager & getAnalysisManager()
Definition: ExprEngine.h:198
static bool isLocType(QualType T)
Definition: SVals.h:259
MemRegion - The root abstract class for all memory regions.
Definition: MemRegion.h:97
virtual bool isBoundable() const
Definition: MemRegion.h:183
LLVM_ATTRIBUTE_RETURNS_NONNULL const MemRegion * getBaseRegion() const
Definition: MemRegion.cpp:1354
ProgramStateRef removeDeadBindingsFromEnvironmentAndStore(ProgramStateRef St, const StackFrameContext *LCtx, SymbolReaper &SymReaper)
ProgramStateRef removeGDM(ProgramStateRef state, void *Key)
void * FindGDMContext(void *index, void *(*CreateContext)(llvm::BumpPtrAllocator &), void(*DeleteContext)(void *))
ProgramStateRef getPersistentStateWithGDM(ProgramStateRef FromState, ProgramStateRef GDMState)
ProgramStateRef addGDM(ProgramStateRef St, void *Key, void *Data)
ProgramStateRef getPersistentState(ProgramState &Impl)
ProgramStateRef getInitialState(const LocationContext *InitLoc)
ProgramStateManager(ASTContext &Ctx, StoreManagerCreator CreateStoreManager, ConstraintManagerCreator CreateConstraintManager, llvm::BumpPtrAllocator &alloc, ExprEngine *expreng)
ConstraintManager & getConstraintManager()
Definition: ProgramState.h:574
ProgramState - This class encapsulates:
Definition: ProgramState.h:71
bool scanReachableSymbols(SVal val, SymbolVisitor &visitor) const
Visits the symbols reachable from the given SVal using the provided SymbolVisitor.
Loc getLValue(const CXXBaseSpecifier &BaseSpec, const SubRegion *Super) const
Get the lvalue for a base class object reference.
Definition: ProgramState.h:749
ProgramStateRef bindDefaultZero(SVal loc, const LocationContext *LCtx) const
Performs C++ zero-initialization procedure on the region of memory represented by loc.
llvm::ImmutableMap< void *, void * > GenericDataMap
Definition: ProgramState.h:74
ProgramStateRef BindExpr(const Stmt *S, const LocationContext *LCtx, SVal V, bool Invalidate=true) const
Create a new state by binding the value 'V' to the statement 'S' in the state's environment.
void printJson(raw_ostream &Out, const LocationContext *LCtx=nullptr, const char *NL="\n", unsigned int Space=0, bool IsDot=false) const
ProgramStateRef bindDefaultInitial(SVal loc, SVal V, const LocationContext *LCtx) const
Initializes the region of memory represented by loc with an initial value.
ConstraintManager & getConstraintManager() const
Return the ConstraintManager.
Definition: ProgramState.h:690
SVal getSValAsScalarOrLoc(const Stmt *Ex, const LocationContext *LCtx) const
Definition: ProgramState.h:792
SVal getSelfSVal(const LocationContext *LC) const
Return the value of 'self' if available in the given context.
SVal getRawSVal(Loc LV, QualType T=QualType()) const
Returns the "raw" SVal bound to LV before any value simplfication.
Definition: ProgramState.h:804
ConditionTruthVal isNull(SVal V) const
Check if the given SVal is constrained to zero or is a zero constant.
ProgramStateManager & getStateManager() const
Return the ProgramStateManager associated with this state.
Definition: ProgramState.h:147
ProgramStateRef killBinding(Loc LV) const
ProgramState(ProgramStateManager *mgr, const Environment &env, StoreRef st, GenericDataMap gdm)
This ctor is used when creating the first ProgramState object.
Store getStore() const
Return the store associated with this state.
Definition: ProgramState.h:162
ProgramStateRef invalidateRegions(ArrayRef< const MemRegion * > Regions, const Expr *E, unsigned BlockCount, const LocationContext *LCtx, bool CausesPointerEscape, InvalidatedSymbols *IS=nullptr, const CallEvent *Call=nullptr, RegionAndSymbolInvalidationTraits *ITraits=nullptr) const
Returns the state with bindings for the given regions cleared from the store.
ConditionTruthVal areEqual(SVal Lhs, SVal Rhs) const
void printDOT(raw_ostream &Out, const LocationContext *LCtx=nullptr, unsigned int Space=0) const
ConditionTruthVal isNonNull(SVal V) const
Check if the given SVal is not constrained to zero and is not a zero constant.
ProgramStateRef assumeInBound(DefinedOrUnknownSVal idx, DefinedOrUnknownSVal upperBound, bool assumption, QualType IndexType=QualType()) const
ProgramStateRef enterStackFrame(const CallEvent &Call, const StackFrameContext *CalleeCtx) const
enterStackFrame - Returns the state for entry to the given stack frame, preserving the current state.
LLVM_ATTRIBUTE_RETURNS_NONNULL const VarRegion * getRegion(const VarDecl *D, const LocationContext *LC) const
Utility method for getting regions.
Definition: ProgramState.h:694
SVal getSVal(const Stmt *S, const LocationContext *LCtx) const
Returns the SVal bound to the statement 'S' in the state's environment.
Definition: ProgramState.h:785
ProgramStateRef bindLoc(Loc location, SVal V, const LocationContext *LCtx, bool notifyChanges=true) const
BasicValueFactory & getBasicVals() const
Definition: ProgramState.h:814
std::pair< ProgramStateRef, ProgramStateRef > assumeInBoundDual(DefinedOrUnknownSVal idx, DefinedOrUnknownSVal upperBound, QualType IndexType=QualType()) const
AnalysisManager & getAnalysisManager() const
void *const * FindGDM(void *K) const
Information about invalidation for a particular region/symbol.
Definition: MemRegion.h:1629
BasicValueFactory & getBasicValueFactory()
Definition: SValBuilder.h:161
ASTContext & getContext()
Definition: SValBuilder.h:148
QualType getArrayIndexType() const
Definition: SValBuilder.h:157
virtual SVal evalBinOpNN(ProgramStateRef state, BinaryOperator::Opcode op, NonLoc lhs, NonLoc rhs, QualType resultTy)=0
Create a new value which represents a binary expression with two non- location operands.
ConditionTruthVal areEqual(ProgramStateRef state, SVal lhs, SVal rhs)
SVal - This represents a symbolic expression, which can be either an L-value or an R-value.
Definition: SVals.h:55
bool isUnknownOrUndef() const
Definition: SVals.h:106
SymbolRef getAsSymbol(bool IncludeBaseRegions=false) const
If this SVal wraps a symbol return that SymbolRef.
Definition: SVals.cpp:104
std::optional< T > getAs() const
Convert to the specified SVal type, returning std::nullopt if this SVal is not of the desired type.
Definition: SVals.h:86
const MemRegion * getAsRegion() const
Definition: SVals.cpp:120
T castAs() const
Convert to the specified SVal type, asserting that this SVal is of the desired type.
Definition: SVals.h:82
bool isUnknown() const
Definition: SVals.h:102
A utility class that visits the reachable symbols using a custom SymbolVisitor.
Definition: ProgramState.h:885
bool scan(nonloc::LazyCompoundVal val)
virtual bool scanReachableSymbols(Store S, const MemRegion *R, ScanReachableSymbols &Visitor)=0
Finds the transitive closure of symbols within the given region.
virtual void decrementReferenceCount(Store store)
If the StoreManager supports it, decrement the reference count of the specified Store object.
Definition: Store.h:201
virtual void incrementReferenceCount(Store store)
If the StoreManager supports it, increment the reference count of the specified Store object.
Definition: Store.h:196
virtual void printJson(raw_ostream &Out, Store S, const char *NL, unsigned int Space, bool IsDot) const =0
Store getStore() const
Definition: StoreRef.h:46
SubRegion - A region that subsets another larger region.
Definition: MemRegion.h:446
Symbolic value.
Definition: SymExpr.h:30
llvm::iterator_range< symbol_iterator > symbols() const
Definition: SymExpr.h:87
A class responsible for cleaning up unused symbols.
void setReapedStore(StoreRef st)
Set to the value of the symbolic store after StoreManager::removeDeadBindings has been called.
virtual bool VisitMemRegion(const MemRegion *)
virtual bool VisitSymbol(SymbolRef sym)=0
A visitor method invoked by ProgramStateManager::scanReachableSymbols.
SymbolicRegion - A special, "non-concrete" region.
Definition: MemRegion.h:780
TypedValueRegion - An abstract class representing regions having a typed value.
Definition: MemRegion.h:535
The simplest example of a concrete compound value is nonloc::CompoundVal, which represents a concrete...
Definition: SVals.h:333
Value representing integer constant.
Definition: SVals.h:297
While nonloc::CompoundVal covers a few simple use cases, nonloc::LazyCompoundVal is a more performant...
Definition: SVals.h:383
LLVM_ATTRIBUTE_RETURNS_NONNULL const LazyCompoundValData * getCVData() const
Definition: SVals.h:393
LLVM_ATTRIBUTE_RETURNS_NONNULL const TypedValueRegion * getRegion() const
This function itself is immaterial.
Definition: SVals.cpp:194
const void * getStore() const
It might return null.
Definition: SVals.cpp:190
SValBuilder * createSimpleSValBuilder(llvm::BumpPtrAllocator &alloc, ASTContext &context, ProgramStateManager &stateMgr)
void printDynamicTypeInfoJson(raw_ostream &Out, ProgramStateRef State, const char *NL="\n", unsigned int Space=0, bool IsDot=false)
std::unique_ptr< ConstraintManager >(* ConstraintManagerCreator)(ProgramStateManager &, ExprEngine *)
Definition: ProgramState.h:42
std::unique_ptr< StoreManager >(* StoreManagerCreator)(ProgramStateManager &)
Definition: ProgramState.h:44
const void * Store
Store - This opaque type encapsulates an immutable mapping from locations to values.
Definition: StoreRef.h:27
void ProgramStateRetain(const ProgramState *state)
Increments the number of times this state is referenced.
void ProgramStateRelease(const ProgramState *state)
Decrement the number of times this state is referenced.
The JSON file list parser is used to communicate input to InstallAPI.
const FunctionProtoType * T