clang  6.0.0svn
ProgramState.h
Go to the documentation of this file.
1 //== ProgramState.h - Path-sensitive "State" for tracking values -*- C++ -*--=//
2 //
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 //
10 // This file defines the state of the program along the analysisa path.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_CLANG_STATICANALYZER_CORE_PATHSENSITIVE_PROGRAMSTATE_H
15 #define LLVM_CLANG_STATICANALYZER_CORE_PATHSENSITIVE_PROGRAMSTATE_H
16 
17 #include "clang/Basic/LLVM.h"
25 #include "llvm/ADT/FoldingSet.h"
26 #include "llvm/ADT/ImmutableMap.h"
27 #include "llvm/Support/Allocator.h"
28 #include <utility>
29 
30 namespace llvm {
31 class APSInt;
32 }
33 
34 namespace clang {
35 class ASTContext;
36 
37 namespace ento {
38 
39 class CallEvent;
40 class CallEventManager;
41 
42 typedef std::unique_ptr<ConstraintManager>(*ConstraintManagerCreator)(
44 typedef std::unique_ptr<StoreManager>(*StoreManagerCreator)(
45  ProgramStateManager &);
47 
48 //===----------------------------------------------------------------------===//
49 // ProgramStateTrait - Traits used by the Generic Data Map of a ProgramState.
50 //===----------------------------------------------------------------------===//
51 
52 template <typename T> struct ProgramStatePartialTrait;
53 
54 template <typename T> struct ProgramStateTrait {
55  typedef typename T::data_type data_type;
56  static inline void *MakeVoidPtr(data_type D) { return (void*) D; }
57  static inline data_type MakeData(void *const* P) {
58  return P ? (data_type) *P : (data_type) 0;
59  }
60 };
61 
62 /// \class ProgramState
63 /// ProgramState - This class encapsulates:
64 ///
65 /// 1. A mapping from expressions to values (Environment)
66 /// 2. A mapping from locations to values (Store)
67 /// 3. Constraints on symbolic values (GenericDataMap)
68 ///
69 /// Together these represent the "abstract state" of a program.
70 ///
71 /// ProgramState is intended to be used as a functional object; that is,
72 /// once it is created and made "persistent" in a FoldingSet, its
73 /// values will never change.
74 class ProgramState : public llvm::FoldingSetNode {
75 public:
78 
79 private:
80  void operator=(const ProgramState& R) = delete;
81 
82  friend class ProgramStateManager;
83  friend class ExplodedGraph;
84  friend class ExplodedNode;
85 
86  ProgramStateManager *stateMgr;
87  Environment Env; // Maps a Stmt to its current SVal.
88  Store store; // Maps a location to its current value.
89  GenericDataMap GDM; // Custom data stored by a client of this class.
90  unsigned refCount;
91 
92  /// makeWithStore - Return a ProgramState with the same values as the current
93  /// state with the exception of using the specified Store.
94  ProgramStateRef makeWithStore(const StoreRef &store) const;
95 
96  void setStore(const StoreRef &storeRef);
97 
98 public:
99  /// This ctor is used when creating the first ProgramState object.
100  ProgramState(ProgramStateManager *mgr, const Environment& env,
101  StoreRef st, GenericDataMap gdm);
102 
103  /// Copy ctor - We must explicitly define this or else the "Next" ptr
104  /// in FoldingSetNode will also get copied.
105  ProgramState(const ProgramState &RHS);
106 
107  ~ProgramState();
108 
109  /// Return the ProgramStateManager associated with this state.
110  ProgramStateManager &getStateManager() const {
111  return *stateMgr;
112  }
113 
114  /// Return the ConstraintManager.
115  ConstraintManager &getConstraintManager() const;
116 
117  /// getEnvironment - Return the environment associated with this state.
118  /// The environment is the mapping from expressions to values.
119  const Environment& getEnvironment() const { return Env; }
120 
121  /// Return the store associated with this state. The store
122  /// is a mapping from locations to values.
123  Store getStore() const { return store; }
124 
125 
126  /// getGDM - Return the generic data map associated with this state.
127  GenericDataMap getGDM() const { return GDM; }
128 
129  void setGDM(GenericDataMap gdm) { GDM = gdm; }
130 
131  /// Profile - Profile the contents of a ProgramState object for use in a
132  /// FoldingSet. Two ProgramState objects are considered equal if they
133  /// have the same Environment, Store, and GenericDataMap.
134  static void Profile(llvm::FoldingSetNodeID& ID, const ProgramState *V) {
135  V->Env.Profile(ID);
136  ID.AddPointer(V->store);
137  V->GDM.Profile(ID);
138  }
139 
140  /// Profile - Used to profile the contents of this object for inclusion
141  /// in a FoldingSet.
142  void Profile(llvm::FoldingSetNodeID& ID) const {
143  Profile(ID, this);
144  }
145 
146  BasicValueFactory &getBasicVals() const;
147  SymbolManager &getSymbolManager() const;
148 
149  //==---------------------------------------------------------------------==//
150  // Constraints on values.
151  //==---------------------------------------------------------------------==//
152  //
153  // Each ProgramState records constraints on symbolic values. These constraints
154  // are managed using the ConstraintManager associated with a ProgramStateManager.
155  // As constraints gradually accrue on symbolic values, added constraints
156  // may conflict and indicate that a state is infeasible (as no real values
157  // could satisfy all the constraints). This is the principal mechanism
158  // for modeling path-sensitivity in ExprEngine/ProgramState.
159  //
160  // Various "assume" methods form the interface for adding constraints to
161  // symbolic values. A call to 'assume' indicates an assumption being placed
162  // on one or symbolic values. 'assume' methods take the following inputs:
163  //
164  // (1) A ProgramState object representing the current state.
165  //
166  // (2) The assumed constraint (which is specific to a given "assume" method).
167  //
168  // (3) A binary value "Assumption" that indicates whether the constraint is
169  // assumed to be true or false.
170  //
171  // The output of "assume*" is a new ProgramState object with the added constraints.
172  // If no new state is feasible, NULL is returned.
173  //
174 
175  /// Assumes that the value of \p cond is zero (if \p assumption is "false")
176  /// or non-zero (if \p assumption is "true").
177  ///
178  /// This returns a new state with the added constraint on \p cond.
179  /// If no new state is feasible, NULL is returned.
180  ProgramStateRef assume(DefinedOrUnknownSVal cond, bool assumption) const;
181 
182  /// Assumes both "true" and "false" for \p cond, and returns both
183  /// corresponding states (respectively).
184  ///
185  /// This is more efficient than calling assume() twice. Note that one (but not
186  /// both) of the returned states may be NULL.
187  std::pair<ProgramStateRef, ProgramStateRef>
188  assume(DefinedOrUnknownSVal cond) const;
189 
190  ProgramStateRef assumeInBound(DefinedOrUnknownSVal idx,
191  DefinedOrUnknownSVal upperBound,
192  bool assumption,
193  QualType IndexType = QualType()) const;
194 
195  /// Assumes that the value of \p Val is bounded with [\p From; \p To]
196  /// (if \p assumption is "true") or it is fully out of this range
197  /// (if \p assumption is "false").
198  ///
199  /// This returns a new state with the added constraint on \p cond.
200  /// If no new state is feasible, NULL is returned.
201  ProgramStateRef assumeInclusiveRange(DefinedOrUnknownSVal Val,
202  const llvm::APSInt &From,
203  const llvm::APSInt &To,
204  bool assumption) const;
205 
206  /// Assumes given range both "true" and "false" for \p Val, and returns both
207  /// corresponding states (respectively).
208  ///
209  /// This is more efficient than calling assume() twice. Note that one (but not
210  /// both) of the returned states may be NULL.
211  std::pair<ProgramStateRef, ProgramStateRef>
212  assumeInclusiveRange(DefinedOrUnknownSVal Val, const llvm::APSInt &From,
213  const llvm::APSInt &To) const;
214 
215  /// \brief Check if the given SVal is constrained to zero or is a zero
216  /// constant.
217  ConditionTruthVal isNull(SVal V) const;
218 
219  /// Utility method for getting regions.
220  const VarRegion* getRegion(const VarDecl *D, const LocationContext *LC) const;
221 
222  //==---------------------------------------------------------------------==//
223  // Binding and retrieving values to/from the environment and symbolic store.
224  //==---------------------------------------------------------------------==//
225 
226  /// Create a new state by binding the value 'V' to the statement 'S' in the
227  /// state's environment.
228  ProgramStateRef BindExpr(const Stmt *S, const LocationContext *LCtx,
229  SVal V, bool Invalidate = true) const;
230 
231  ProgramStateRef bindLoc(Loc location,
232  SVal V,
233  const LocationContext *LCtx,
234  bool notifyChanges = true) const;
235 
236  ProgramStateRef bindLoc(SVal location, SVal V, const LocationContext *LCtx) const;
237 
238  ProgramStateRef bindDefault(SVal loc, SVal V, const LocationContext *LCtx) const;
239 
240  ProgramStateRef killBinding(Loc LV) const;
241 
242  /// \brief Returns the state with bindings for the given regions
243  /// cleared from the store.
244  ///
245  /// Optionally invalidates global regions as well.
246  ///
247  /// \param Regions the set of regions to be invalidated.
248  /// \param E the expression that caused the invalidation.
249  /// \param BlockCount The number of times the current basic block has been
250  // visited.
251  /// \param CausesPointerEscape the flag is set to true when
252  /// the invalidation entails escape of a symbol (representing a
253  /// pointer). For example, due to it being passed as an argument in a
254  /// call.
255  /// \param IS the set of invalidated symbols.
256  /// \param Call if non-null, the invalidated regions represent parameters to
257  /// the call and should be considered directly invalidated.
258  /// \param ITraits information about special handling for a particular
259  /// region/symbol.
261  invalidateRegions(ArrayRef<const MemRegion *> Regions, const Expr *E,
262  unsigned BlockCount, const LocationContext *LCtx,
263  bool CausesPointerEscape, InvalidatedSymbols *IS = nullptr,
264  const CallEvent *Call = nullptr,
265  RegionAndSymbolInvalidationTraits *ITraits = nullptr) const;
266 
268  invalidateRegions(ArrayRef<SVal> Regions, const Expr *E,
269  unsigned BlockCount, const LocationContext *LCtx,
270  bool CausesPointerEscape, InvalidatedSymbols *IS = nullptr,
271  const CallEvent *Call = nullptr,
272  RegionAndSymbolInvalidationTraits *ITraits = nullptr) const;
273 
274  /// enterStackFrame - Returns the state for entry to the given stack frame,
275  /// preserving the current state.
276  ProgramStateRef enterStackFrame(const CallEvent &Call,
277  const StackFrameContext *CalleeCtx) const;
278 
279  /// Get the lvalue for a variable reference.
280  Loc getLValue(const VarDecl *D, const LocationContext *LC) const;
281 
282  Loc getLValue(const CompoundLiteralExpr *literal,
283  const LocationContext *LC) const;
284 
285  /// Get the lvalue for an ivar reference.
286  SVal getLValue(const ObjCIvarDecl *decl, SVal base) const;
287 
288  /// Get the lvalue for a field reference.
289  SVal getLValue(const FieldDecl *decl, SVal Base) const;
290 
291  /// Get the lvalue for an indirect field reference.
292  SVal getLValue(const IndirectFieldDecl *decl, SVal Base) const;
293 
294  /// Get the lvalue for an array index.
295  SVal getLValue(QualType ElementType, SVal Idx, SVal Base) const;
296 
297  /// Returns the SVal bound to the statement 'S' in the state's environment.
298  SVal getSVal(const Stmt *S, const LocationContext *LCtx) const;
299 
300  SVal getSValAsScalarOrLoc(const Stmt *Ex, const LocationContext *LCtx) const;
301 
302  /// \brief Return the value bound to the specified location.
303  /// Returns UnknownVal() if none found.
304  SVal getSVal(Loc LV, QualType T = QualType()) const;
305 
306  /// Returns the "raw" SVal bound to LV before any value simplfication.
307  SVal getRawSVal(Loc LV, QualType T= QualType()) const;
308 
309  /// \brief Return the value bound to the specified location.
310  /// Returns UnknownVal() if none found.
311  SVal getSVal(const MemRegion* R) const;
312 
313  SVal getSValAsScalarOrLoc(const MemRegion *R) const;
314 
315  /// \brief Visits the symbols reachable from the given SVal using the provided
316  /// SymbolVisitor.
317  ///
318  /// This is a convenience API. Consider using ScanReachableSymbols class
319  /// directly when making multiple scans on the same state with the same
320  /// visitor to avoid repeated initialization cost.
321  /// \sa ScanReachableSymbols
322  bool scanReachableSymbols(SVal val, SymbolVisitor& visitor) const;
323 
324  /// \brief Visits the symbols reachable from the SVals in the given range
325  /// using the provided SymbolVisitor.
326  bool scanReachableSymbols(const SVal *I, const SVal *E,
327  SymbolVisitor &visitor) const;
328 
329  /// \brief Visits the symbols reachable from the regions in the given
330  /// MemRegions range using the provided SymbolVisitor.
331  bool scanReachableSymbols(const MemRegion * const *I,
332  const MemRegion * const *E,
333  SymbolVisitor &visitor) const;
334 
335  template <typename CB> CB scanReachableSymbols(SVal val) const;
336  template <typename CB> CB scanReachableSymbols(const SVal *beg,
337  const SVal *end) const;
338 
339  template <typename CB> CB
340  scanReachableSymbols(const MemRegion * const *beg,
341  const MemRegion * const *end) const;
342 
343  /// Create a new state in which the statement is marked as tainted.
344  ProgramStateRef addTaint(const Stmt *S, const LocationContext *LCtx,
346 
347  /// Create a new state in which the value is marked as tainted.
349 
350  /// Create a new state in which the symbol is marked as tainted.
351  ProgramStateRef addTaint(SymbolRef S,
353 
354  /// Create a new state in which the region symbol is marked as tainted.
355  ProgramStateRef addTaint(const MemRegion *R,
357 
358  /// Create a new state in a which a sub-region of a given symbol is tainted.
359  /// This might be necessary when referring to regions that can not have an
360  /// individual symbol, e.g. if they are represented by the default binding of
361  /// a LazyCompoundVal.
362  ProgramStateRef addPartialTaint(SymbolRef ParentSym,
363  const SubRegion *SubRegion,
365 
366  /// Check if the statement is tainted in the current state.
367  bool isTainted(const Stmt *S, const LocationContext *LCtx,
369  bool isTainted(SVal V, TaintTagType Kind = TaintTagGeneric) const;
370  bool isTainted(SymbolRef Sym, TaintTagType Kind = TaintTagGeneric) const;
371  bool isTainted(const MemRegion *Reg, TaintTagType Kind=TaintTagGeneric) const;
372 
373  //==---------------------------------------------------------------------==//
374  // Accessing the Generic Data Map (GDM).
375  //==---------------------------------------------------------------------==//
376 
377  void *const* FindGDM(void *K) const;
378 
379  template<typename T>
380  ProgramStateRef add(typename ProgramStateTrait<T>::key_type K) const;
381 
382  template <typename T>
384  get() const {
386  }
387 
388  template<typename T>
390  get(typename ProgramStateTrait<T>::key_type key) const {
391  void *const* d = FindGDM(ProgramStateTrait<T>::GDMIndex());
393  }
394 
395  template <typename T>
396  typename ProgramStateTrait<T>::context_type get_context() const;
397 
398 
399  template<typename T>
400  ProgramStateRef remove(typename ProgramStateTrait<T>::key_type K) const;
401 
402  template<typename T>
404  typename ProgramStateTrait<T>::context_type C) const;
405  template <typename T>
406  ProgramStateRef remove() const;
407 
408  template<typename T>
409  ProgramStateRef set(typename ProgramStateTrait<T>::data_type D) const;
410 
411  template<typename T>
413  typename ProgramStateTrait<T>::value_type E) const;
414 
415  template<typename T>
418  typename ProgramStateTrait<T>::context_type C) const;
419 
420  template<typename T>
421  bool contains(typename ProgramStateTrait<T>::key_type key) const {
422  void *const* d = FindGDM(ProgramStateTrait<T>::GDMIndex());
424  }
425 
426  // Pretty-printing.
427  void print(raw_ostream &Out, const char *nl = "\n",
428  const char *sep = "") const;
429  void printDOT(raw_ostream &Out) const;
430  void printTaint(raw_ostream &Out, const char *nl = "\n",
431  const char *sep = "") const;
432 
433  void dump() const;
434  void dumpTaint() const;
435 
436 private:
437  friend void ProgramStateRetain(const ProgramState *state);
438  friend void ProgramStateRelease(const ProgramState *state);
439 
440  /// \sa invalidateValues()
441  /// \sa invalidateRegions()
443  invalidateRegionsImpl(ArrayRef<SVal> Values,
444  const Expr *E, unsigned BlockCount,
445  const LocationContext *LCtx,
446  bool ResultsInSymbolEscape,
447  InvalidatedSymbols *IS,
449  const CallEvent *Call) const;
450 };
451 
452 //===----------------------------------------------------------------------===//
453 // ProgramStateManager - Factory object for ProgramStates.
454 //===----------------------------------------------------------------------===//
455 
456 class ProgramStateManager {
457  friend class ProgramState;
458  friend void ProgramStateRelease(const ProgramState *state);
459 private:
460  /// Eng - The SubEngine that owns this state manager.
461  SubEngine *Eng; /* Can be null. */
462 
463  EnvironmentManager EnvMgr;
464  std::unique_ptr<StoreManager> StoreMgr;
465  std::unique_ptr<ConstraintManager> ConstraintMgr;
466 
467  ProgramState::GenericDataMap::Factory GDMFactory;
468  TaintedSubRegions::Factory TSRFactory;
469 
470  typedef llvm::DenseMap<void*,std::pair<void*,void (*)(void*)> > GDMContextsTy;
471  GDMContextsTy GDMContexts;
472 
473  /// StateSet - FoldingSet containing all the states created for analyzing
474  /// a particular function. This is used to unique states.
475  llvm::FoldingSet<ProgramState> StateSet;
476 
477  /// Object that manages the data for all created SVals.
478  std::unique_ptr<SValBuilder> svalBuilder;
479 
480  /// Manages memory for created CallEvents.
481  std::unique_ptr<CallEventManager> CallEventMgr;
482 
483  /// A BumpPtrAllocator to allocate states.
484  llvm::BumpPtrAllocator &Alloc;
485 
486  /// A vector of ProgramStates that we can reuse.
487  std::vector<ProgramState *> freeStates;
488 
489 public:
490  ProgramStateManager(ASTContext &Ctx,
491  StoreManagerCreator CreateStoreManager,
492  ConstraintManagerCreator CreateConstraintManager,
493  llvm::BumpPtrAllocator& alloc,
494  SubEngine *subeng);
495 
496  ~ProgramStateManager();
497 
498  ProgramStateRef getInitialState(const LocationContext *InitLoc);
499 
500  ASTContext &getContext() { return svalBuilder->getContext(); }
501  const ASTContext &getContext() const { return svalBuilder->getContext(); }
502 
504  return svalBuilder->getBasicValueFactory();
505  }
506 
508  return *svalBuilder;
509  }
510 
512  return svalBuilder->getSymbolManager();
513  }
515  return svalBuilder->getSymbolManager();
516  }
517 
518  llvm::BumpPtrAllocator& getAllocator() { return Alloc; }
519 
521  return svalBuilder->getRegionManager();
522  }
524  return svalBuilder->getRegionManager();
525  }
526 
527  CallEventManager &getCallEventManager() { return *CallEventMgr; }
528 
529  StoreManager& getStoreManager() { return *StoreMgr; }
530  ConstraintManager& getConstraintManager() { return *ConstraintMgr; }
531  SubEngine* getOwningEngine() { return Eng; }
532 
533  ProgramStateRef removeDeadBindings(ProgramStateRef St,
534  const StackFrameContext *LCtx,
535  SymbolReaper& SymReaper);
536 
537 public:
538 
539  SVal ArrayToPointer(Loc Array, QualType ElementTy) {
540  return StoreMgr->ArrayToPointer(Array, ElementTy);
541  }
542 
543  // Methods that manipulate the GDM.
544  ProgramStateRef addGDM(ProgramStateRef St, void *Key, void *Data);
545  ProgramStateRef removeGDM(ProgramStateRef state, void *Key);
546 
547  // Methods that query & manipulate the Store.
548 
550  StoreMgr->iterBindings(state->getStore(), F);
551  }
552 
553  ProgramStateRef getPersistentState(ProgramState &Impl);
554  ProgramStateRef getPersistentStateWithGDM(ProgramStateRef FromState,
555  ProgramStateRef GDMState);
556 
558  return S1->Env == S2->Env;
559  }
560 
562  return S1->store == S2->store;
563  }
564 
565  //==---------------------------------------------------------------------==//
566  // Generic Data Map methods.
567  //==---------------------------------------------------------------------==//
568  //
569  // ProgramStateManager and ProgramState support a "generic data map" that allows
570  // different clients of ProgramState objects to embed arbitrary data within a
571  // ProgramState object. The generic data map is essentially an immutable map
572  // from a "tag" (that acts as the "key" for a client) and opaque values.
573  // Tags/keys and values are simply void* values. The typical way that clients
574  // generate unique tags are by taking the address of a static variable.
575  // Clients are responsible for ensuring that data values referred to by a
576  // the data pointer are immutable (and thus are essentially purely functional
577  // data).
578  //
579  // The templated methods below use the ProgramStateTrait<T> class
580  // to resolve keys into the GDM and to return data values to clients.
581  //
582 
583  // Trait based GDM dispatch.
584  template <typename T>
586  return addGDM(st, ProgramStateTrait<T>::GDMIndex(),
588  }
589 
590  template<typename T>
595 
596  return addGDM(st, ProgramStateTrait<T>::GDMIndex(),
598  }
599 
600  template <typename T>
604  return addGDM(st, ProgramStateTrait<T>::GDMIndex(),
606  }
607 
608  template <typename T>
612 
613  return addGDM(st, ProgramStateTrait<T>::GDMIndex(),
615  }
616 
617  template <typename T>
619  return removeGDM(st, ProgramStateTrait<T>::GDMIndex());
620  }
621 
622  void *FindGDMContext(void *index,
623  void *(*CreateContext)(llvm::BumpPtrAllocator&),
624  void (*DeleteContext)(void*));
625 
626  template <typename T>
628  void *p = FindGDMContext(ProgramStateTrait<T>::GDMIndex(),
631 
633  }
634 
636  ConstraintMgr->EndPath(St);
637  }
638 };
639 
640 
641 //===----------------------------------------------------------------------===//
642 // Out-of-line method definitions for ProgramState.
643 //===----------------------------------------------------------------------===//
644 
645 inline ConstraintManager &ProgramState::getConstraintManager() const {
646  return stateMgr->getConstraintManager();
647 }
648 
649 inline const VarRegion* ProgramState::getRegion(const VarDecl *D,
650  const LocationContext *LC) const
651 {
652  return getStateManager().getRegionManager().getVarRegion(D, LC);
653 }
654 
655 inline ProgramStateRef ProgramState::assume(DefinedOrUnknownSVal Cond,
656  bool Assumption) const {
657  if (Cond.isUnknown())
658  return this;
659 
660  return getStateManager().ConstraintMgr
661  ->assume(this, Cond.castAs<DefinedSVal>(), Assumption);
662 }
663 
664 inline std::pair<ProgramStateRef , ProgramStateRef >
665 ProgramState::assume(DefinedOrUnknownSVal Cond) const {
666  if (Cond.isUnknown())
667  return std::make_pair(this, this);
668 
669  return getStateManager().ConstraintMgr
670  ->assumeDual(this, Cond.castAs<DefinedSVal>());
671 }
672 
673 inline ProgramStateRef ProgramState::assumeInclusiveRange(
674  DefinedOrUnknownSVal Val, const llvm::APSInt &From, const llvm::APSInt &To,
675  bool Assumption) const {
676  if (Val.isUnknown())
677  return this;
678 
679  assert(Val.getAs<NonLoc>() && "Only NonLocs are supported!");
680 
681  return getStateManager().ConstraintMgr->assumeInclusiveRange(
682  this, Val.castAs<NonLoc>(), From, To, Assumption);
683 }
684 
685 inline std::pair<ProgramStateRef, ProgramStateRef>
686 ProgramState::assumeInclusiveRange(DefinedOrUnknownSVal Val,
687  const llvm::APSInt &From,
688  const llvm::APSInt &To) const {
689  if (Val.isUnknown())
690  return std::make_pair(this, this);
691 
692  assert(Val.getAs<NonLoc>() && "Only NonLocs are supported!");
693 
694  return getStateManager().ConstraintMgr->assumeInclusiveRangeDual(
695  this, Val.castAs<NonLoc>(), From, To);
696 }
697 
698 inline ProgramStateRef ProgramState::bindLoc(SVal LV, SVal V, const LocationContext *LCtx) const {
699  if (Optional<Loc> L = LV.getAs<Loc>())
700  return bindLoc(*L, V, LCtx);
701  return this;
702 }
703 
704 inline Loc ProgramState::getLValue(const VarDecl *VD,
705  const LocationContext *LC) const {
706  return getStateManager().StoreMgr->getLValueVar(VD, LC);
707 }
708 
709 inline Loc ProgramState::getLValue(const CompoundLiteralExpr *literal,
710  const LocationContext *LC) const {
711  return getStateManager().StoreMgr->getLValueCompoundLiteral(literal, LC);
712 }
713 
714 inline SVal ProgramState::getLValue(const ObjCIvarDecl *D, SVal Base) const {
715  return getStateManager().StoreMgr->getLValueIvar(D, Base);
716 }
717 
718 inline SVal ProgramState::getLValue(const FieldDecl *D, SVal Base) const {
719  return getStateManager().StoreMgr->getLValueField(D, Base);
720 }
721 
722 inline SVal ProgramState::getLValue(const IndirectFieldDecl *D,
723  SVal Base) const {
724  StoreManager &SM = *getStateManager().StoreMgr;
725  for (const auto *I : D->chain()) {
726  Base = SM.getLValueField(cast<FieldDecl>(I), Base);
727  }
728 
729  return Base;
730 }
731 
732 inline SVal ProgramState::getLValue(QualType ElementType, SVal Idx, SVal Base) const{
733  if (Optional<NonLoc> N = Idx.getAs<NonLoc>())
734  return getStateManager().StoreMgr->getLValueElement(ElementType, *N, Base);
735  return UnknownVal();
736 }
737 
738 inline SVal ProgramState::getSVal(const Stmt *Ex,
739  const LocationContext *LCtx) const{
740  return Env.getSVal(EnvironmentEntry(Ex, LCtx),
741  *getStateManager().svalBuilder);
742 }
743 
744 inline SVal
745 ProgramState::getSValAsScalarOrLoc(const Stmt *S,
746  const LocationContext *LCtx) const {
747  if (const Expr *Ex = dyn_cast<Expr>(S)) {
748  QualType T = Ex->getType();
749  if (Ex->isGLValue() || Loc::isLocType(T) ||
751  return getSVal(S, LCtx);
752  }
753 
754  return UnknownVal();
755 }
756 
757 inline SVal ProgramState::getRawSVal(Loc LV, QualType T) const {
758  return getStateManager().StoreMgr->getBinding(getStore(), LV, T);
759 }
760 
761 inline SVal ProgramState::getSVal(const MemRegion* R) const {
762  return getStateManager().StoreMgr->getBinding(getStore(),
763  loc::MemRegionVal(R));
764 }
765 
766 inline BasicValueFactory &ProgramState::getBasicVals() const {
767  return getStateManager().getBasicVals();
768 }
769 
770 inline SymbolManager &ProgramState::getSymbolManager() const {
771  return getStateManager().getSymbolManager();
772 }
773 
774 template<typename T>
775 ProgramStateRef ProgramState::add(typename ProgramStateTrait<T>::key_type K) const {
776  return getStateManager().add<T>(this, K, get_context<T>());
777 }
778 
779 template <typename T>
780 typename ProgramStateTrait<T>::context_type ProgramState::get_context() const {
781  return getStateManager().get_context<T>();
782 }
783 
784 template<typename T>
785 ProgramStateRef ProgramState::remove(typename ProgramStateTrait<T>::key_type K) const {
786  return getStateManager().remove<T>(this, K, get_context<T>());
787 }
788 
789 template<typename T>
790 ProgramStateRef ProgramState::remove(typename ProgramStateTrait<T>::key_type K,
791  typename ProgramStateTrait<T>::context_type C) const {
792  return getStateManager().remove<T>(this, K, C);
793 }
794 
795 template <typename T>
796 ProgramStateRef ProgramState::remove() const {
797  return getStateManager().remove<T>(this);
798 }
799 
800 template<typename T>
801 ProgramStateRef ProgramState::set(typename ProgramStateTrait<T>::data_type D) const {
802  return getStateManager().set<T>(this, D);
803 }
804 
805 template<typename T>
806 ProgramStateRef ProgramState::set(typename ProgramStateTrait<T>::key_type K,
807  typename ProgramStateTrait<T>::value_type E) const {
808  return getStateManager().set<T>(this, K, E, get_context<T>());
809 }
810 
811 template<typename T>
812 ProgramStateRef ProgramState::set(typename ProgramStateTrait<T>::key_type K,
814  typename ProgramStateTrait<T>::context_type C) const {
815  return getStateManager().set<T>(this, K, E, C);
816 }
817 
818 template <typename CB>
819 CB ProgramState::scanReachableSymbols(SVal val) const {
820  CB cb(this);
821  scanReachableSymbols(val, cb);
822  return cb;
823 }
824 
825 template <typename CB>
826 CB ProgramState::scanReachableSymbols(const SVal *beg, const SVal *end) const {
827  CB cb(this);
828  scanReachableSymbols(beg, end, cb);
829  return cb;
830 }
831 
832 template <typename CB>
833 CB ProgramState::scanReachableSymbols(const MemRegion * const *beg,
834  const MemRegion * const *end) const {
835  CB cb(this);
836  scanReachableSymbols(beg, end, cb);
837  return cb;
838 }
839 
840 /// \class ScanReachableSymbols
841 /// A utility class that visits the reachable symbols using a custom
842 /// SymbolVisitor. Terminates recursive traversal when the visitor function
843 /// returns false.
846 
847  VisitedItems visited;
849  SymbolVisitor &visitor;
850 public:
852  : state(std::move(st)), visitor(v) {}
853 
854  bool scan(nonloc::LazyCompoundVal val);
855  bool scan(nonloc::CompoundVal val);
856  bool scan(SVal val);
857  bool scan(const MemRegion *R);
858  bool scan(const SymExpr *sym);
859 };
860 
861 } // end ento namespace
862 
863 } // end clang namespace
864 
865 #endif
const Environment & getEnvironment() const
getEnvironment - Return the environment associated with this state.
Definition: ProgramState.h:119
A (possibly-)qualified type.
Definition: Type.h:614
MemRegion - The root abstract class for all memory regions.
Definition: MemRegion.h:79
DominatorTree GraphTraits specialization so the DominatorTree can be iterable by generic graph iterat...
Definition: Dominators.h:26
Stmt - This represents one statement.
Definition: Stmt.h:60
Information about invalidation for a particular region/symbol.
Definition: MemRegion.h:1383
BasicValueFactory & getBasicVals()
Definition: ProgramState.h:503
bool haveEqualStores(ProgramStateRef S1, ProgramStateRef S2)
Definition: ProgramState.h:561
bool contains(typename ProgramStateTrait< T >::key_type key) const
Definition: ProgramState.h:421
Manages the lifetime of CallEvent objects.
Definition: CallEvent.h:982
llvm::ImmutableSet< llvm::APSInt * > IntSetTy
Definition: ProgramState.h:76
StringRef P
const void * Store
Store - This opaque type encapsulates an immutable mapping from locations to values.
Definition: StoreRef.h:26
A utility class that visits the reachable symbols using a custom SymbolVisitor.
Definition: ProgramState.h:844
bool haveEqualEnvironments(ProgramStateRef S1, ProgramStateRef S2)
Definition: ProgramState.h:557
VarDecl - An instance of this class is created to represent a variable declaration or definition...
Definition: Decl.h:771
CompoundLiteralExpr - [C99 6.5.2.5].
Definition: Expr.h:2637
Store getStore() const
Return the store associated with this state.
Definition: ProgramState.h:123
const SymbolManager & getSymbolManager() const
Definition: ProgramState.h:514
Symbolic value.
Definition: SymExpr.h:29
ProgramStateRef add(ProgramStateRef st, typename ProgramStateTrait< T >::key_type K, typename ProgramStateTrait< T >::context_type C)
Definition: ProgramState.h:601
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:128
FieldDecl - An instance of this class is created by Sema::ActOnField to represent a member of a struc...
Definition: Decl.h:2382
Definition: Format.h:1821
std::unique_ptr< StoreManager >(* StoreManagerCreator)(ProgramStateManager &)
Definition: ProgramState.h:44
MemRegionManager & getRegionManager()
Definition: ProgramState.h:520
const internal::VariadicAllOfMatcher< Decl > decl
Matches declarations.
Definition: ASTMatchers.h:281
void EndPath(ProgramStateRef St)
Definition: ProgramState.h:635
i32 captured_struct **param SharedsTy A type which contains references the shared variables *param Shareds Context with the list of shared variables from the p *TaskFunction *param Data Additional data for task generation like final * state
bool isIntegralOrEnumerationType() const
Determine whether this type is an integral or enumeration type.
Definition: Type.h:6013
ProgramStateManager & getStateManager() const
Return the ProgramStateManager associated with this state.
Definition: ProgramState.h:110
GenericDataMap getGDM() const
getGDM - Return the generic data map associated with this state.
Definition: ProgramState.h:127
static void dump(llvm::raw_ostream &OS, StringRef FunctionName, ArrayRef< CounterExpression > Expressions, ArrayRef< CounterMappingRegion > Regions)
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified...
ArrayRef< NamedDecl * > chain() const
Definition: Decl.h:2643
bool isUnknown() const
Definition: SVals.h:128
virtual SVal getLValueField(const FieldDecl *D, SVal Base)
Definition: Store.h:121
std::unique_ptr< ConstraintManager >(* ConstraintManagerCreator)(ProgramStateManager &, SubEngine *)
Definition: ProgramState.h:42
llvm::ImmutableMap< void *, void * > GenericDataMap
Definition: ProgramState.h:77
void Profile(llvm::FoldingSetNodeID &ID) const
Profile - Used to profile the contents of this object for inclusion in a FoldingSet.
Definition: ProgramState.h:142
unsigned TaintTagType
The type of taint, which helps to differentiate between different types of taint. ...
Definition: TaintTag.h:22
ProgramState - This class encapsulates:
Definition: ProgramState.h:74
Expr - This represents one expression.
Definition: Expr.h:106
const FunctionProtoType * T
do v
Definition: arm_acle.h:78
const SourceManager & SM
Definition: Format.cpp:1308
Optional< T > getAs() const
Convert to the specified SVal type, returning None if this SVal is not of the desired type...
Definition: SVals.h:100
llvm::BumpPtrAllocator & getAllocator()
Definition: ProgramState.h:518
Kind
static void Profile(llvm::FoldingSetNodeID &ID, const Environment *env)
Profile - Profile the contents of an Environment object for use in a FoldingSet.
Definition: Environment.h:82
CallEventManager & getCallEventManager()
Definition: ProgramState.h:527
An entry in the environment consists of a Stmt and an LocationContext.
Definition: Environment.h:35
SVal - This represents a symbolic expression, which can be either an L-value or an R-value...
Definition: SVals.h:63
ProgramStateTrait< T >::context_type get_context()
Definition: ProgramState.h:627
static const TaintTagType TaintTagGeneric
Definition: TaintTag.h:23
A class responsible for cleaning up unused symbols.
ScanReachableSymbols(ProgramStateRef st, SymbolVisitor &v)
Definition: ProgramState.h:851
llvm::ImmutableMap< const SubRegion *, TaintTagType > TaintedSubRegions
Definition: ProgramState.h:46
static void * MakeVoidPtr(data_type D)
Definition: ProgramState.h:56
SymbolManager & getSymbolManager()
Definition: ProgramState.h:511
An immutable map from EnvironemntEntries to SVals.
Definition: Environment.h:56
Dataflow Directional Tag Classes.
SVal ArrayToPointer(Loc Array, QualType ElementTy)
Definition: ProgramState.h:539
void ProgramStateRelease(const ProgramState *state)
Decrement the number of times this state is referenced.
static data_type MakeData(void *const *P)
Definition: ProgramState.h:57
IndirectFieldDecl - An instance of this class is created to represent a field injected from an anonym...
Definition: Decl.h:2624
Represents an abstract call to a function or method along a particular path.
Definition: CallEvent.h:140
ConstraintManager & getConstraintManager()
Definition: ProgramState.h:530
T castAs() const
Convert to the specified SVal type, asserting that this SVal is of the desired type.
Definition: SVals.h:92
SubRegion - A region that subsets another larger region.
Definition: MemRegion.h:419
void ProgramStateRetain(const ProgramState *state)
Increments the number of times this state is referenced.
const MemRegionManager & getRegionManager() const
Definition: ProgramState.h:523
ObjCIvarDecl - Represents an ObjC instance variable.
Definition: DeclObjC.h:1866
const ASTContext & getContext() const
Definition: ProgramState.h:501
static void Profile(llvm::FoldingSetNodeID &ID, const ProgramState *V)
Profile - Profile the contents of a ProgramState object for use in a FoldingSet.
Definition: ProgramState.h:134
void iterBindings(ProgramStateRef state, StoreManager::BindingsHandler &F)
Definition: ProgramState.h:549
void setGDM(GenericDataMap gdm)
Definition: ProgramState.h:129