ProgramState.h revision e54cfc7b9990acffd0a8a4ba381717b4bb9f3011
1ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek//== ProgramState.h - Path-sensitive "State" for tracking values -*- C++ -*--=// 2ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek// 3ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek// The LLVM Compiler Infrastructure 4ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek// 5ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek// This file is distributed under the University of Illinois Open Source 6ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek// License. See LICENSE.TXT for details. 7ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek// 8ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek//===----------------------------------------------------------------------===// 9ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek// 10ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek// This file defines SymbolRef, ExprBindKey, and ProgramState*. 11ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek// 12ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek//===----------------------------------------------------------------------===// 13ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 14ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek#ifndef LLVM_CLANG_GR_VALUESTATE_H 15ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek#define LLVM_CLANG_GR_VALUESTATE_H 16ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 17ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek#include "clang/Basic/LLVM.h" 18ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/ConstraintManager.h" 19ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/Environment.h" 20ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/Store.h" 21ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/SValBuilder.h" 228bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState_Fwd.h" 23ceac1d6e0521161adf7ac9834b1a7ad79d73fea4Anna Zaks#include "clang/StaticAnalyzer/Core/PathSensitive/TaintTag.h" 24ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek#include "llvm/ADT/PointerIntPair.h" 25ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek#include "llvm/ADT/FoldingSet.h" 26ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek#include "llvm/ADT/ImmutableMap.h" 27ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 28ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremeneknamespace llvm { 29ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekclass APSInt; 30ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekclass BumpPtrAllocator; 31ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 32ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 33ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremeneknamespace clang { 34ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekclass ASTContext; 35ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 36ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremeneknamespace ento { 37ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 38740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass CallEvent; 398bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek 40ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektypedef ConstraintManager* (*ConstraintManagerCreator)(ProgramStateManager&, 41ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SubEngine&); 42ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektypedef StoreManager* (*StoreManagerCreator)(ProgramStateManager&); 43ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 44ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek//===----------------------------------------------------------------------===// 45ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek// ProgramStateTrait - Traits used by the Generic Data Map of a ProgramState. 46ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek//===----------------------------------------------------------------------===// 47ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 48ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate <typename T> struct ProgramStatePartialTrait; 49ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 50ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate <typename T> struct ProgramStateTrait { 51ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typedef typename T::data_type data_type; 52ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek static inline void *MakeVoidPtr(data_type D) { return (void*) D; } 53ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek static inline data_type MakeData(void *const* P) { 54ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return P ? (data_type) *P : (data_type) 0; 55ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 56ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek}; 57ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 585f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks/// \class ProgramState 59ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// ProgramState - This class encapsulates: 60ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// 61ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// 1. A mapping from expressions to values (Environment) 62ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// 2. A mapping from locations to values (Store) 63ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// 3. Constraints on symbolic values (GenericDataMap) 64ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// 65ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// Together these represent the "abstract state" of a program. 66ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// 67ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// ProgramState is intended to be used as a functional object; that is, 68ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// once it is created and made "persistent" in a FoldingSet, its 69ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// values will never change. 70ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekclass ProgramState : public llvm::FoldingSetNode { 71ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekpublic: 72ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typedef llvm::ImmutableSet<llvm::APSInt*> IntSetTy; 73ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typedef llvm::ImmutableMap<void*, void*> GenericDataMap; 74ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 75ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekprivate: 76ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void operator=(const ProgramState& R) const; // Do not implement. 77ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 78ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek friend class ProgramStateManager; 79ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek friend class ExplodedGraph; 80ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek friend class ExplodedNode; 81ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 82ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramStateManager *stateMgr; 83ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek Environment Env; // Maps a Stmt to its current SVal. 84ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek Store store; // Maps a location to its current value. 85ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek GenericDataMap GDM; // Custom data stored by a client of this class. 86ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek unsigned refCount; 87ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 88ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// makeWithStore - Return a ProgramState with the same values as the current 89ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// state with the exception of using the specified Store. 908bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef makeWithStore(const StoreRef &store) const; 91ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 92ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void setStore(const StoreRef &storeRef); 93ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 94ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekpublic: 95ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// This ctor is used when creating the first ProgramState object. 96ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramState(ProgramStateManager *mgr, const Environment& env, 97ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek StoreRef st, GenericDataMap gdm); 98ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 99ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Copy ctor - We must explicitly define this or else the "Next" ptr 100ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// in FoldingSetNode will also get copied. 101ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramState(const ProgramState &RHS); 102ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 103ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ~ProgramState(); 104ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 105ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Return the ProgramStateManager associated with this state. 106ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramStateManager &getStateManager() const { return *stateMgr; } 107ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 108ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// getEnvironment - Return the environment associated with this state. 109ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// The environment is the mapping from expressions to values. 110ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const Environment& getEnvironment() const { return Env; } 111ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 112ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Return the store associated with this state. The store 113ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// is a mapping from locations to values. 114ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek Store getStore() const { return store; } 115ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 116ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 117ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// getGDM - Return the generic data map associated with this state. 118ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek GenericDataMap getGDM() const { return GDM; } 119ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 120ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void setGDM(GenericDataMap gdm) { GDM = gdm; } 121ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 122ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Profile - Profile the contents of a ProgramState object for use in a 123ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// FoldingSet. Two ProgramState objects are considered equal if they 124ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// have the same Environment, Store, and GenericDataMap. 125a5888f61be9f8d76e9b48a453dbced50523bd2e0Argyrios Kyrtzidis static void Profile(llvm::FoldingSetNodeID& ID, const ProgramState *V) { 126ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek V->Env.Profile(ID); 127ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ID.AddPointer(V->store); 128ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek V->GDM.Profile(ID); 129ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 130ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 131ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Profile - Used to profile the contents of this object for inclusion 132ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// in a FoldingSet. 133ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void Profile(llvm::FoldingSetNodeID& ID) const { 134ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek Profile(ID, this); 135ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 136ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 137ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek BasicValueFactory &getBasicVals() const; 138ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SymbolManager &getSymbolManager() const; 139ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 140ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek //==---------------------------------------------------------------------==// 141ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Constraints on values. 142ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek //==---------------------------------------------------------------------==// 143ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // 144ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Each ProgramState records constraints on symbolic values. These constraints 145ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // are managed using the ConstraintManager associated with a ProgramStateManager. 146ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // As constraints gradually accrue on symbolic values, added constraints 147ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // may conflict and indicate that a state is infeasible (as no real values 148ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // could satisfy all the constraints). This is the principal mechanism 149ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // for modeling path-sensitivity in ExprEngine/ProgramState. 150ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // 151ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Various "assume" methods form the interface for adding constraints to 152ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // symbolic values. A call to 'assume' indicates an assumption being placed 153ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // on one or symbolic values. 'assume' methods take the following inputs: 154ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // 155ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // (1) A ProgramState object representing the current state. 156ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // 157ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // (2) The assumed constraint (which is specific to a given "assume" method). 158ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // 159ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // (3) A binary value "Assumption" that indicates whether the constraint is 160ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // assumed to be true or false. 161ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // 162ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // The output of "assume*" is a new ProgramState object with the added constraints. 163ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // If no new state is feasible, NULL is returned. 164ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // 165ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 1668bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef assume(DefinedOrUnknownSVal cond, bool assumption) const; 167ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 168ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// This method assumes both "true" and "false" for 'cond', and 169ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// returns both corresponding states. It's shorthand for doing 170ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// 'assume' twice. 1718bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek std::pair<ProgramStateRef , ProgramStateRef > 172ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek assume(DefinedOrUnknownSVal cond) const; 173ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 1748bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef assumeInBound(DefinedOrUnknownSVal idx, 175ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek DefinedOrUnknownSVal upperBound, 176af5f550de34525b27f0ff31dafce792caf8158b6Anna Zaks bool assumption, 177af5f550de34525b27f0ff31dafce792caf8158b6Anna Zaks QualType IndexType = QualType()) const; 178ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 1795f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// Utility method for getting regions. 180ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const VarRegion* getRegion(const VarDecl *D, const LocationContext *LC) const; 181ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 182ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek //==---------------------------------------------------------------------==// 183ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Binding and retrieving values to/from the environment and symbolic store. 184ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek //==---------------------------------------------------------------------==// 185ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 186ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// BindCompoundLiteral - Return the state that has the bindings currently 187ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// in this state plus the bindings for the CompoundLiteral. 1888bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef bindCompoundLiteral(const CompoundLiteralExpr *CL, 189ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const LocationContext *LC, 190ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SVal V) const; 191ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 192ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Create a new state by binding the value 'V' to the statement 'S' in the 193ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// state's environment. 1948bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef BindExpr(const Stmt *S, const LocationContext *LCtx, 1955eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal V, bool Invalidate = true) const; 196ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 197ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Create a new state by binding the value 'V' and location 'locaton' to the 198ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// statement 'S' in the state's environment. 1998bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef bindExprAndLocation(const Stmt *S, 2005eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LCtx, 2015eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal location, SVal V) const; 202ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 2038bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef bindDecl(const VarRegion *VR, SVal V) const; 204ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 2058bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef bindDeclWithNoInit(const VarRegion *VR) const; 206ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 2078bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef bindLoc(Loc location, SVal V) const; 208ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 2098bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef bindLoc(SVal location, SVal V) const; 210ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 2118bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef bindDefault(SVal loc, SVal V) const; 212ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 2138bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef unbindLoc(Loc LV) const; 214ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 215ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// invalidateRegions - Returns the state with bindings for the given regions 216ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// cleared from the store. The regions are provided as a continuous array 217ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// from Begin to End. Optionally invalidates global regions as well. 2188bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef invalidateRegions(ArrayRef<const MemRegion *> Regions, 219eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks const Expr *E, unsigned BlockCount, 2203133f79cf451e6302dd05262b4bb53a3e4fd6300Ted Kremenek const LocationContext *LCtx, 221eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks StoreManager::InvalidatedSymbols *IS = 0, 222740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const CallEvent *Call = 0) const; 223ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 224ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// enterStackFrame - Returns the state for entry to the given stack frame, 225ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// preserving the current state. 226e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose ProgramStateRef enterStackFrame(const CallEvent &Call, 227e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose const StackFrameContext *CalleeCtx) const; 228ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 229ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Get the lvalue for a variable reference. 230ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek Loc getLValue(const VarDecl *D, const LocationContext *LC) const; 231ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 232ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek Loc getLValue(const CompoundLiteralExpr *literal, 233ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const LocationContext *LC) const; 234ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 235ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Get the lvalue for an ivar reference. 236ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SVal getLValue(const ObjCIvarDecl *decl, SVal base) const; 237ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 238ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Get the lvalue for a field reference. 239ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SVal getLValue(const FieldDecl *decl, SVal Base) const; 240ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 241ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Get the lvalue for an array index. 242ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SVal getLValue(QualType ElementType, SVal Idx, SVal Base) const; 243ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 244ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const llvm::APSInt *getSymVal(SymbolRef sym) const; 245ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 246ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Returns the SVal bound to the statement 'S' in the state's environment. 2475eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal getSVal(const Stmt *S, const LocationContext *LCtx, 2485eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek bool useOnlyDirectBindings = false) const; 249ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 2505eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal getSValAsScalarOrLoc(const Stmt *Ex, const LocationContext *LCtx) const; 251ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 2524335a48214dcbb258e08c8867c45648e25edb2ecAnna Zaks /// \brief Return the value bound to the specified location. 2534335a48214dcbb258e08c8867c45648e25edb2ecAnna Zaks /// Returns UnknownVal() if none found. 254ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SVal getSVal(Loc LV, QualType T = QualType()) const; 255ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 256ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Returns the "raw" SVal bound to LV before any value simplfication. 257ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SVal getRawSVal(Loc LV, QualType T= QualType()) const; 258ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 2594335a48214dcbb258e08c8867c45648e25edb2ecAnna Zaks /// \brief Return the value bound to the specified location. 2604335a48214dcbb258e08c8867c45648e25edb2ecAnna Zaks /// Returns UnknownVal() if none found. 261ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SVal getSVal(const MemRegion* R) const; 262ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 263ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SVal getSValAsScalarOrLoc(const MemRegion *R) const; 264ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 2655f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// \brief Visits the symbols reachable from the given SVal using the provided 2665f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// SymbolVisitor. 2675f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// 2685f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// This is a convenience API. Consider using ScanReachableSymbols class 2695f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// directly when making multiple scans on the same state with the same 2705f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// visitor to avoid repeated initialization cost. 2715f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// \sa ScanReachableSymbols 272ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek bool scanReachableSymbols(SVal val, SymbolVisitor& visitor) const; 273ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 2745f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// \brief Visits the symbols reachable from the SVals in the given range 2755f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// using the provided SymbolVisitor. 276ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek bool scanReachableSymbols(const SVal *I, const SVal *E, 277ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SymbolVisitor &visitor) const; 278ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 2795f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// \brief Visits the symbols reachable from the regions in the given 2805f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// MemRegions range using the provided SymbolVisitor. 281ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek bool scanReachableSymbols(const MemRegion * const *I, 282ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const MemRegion * const *E, 283ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SymbolVisitor &visitor) const; 284ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 285ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename CB> CB scanReachableSymbols(SVal val) const; 286ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename CB> CB scanReachableSymbols(const SVal *beg, 287ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const SVal *end) const; 288ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 289ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename CB> CB 290ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek scanReachableSymbols(const MemRegion * const *beg, 291ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const MemRegion * const *end) const; 292ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 293ceac1d6e0521161adf7ac9834b1a7ad79d73fea4Anna Zaks /// Create a new state in which the statement is marked as tainted. 2948bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef addTaint(const Stmt *S, const LocationContext *LCtx, 295ceac1d6e0521161adf7ac9834b1a7ad79d73fea4Anna Zaks TaintTagType Kind = TaintTagGeneric) const; 296ceac1d6e0521161adf7ac9834b1a7ad79d73fea4Anna Zaks 297ceac1d6e0521161adf7ac9834b1a7ad79d73fea4Anna Zaks /// Create a new state in which the symbol is marked as tainted. 2988bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef addTaint(SymbolRef S, 299ceac1d6e0521161adf7ac9834b1a7ad79d73fea4Anna Zaks TaintTagType Kind = TaintTagGeneric) const; 300ceac1d6e0521161adf7ac9834b1a7ad79d73fea4Anna Zaks 30128fd98d66dab4569316de2b5881d91b534a42461Anna Zaks /// Create a new state in which the region symbol is marked as tainted. 3028bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef addTaint(const MemRegion *R, 30328fd98d66dab4569316de2b5881d91b534a42461Anna Zaks TaintTagType Kind = TaintTagGeneric) const; 30428fd98d66dab4569316de2b5881d91b534a42461Anna Zaks 305ceac1d6e0521161adf7ac9834b1a7ad79d73fea4Anna Zaks /// Check if the statement is tainted in the current state. 3065eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek bool isTainted(const Stmt *S, const LocationContext *LCtx, 3075eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek TaintTagType Kind = TaintTagGeneric) const; 308ceac1d6e0521161adf7ac9834b1a7ad79d73fea4Anna Zaks bool isTainted(SVal V, TaintTagType Kind = TaintTagGeneric) const; 3099f03b62036a7abc0a227b17f4a49b9eefced9450Anna Zaks bool isTainted(SymbolRef Sym, TaintTagType Kind = TaintTagGeneric) const; 310dcf06fa1fbb9c018e152629ef3f3fa7b1acffe7aAnna Zaks bool isTainted(const MemRegion *Reg, TaintTagType Kind=TaintTagGeneric) const; 311ceac1d6e0521161adf7ac9834b1a7ad79d73fea4Anna Zaks 312ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek //==---------------------------------------------------------------------==// 313ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Accessing the Generic Data Map (GDM). 314ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek //==---------------------------------------------------------------------==// 315ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 316ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void *const* FindGDM(void *K) const; 317ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 318ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template<typename T> 3198bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef add(typename ProgramStateTrait<T>::key_type K) const; 320ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 321ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename T> 322ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::data_type 323ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek get() const { 324ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return ProgramStateTrait<T>::MakeData(FindGDM(ProgramStateTrait<T>::GDMIndex())); 325ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 326ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 327ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template<typename T> 328ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::lookup_type 329ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek get(typename ProgramStateTrait<T>::key_type key) const { 330ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void *const* d = FindGDM(ProgramStateTrait<T>::GDMIndex()); 331ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return ProgramStateTrait<T>::Lookup(ProgramStateTrait<T>::MakeData(d), key); 332ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 333ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 334ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename T> 335ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::context_type get_context() const; 336ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 337ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 338ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template<typename T> 3398bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef remove(typename ProgramStateTrait<T>::key_type K) const; 340ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 341ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template<typename T> 3428bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef remove(typename ProgramStateTrait<T>::key_type K, 343ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::context_type C) const; 344ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename T> 3458bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef remove() const; 346ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 347ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template<typename T> 3488bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef set(typename ProgramStateTrait<T>::data_type D) const; 349ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 350ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template<typename T> 3518bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef set(typename ProgramStateTrait<T>::key_type K, 352ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::value_type E) const; 353ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 354ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template<typename T> 3558bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef set(typename ProgramStateTrait<T>::key_type K, 356ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::value_type E, 357ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::context_type C) const; 358ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 359ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template<typename T> 360ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek bool contains(typename ProgramStateTrait<T>::key_type key) const { 361ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void *const* d = FindGDM(ProgramStateTrait<T>::GDMIndex()); 362ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return ProgramStateTrait<T>::Contains(ProgramStateTrait<T>::MakeData(d), key); 363ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 364ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 365ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Pretty-printing. 3665eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek void print(raw_ostream &Out, const char *nl = "\n", 367ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const char *sep = "") const; 3685eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek void printDOT(raw_ostream &Out) const; 369be97b7edb112520d764c24e8b9a159cdc692bcb6Anna Zaks void printTaint(raw_ostream &Out, const char *nl = "\n", 370be97b7edb112520d764c24e8b9a159cdc692bcb6Anna Zaks const char *sep = "") const; 371ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 372d0167853f46cc78787b06255a44f9dcedd04a8ecAnna Zaks void dump() const; 373be97b7edb112520d764c24e8b9a159cdc692bcb6Anna Zaks void dumpTaint() const; 374d0167853f46cc78787b06255a44f9dcedd04a8ecAnna Zaks 375ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekprivate: 376a5888f61be9f8d76e9b48a453dbced50523bd2e0Argyrios Kyrtzidis friend void ProgramStateRetain(const ProgramState *state); 377a5888f61be9f8d76e9b48a453dbced50523bd2e0Argyrios Kyrtzidis friend void ProgramStateRelease(const ProgramState *state); 378ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 3798bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef 380537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose invalidateRegionsImpl(ArrayRef<const MemRegion *> Regions, 381537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose const Expr *E, unsigned BlockCount, 3823133f79cf451e6302dd05262b4bb53a3e4fd6300Ted Kremenek const LocationContext *LCtx, 383537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose StoreManager::InvalidatedSymbols &IS, 384740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const CallEvent *Call) const; 385ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek}; 386ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 387ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek//===----------------------------------------------------------------------===// 388ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek// ProgramStateManager - Factory object for ProgramStates. 389ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek//===----------------------------------------------------------------------===// 390ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 391ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekclass ProgramStateManager { 392ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek friend class ProgramState; 393a5888f61be9f8d76e9b48a453dbced50523bd2e0Argyrios Kyrtzidis friend void ProgramStateRelease(const ProgramState *state); 394ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekprivate: 395ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Eng - The SubEngine that owns this state manager. 396ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SubEngine *Eng; /* Can be null. */ 397ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 398ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek EnvironmentManager EnvMgr; 3996f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<StoreManager> StoreMgr; 4006f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<ConstraintManager> ConstraintMgr; 401ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 402ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramState::GenericDataMap::Factory GDMFactory; 403ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 404ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typedef llvm::DenseMap<void*,std::pair<void*,void (*)(void*)> > GDMContextsTy; 405ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek GDMContextsTy GDMContexts; 406ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 407ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// StateSet - FoldingSet containing all the states created for analyzing 408ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// a particular function. This is used to unique states. 409ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek llvm::FoldingSet<ProgramState> StateSet; 410ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 411ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Object that manages the data for all created SVals. 4126f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<SValBuilder> svalBuilder; 413ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 414ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// A BumpPtrAllocator to allocate states. 415ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek llvm::BumpPtrAllocator &Alloc; 416ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 417ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// A vector of ProgramStates that we can reuse. 418ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek std::vector<ProgramState *> freeStates; 419ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 420ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekpublic: 421ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramStateManager(ASTContext &Ctx, 422ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek StoreManagerCreator CreateStoreManager, 423ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ConstraintManagerCreator CreateConstraintManager, 424ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek llvm::BumpPtrAllocator& alloc, 425ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SubEngine &subeng) 426ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek : Eng(&subeng), 427ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek EnvMgr(alloc), 428ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek GDMFactory(alloc), 429ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek svalBuilder(createSimpleSValBuilder(alloc, Ctx, *this)), 430ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek Alloc(alloc) { 431ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek StoreMgr.reset((*CreateStoreManager)(*this)); 432ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ConstraintMgr.reset((*CreateConstraintManager)(*this, subeng)); 433ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 434ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 435ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramStateManager(ASTContext &Ctx, 436ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek StoreManagerCreator CreateStoreManager, 437ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ConstraintManager* ConstraintManagerPtr, 438ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek llvm::BumpPtrAllocator& alloc) 439ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek : Eng(0), 440ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek EnvMgr(alloc), 441ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek GDMFactory(alloc), 442ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek svalBuilder(createSimpleSValBuilder(alloc, Ctx, *this)), 443ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek Alloc(alloc) { 444ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek StoreMgr.reset((*CreateStoreManager)(*this)); 445ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ConstraintMgr.reset(ConstraintManagerPtr); 446ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 447ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 448ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ~ProgramStateManager(); 449ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 4508bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef getInitialState(const LocationContext *InitLoc); 451ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 452ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ASTContext &getContext() { return svalBuilder->getContext(); } 453ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const ASTContext &getContext() const { return svalBuilder->getContext(); } 454ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 455ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek BasicValueFactory &getBasicVals() { 456ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return svalBuilder->getBasicValueFactory(); 457ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 458ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const BasicValueFactory& getBasicVals() const { 459ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return svalBuilder->getBasicValueFactory(); 460ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 461ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 462ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SValBuilder &getSValBuilder() { 463ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return *svalBuilder; 464ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 465ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 466ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SymbolManager &getSymbolManager() { 467ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return svalBuilder->getSymbolManager(); 468ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 469ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const SymbolManager &getSymbolManager() const { 470ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return svalBuilder->getSymbolManager(); 471ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 472ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 473ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek llvm::BumpPtrAllocator& getAllocator() { return Alloc; } 474ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 475ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek MemRegionManager& getRegionManager() { 476ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return svalBuilder->getRegionManager(); 477ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 478ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const MemRegionManager& getRegionManager() const { 479ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return svalBuilder->getRegionManager(); 480ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 481ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 482ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek StoreManager& getStoreManager() { return *StoreMgr; } 483ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ConstraintManager& getConstraintManager() { return *ConstraintMgr; } 484ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SubEngine* getOwningEngine() { return Eng; } 485ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 4868bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef removeDeadBindings(ProgramStateRef St, 487ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const StackFrameContext *LCtx, 488ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SymbolReaper& SymReaper); 489ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 490ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Marshal a new state for the callee in another translation unit. 491ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// 'state' is owned by the caller's engine. 4928bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef MarshalState(ProgramStateRef state, const StackFrameContext *L); 493ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 494ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekpublic: 495ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 496ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SVal ArrayToPointer(Loc Array) { 497ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return StoreMgr->ArrayToPointer(Array); 498ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 499ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 500ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Methods that manipulate the GDM. 5018bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef addGDM(ProgramStateRef St, void *Key, void *Data); 5028bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef removeGDM(ProgramStateRef state, void *Key); 503ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 504ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Methods that query & manipulate the Store. 505ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 5068bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek void iterBindings(ProgramStateRef state, StoreManager::BindingsHandler& F) { 507ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek StoreMgr->iterBindings(state->getStore(), F); 508ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 509ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 5108bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef getPersistentState(ProgramState &Impl); 5118bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef getPersistentStateWithGDM(ProgramStateRef FromState, 5128bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef GDMState); 513ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 5148bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek bool haveEqualEnvironments(ProgramStateRef S1, ProgramStateRef S2) { 515ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return S1->Env == S2->Env; 516ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 517ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 5188bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek bool haveEqualStores(ProgramStateRef S1, ProgramStateRef S2) { 519ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return S1->store == S2->store; 520ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 521ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 522ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek //==---------------------------------------------------------------------==// 523ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Generic Data Map methods. 524ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek //==---------------------------------------------------------------------==// 525ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // 526ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // ProgramStateManager and ProgramState support a "generic data map" that allows 527ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // different clients of ProgramState objects to embed arbitrary data within a 528ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // ProgramState object. The generic data map is essentially an immutable map 529ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // from a "tag" (that acts as the "key" for a client) and opaque values. 530ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Tags/keys and values are simply void* values. The typical way that clients 531ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // generate unique tags are by taking the address of a static variable. 532ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Clients are responsible for ensuring that data values referred to by a 533ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // the data pointer are immutable (and thus are essentially purely functional 534ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // data). 535ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // 536ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // The templated methods below use the ProgramStateTrait<T> class 537ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // to resolve keys into the GDM and to return data values to clients. 538ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // 539ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 540ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Trait based GDM dispatch. 541ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename T> 5428bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef set(ProgramStateRef st, typename ProgramStateTrait<T>::data_type D) { 543ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return addGDM(st, ProgramStateTrait<T>::GDMIndex(), 544ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramStateTrait<T>::MakeVoidPtr(D)); 545ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 546ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 547ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template<typename T> 5488bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef set(ProgramStateRef st, 549ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::key_type K, 550ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::value_type V, 551ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::context_type C) { 552ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 553ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return addGDM(st, ProgramStateTrait<T>::GDMIndex(), 554ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramStateTrait<T>::MakeVoidPtr(ProgramStateTrait<T>::Set(st->get<T>(), K, V, C))); 555ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 556ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 557ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename T> 5588bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef add(ProgramStateRef st, 559ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::key_type K, 560ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::context_type C) { 561ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return addGDM(st, ProgramStateTrait<T>::GDMIndex(), 562ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramStateTrait<T>::MakeVoidPtr(ProgramStateTrait<T>::Add(st->get<T>(), K, C))); 563ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 564ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 565ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename T> 5668bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef remove(ProgramStateRef st, 567ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::key_type K, 568ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::context_type C) { 569ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 570ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return addGDM(st, ProgramStateTrait<T>::GDMIndex(), 571ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramStateTrait<T>::MakeVoidPtr(ProgramStateTrait<T>::Remove(st->get<T>(), K, C))); 572ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 573ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 574ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename T> 5758bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef remove(ProgramStateRef st) { 576ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return removeGDM(st, ProgramStateTrait<T>::GDMIndex()); 577ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 578ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 579ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void *FindGDMContext(void *index, 580ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void *(*CreateContext)(llvm::BumpPtrAllocator&), 581ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void (*DeleteContext)(void*)); 582ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 583ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename T> 584ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::context_type get_context() { 585ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void *p = FindGDMContext(ProgramStateTrait<T>::GDMIndex(), 586ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramStateTrait<T>::CreateContext, 587ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramStateTrait<T>::DeleteContext); 588ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 589ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return ProgramStateTrait<T>::MakeContext(p); 590ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 591ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 5928bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek const llvm::APSInt* getSymVal(ProgramStateRef St, SymbolRef sym) { 593ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return ConstraintMgr->getSymVal(St, sym); 594ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 595ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 5968bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek void EndPath(ProgramStateRef St) { 597ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ConstraintMgr->EndPath(St); 598ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 599ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek}; 600ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 601ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 602ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek//===----------------------------------------------------------------------===// 603ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek// Out-of-line method definitions for ProgramState. 604ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek//===----------------------------------------------------------------------===// 605ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 606ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline const VarRegion* ProgramState::getRegion(const VarDecl *D, 6075eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LC) const 6085eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek{ 609ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().getRegionManager().getVarRegion(D, LC); 610ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 611ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 6128bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekinline ProgramStateRef ProgramState::assume(DefinedOrUnknownSVal Cond, 613ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek bool Assumption) const { 614ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek if (Cond.isUnknown()) 615ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return this; 616ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 617ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().ConstraintMgr->assume(this, cast<DefinedSVal>(Cond), 618ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek Assumption); 619ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 620ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 6218bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekinline std::pair<ProgramStateRef , ProgramStateRef > 622ae160f880d183ab938fd7ce3b891694ae2f569c0Ted KremenekProgramState::assume(DefinedOrUnknownSVal Cond) const { 623ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek if (Cond.isUnknown()) 624ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return std::make_pair(this, this); 625ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 626ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().ConstraintMgr->assumeDual(this, 627ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek cast<DefinedSVal>(Cond)); 628ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 629ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 6308bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekinline ProgramStateRef ProgramState::bindLoc(SVal LV, SVal V) const { 631ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return !isa<Loc>(LV) ? this : bindLoc(cast<Loc>(LV), V); 632ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 633ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 634ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline Loc ProgramState::getLValue(const VarDecl *VD, 635ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const LocationContext *LC) const { 636ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().StoreMgr->getLValueVar(VD, LC); 637ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 638ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 639ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline Loc ProgramState::getLValue(const CompoundLiteralExpr *literal, 640ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const LocationContext *LC) const { 641ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().StoreMgr->getLValueCompoundLiteral(literal, LC); 642ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 643ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 644ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline SVal ProgramState::getLValue(const ObjCIvarDecl *D, SVal Base) const { 645ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().StoreMgr->getLValueIvar(D, Base); 646ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 647ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 648ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline SVal ProgramState::getLValue(const FieldDecl *D, SVal Base) const { 649ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().StoreMgr->getLValueField(D, Base); 650ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 651ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 652ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline SVal ProgramState::getLValue(QualType ElementType, SVal Idx, SVal Base) const{ 653ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek if (NonLoc *N = dyn_cast<NonLoc>(&Idx)) 654ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().StoreMgr->getLValueElement(ElementType, *N, Base); 655ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return UnknownVal(); 656ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 657ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 658ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline const llvm::APSInt *ProgramState::getSymVal(SymbolRef sym) const { 659ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().getSymVal(this, sym); 660ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 661ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 6625eca482fe895ea57bc82410222e6426c09e63284Ted Kremenekinline SVal ProgramState::getSVal(const Stmt *Ex, const LocationContext *LCtx, 6635eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek bool useOnlyDirectBindings) const{ 6645eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek return Env.getSVal(EnvironmentEntry(Ex, LCtx), 6655eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek *getStateManager().svalBuilder, 666ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek useOnlyDirectBindings); 667ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 668ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 6695eca482fe895ea57bc82410222e6426c09e63284Ted Kremenekinline SVal 6705eca482fe895ea57bc82410222e6426c09e63284Ted KremenekProgramState::getSValAsScalarOrLoc(const Stmt *S, 6715eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LCtx) const { 672ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek if (const Expr *Ex = dyn_cast<Expr>(S)) { 673ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek QualType T = Ex->getType(); 674591b5f53c0e11d87401b4804bb1be1a53f95c619Anna Zaks if (Ex->isGLValue() || Loc::isLocType(T) || T->isIntegerType()) 6755eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek return getSVal(S, LCtx); 676ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 677ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 678ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return UnknownVal(); 679ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 680ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 681ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline SVal ProgramState::getRawSVal(Loc LV, QualType T) const { 6821437425a62dbf7bdb0a855d3ed3b05ed2019ec1eAnna Zaks return getStateManager().StoreMgr->getBinding(getStore(), LV, T); 683ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 684ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 685ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline SVal ProgramState::getSVal(const MemRegion* R) const { 6861437425a62dbf7bdb0a855d3ed3b05ed2019ec1eAnna Zaks return getStateManager().StoreMgr->getBinding(getStore(), 6871437425a62dbf7bdb0a855d3ed3b05ed2019ec1eAnna Zaks loc::MemRegionVal(R)); 688ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 689ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 690ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline BasicValueFactory &ProgramState::getBasicVals() const { 691ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().getBasicVals(); 692ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 693ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 694ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline SymbolManager &ProgramState::getSymbolManager() const { 695ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().getSymbolManager(); 696ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 697ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 698ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate<typename T> 6998bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef ProgramState::add(typename ProgramStateTrait<T>::key_type K) const { 700ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().add<T>(this, K, get_context<T>()); 701ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 702ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 703ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate <typename T> 704ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektypename ProgramStateTrait<T>::context_type ProgramState::get_context() const { 705ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().get_context<T>(); 706ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 707ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 708ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate<typename T> 7098bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef ProgramState::remove(typename ProgramStateTrait<T>::key_type K) const { 710ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().remove<T>(this, K, get_context<T>()); 711ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 712ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 713ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate<typename T> 7148bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef ProgramState::remove(typename ProgramStateTrait<T>::key_type K, 715ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::context_type C) const { 716ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().remove<T>(this, K, C); 717ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 718ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 719ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate <typename T> 7208bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef ProgramState::remove() const { 721ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().remove<T>(this); 722ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 723ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 724ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate<typename T> 7258bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef ProgramState::set(typename ProgramStateTrait<T>::data_type D) const { 726ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().set<T>(this, D); 727ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 728ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 729ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate<typename T> 7308bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef ProgramState::set(typename ProgramStateTrait<T>::key_type K, 731ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::value_type E) const { 732ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().set<T>(this, K, E, get_context<T>()); 733ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 734ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 735ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate<typename T> 7368bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef ProgramState::set(typename ProgramStateTrait<T>::key_type K, 737ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::value_type E, 738ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::context_type C) const { 739ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().set<T>(this, K, E, C); 740ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 741ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 742ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate <typename CB> 743ae160f880d183ab938fd7ce3b891694ae2f569c0Ted KremenekCB ProgramState::scanReachableSymbols(SVal val) const { 744ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek CB cb(this); 745ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek scanReachableSymbols(val, cb); 746ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return cb; 747ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 748ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 749ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate <typename CB> 750ae160f880d183ab938fd7ce3b891694ae2f569c0Ted KremenekCB ProgramState::scanReachableSymbols(const SVal *beg, const SVal *end) const { 751ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek CB cb(this); 752ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek scanReachableSymbols(beg, end, cb); 753ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return cb; 754ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 755ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 756ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate <typename CB> 757ae160f880d183ab938fd7ce3b891694ae2f569c0Ted KremenekCB ProgramState::scanReachableSymbols(const MemRegion * const *beg, 758ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const MemRegion * const *end) const { 759ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek CB cb(this); 760ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek scanReachableSymbols(beg, end, cb); 761ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return cb; 762ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 763ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 7645f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks/// \class ScanReachableSymbols 7655f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks/// A Utility class that allows to visit the reachable symbols using a custom 7665f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks/// SymbolVisitor. 7675f625712f622f6e57de17b6f7eec242956b993eeAnna Zaksclass ScanReachableSymbols : public SubRegionMap::Visitor { 76899ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 7695f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks typedef llvm::DenseMap<const void*, unsigned> VisitedItems; 7705f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks 7715f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks VisitedItems visited; 7728bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state; 7735f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks SymbolVisitor &visitor; 7746f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<SubRegionMap> SRM; 7755f625712f622f6e57de17b6f7eec242956b993eeAnna Zakspublic: 7765f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks 7778bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ScanReachableSymbols(ProgramStateRef st, SymbolVisitor& v) 7785f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks : state(st), visitor(v) {} 7795f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks 7805f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks bool scan(nonloc::CompoundVal val); 7815f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks bool scan(SVal val); 7825f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks bool scan(const MemRegion *R); 7835f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks bool scan(const SymExpr *sym); 7845f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks 7855f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks // From SubRegionMap::Visitor. 7865f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks bool Visit(const MemRegion* Parent, const MemRegion* SubRegion) { 7875f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks return scan(SubRegion); 7885f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks } 7895f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks}; 7905f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks 791ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} // end GR namespace 792ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 793ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} // end clang namespace 794ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 795ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek#endif 796