ProgramState.h revision e54778d77d4f2b2d006bdb7e16f49271e1e9d13d
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// 10e54778d77d4f2b2d006bdb7e16f49271e1e9d13dAnna Zaks// This file defines the state of the program along the analyzes path. 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" 19e54778d77d4f2b2d006bdb7e16f49271e1e9d13dAnna Zaks#include "clang/StaticAnalyzer/Core/PathSensitive/DynamicTypeInfo.h" 20ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/Environment.h" 21ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/Store.h" 22ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/SValBuilder.h" 238bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState_Fwd.h" 24ceac1d6e0521161adf7ac9834b1a7ad79d73fea4Anna Zaks#include "clang/StaticAnalyzer/Core/PathSensitive/TaintTag.h" 25ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek#include "llvm/ADT/PointerIntPair.h" 26ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek#include "llvm/ADT/FoldingSet.h" 27ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek#include "llvm/ADT/ImmutableMap.h" 28ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 29ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremeneknamespace llvm { 30ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekclass APSInt; 31ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekclass BumpPtrAllocator; 32ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 33ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 34ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremeneknamespace clang { 35ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekclass ASTContext; 36ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 37ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremeneknamespace ento { 38ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 39740d490593e0de8732a697c9f77b90ddd463863bJordan Roseclass CallEvent; 40972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Roseclass CallEventManager; 418bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek 42ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektypedef ConstraintManager* (*ConstraintManagerCreator)(ProgramStateManager&, 43ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SubEngine&); 44ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektypedef StoreManager* (*StoreManagerCreator)(ProgramStateManager&); 45ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 46ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek//===----------------------------------------------------------------------===// 47ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek// ProgramStateTrait - Traits used by the Generic Data Map of a ProgramState. 48ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek//===----------------------------------------------------------------------===// 49ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 50ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate <typename T> struct ProgramStatePartialTrait; 51ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 52ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate <typename T> struct ProgramStateTrait { 53ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typedef typename T::data_type data_type; 54ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek static inline void *MakeVoidPtr(data_type D) { return (void*) D; } 55ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek static inline data_type MakeData(void *const* P) { 56ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return P ? (data_type) *P : (data_type) 0; 57ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 58ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek}; 59ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 605f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks/// \class ProgramState 61ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// ProgramState - This class encapsulates: 62ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// 63ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// 1. A mapping from expressions to values (Environment) 64ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// 2. A mapping from locations to values (Store) 65ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// 3. Constraints on symbolic values (GenericDataMap) 66ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// 67ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// Together these represent the "abstract state" of a program. 68ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// 69ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// ProgramState is intended to be used as a functional object; that is, 70ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// once it is created and made "persistent" in a FoldingSet, its 71ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek/// values will never change. 72ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekclass ProgramState : public llvm::FoldingSetNode { 73ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekpublic: 74ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typedef llvm::ImmutableSet<llvm::APSInt*> IntSetTy; 75ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typedef llvm::ImmutableMap<void*, void*> GenericDataMap; 76ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 77ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekprivate: 78ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void operator=(const ProgramState& R) const; // Do not implement. 79ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 80ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek friend class ProgramStateManager; 81ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek friend class ExplodedGraph; 82ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek friend class ExplodedNode; 83ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 84ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramStateManager *stateMgr; 85ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek Environment Env; // Maps a Stmt to its current SVal. 86ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek Store store; // Maps a location to its current value. 87ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek GenericDataMap GDM; // Custom data stored by a client of this class. 88ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek unsigned refCount; 89ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 90ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// makeWithStore - Return a ProgramState with the same values as the current 91ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// state with the exception of using the specified Store. 928bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef makeWithStore(const StoreRef &store) const; 93ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 94ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void setStore(const StoreRef &storeRef); 95ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 96ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekpublic: 97ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// This ctor is used when creating the first ProgramState object. 98ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramState(ProgramStateManager *mgr, const Environment& env, 99ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek StoreRef st, GenericDataMap gdm); 100ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 101ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Copy ctor - We must explicitly define this or else the "Next" ptr 102ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// in FoldingSetNode will also get copied. 103ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramState(const ProgramState &RHS); 104ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 105ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ~ProgramState(); 106ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 107ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Return the ProgramStateManager associated with this state. 108ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramStateManager &getStateManager() const { return *stateMgr; } 109ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 110ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// getEnvironment - Return the environment associated with this state. 111ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// The environment is the mapping from expressions to values. 112ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const Environment& getEnvironment() const { return Env; } 113ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 114ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Return the store associated with this state. The store 115ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// is a mapping from locations to values. 116ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek Store getStore() const { return store; } 117ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 118ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 119ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// getGDM - Return the generic data map associated with this state. 120ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek GenericDataMap getGDM() const { return GDM; } 121ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 122ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void setGDM(GenericDataMap gdm) { GDM = gdm; } 123ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 124ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Profile - Profile the contents of a ProgramState object for use in a 125ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// FoldingSet. Two ProgramState objects are considered equal if they 126ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// have the same Environment, Store, and GenericDataMap. 127a5888f61be9f8d76e9b48a453dbced50523bd2e0Argyrios Kyrtzidis static void Profile(llvm::FoldingSetNodeID& ID, const ProgramState *V) { 128ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek V->Env.Profile(ID); 129ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ID.AddPointer(V->store); 130ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek V->GDM.Profile(ID); 131ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 132ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 133ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Profile - Used to profile the contents of this object for inclusion 134ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// in a FoldingSet. 135ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void Profile(llvm::FoldingSetNodeID& ID) const { 136ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek Profile(ID, this); 137ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 138ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 139ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek BasicValueFactory &getBasicVals() const; 140ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SymbolManager &getSymbolManager() const; 141ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 142ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek //==---------------------------------------------------------------------==// 143ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Constraints on values. 144ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek //==---------------------------------------------------------------------==// 145ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // 146ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Each ProgramState records constraints on symbolic values. These constraints 147ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // are managed using the ConstraintManager associated with a ProgramStateManager. 148ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // As constraints gradually accrue on symbolic values, added constraints 149ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // may conflict and indicate that a state is infeasible (as no real values 150ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // could satisfy all the constraints). This is the principal mechanism 151ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // for modeling path-sensitivity in ExprEngine/ProgramState. 152ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // 153ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Various "assume" methods form the interface for adding constraints to 154ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // symbolic values. A call to 'assume' indicates an assumption being placed 155ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // on one or symbolic values. 'assume' methods take the following inputs: 156ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // 157ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // (1) A ProgramState object representing the current state. 158ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // 159ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // (2) The assumed constraint (which is specific to a given "assume" method). 160ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // 161ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // (3) A binary value "Assumption" that indicates whether the constraint is 162ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // assumed to be true or false. 163ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // 164ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // The output of "assume*" is a new ProgramState object with the added constraints. 165ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // If no new state is feasible, NULL is returned. 166ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // 167ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 1688bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef assume(DefinedOrUnknownSVal cond, bool assumption) const; 169ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 170ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// This method assumes both "true" and "false" for 'cond', and 171ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// returns both corresponding states. It's shorthand for doing 172ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// 'assume' twice. 1738bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek std::pair<ProgramStateRef , ProgramStateRef > 174ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek assume(DefinedOrUnknownSVal cond) const; 175ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 1768bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef assumeInBound(DefinedOrUnknownSVal idx, 177ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek DefinedOrUnknownSVal upperBound, 178af5f550de34525b27f0ff31dafce792caf8158b6Anna Zaks bool assumption, 179af5f550de34525b27f0ff31dafce792caf8158b6Anna Zaks QualType IndexType = QualType()) const; 180ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 1815f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// Utility method for getting regions. 182ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const VarRegion* getRegion(const VarDecl *D, const LocationContext *LC) const; 183ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 184ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek //==---------------------------------------------------------------------==// 185ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Binding and retrieving values to/from the environment and symbolic store. 186ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek //==---------------------------------------------------------------------==// 187ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 1885be88dc79d2768d67371103b6535fb8c4a6f27a1Ted Kremenek /// \brief Create a new state with the specified CompoundLiteral binding. 1895be88dc79d2768d67371103b6535fb8c4a6f27a1Ted Kremenek /// \param CL the compound literal expression (the binding key) 1905be88dc79d2768d67371103b6535fb8c4a6f27a1Ted Kremenek /// \param LC the LocationContext of the binding 1915be88dc79d2768d67371103b6535fb8c4a6f27a1Ted Kremenek /// \param V the value to bind. 1928bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef bindCompoundLiteral(const CompoundLiteralExpr *CL, 1935be88dc79d2768d67371103b6535fb8c4a6f27a1Ted Kremenek const LocationContext *LC, 1945be88dc79d2768d67371103b6535fb8c4a6f27a1Ted Kremenek SVal V) const; 195ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 196ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Create a new state by binding the value 'V' to the statement 'S' in the 197ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// state's environment. 1988bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef BindExpr(const Stmt *S, const LocationContext *LCtx, 1995eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal V, bool Invalidate = true) const; 200ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 201ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Create a new state by binding the value 'V' and location 'locaton' to the 202ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// statement 'S' in the state's environment. 2038bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef bindExprAndLocation(const Stmt *S, 2045eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LCtx, 2055eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal location, SVal V) const; 206ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 20732a549a64922af0903bdb777613ae7ae4490b70fTed Kremenek ProgramStateRef bindLoc(Loc location, 20832a549a64922af0903bdb777613ae7ae4490b70fTed Kremenek SVal V, 20932a549a64922af0903bdb777613ae7ae4490b70fTed Kremenek bool notifyChanges = true) const; 210ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 2118bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef bindLoc(SVal location, SVal V) const; 212ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 2138bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef bindDefault(SVal loc, SVal V) const; 214ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 21556a46b51df691f857f7120aaf2d4deeff0b014deTed Kremenek ProgramStateRef killBinding(Loc LV) const; 216ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 217ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// invalidateRegions - Returns the state with bindings for the given regions 218ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// cleared from the store. The regions are provided as a continuous array 219ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// from Begin to End. Optionally invalidates global regions as well. 2208bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef invalidateRegions(ArrayRef<const MemRegion *> Regions, 221eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks const Expr *E, unsigned BlockCount, 2223133f79cf451e6302dd05262b4bb53a3e4fd6300Ted Kremenek const LocationContext *LCtx, 223eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks StoreManager::InvalidatedSymbols *IS = 0, 224740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const CallEvent *Call = 0) const; 225ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 226ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// enterStackFrame - Returns the state for entry to the given stack frame, 227ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// preserving the current state. 228e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose ProgramStateRef enterStackFrame(const CallEvent &Call, 229e54cfc7b9990acffd0a8a4ba381717b4bb9f3011Jordan Rose const StackFrameContext *CalleeCtx) const; 230ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 231ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Get the lvalue for a variable reference. 232ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek Loc getLValue(const VarDecl *D, const LocationContext *LC) const; 233ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 234ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek Loc getLValue(const CompoundLiteralExpr *literal, 235ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const LocationContext *LC) const; 236ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 237ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Get the lvalue for an ivar reference. 238ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SVal getLValue(const ObjCIvarDecl *decl, SVal base) const; 239ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 240ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Get the lvalue for a field reference. 241ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SVal getLValue(const FieldDecl *decl, SVal Base) const; 242ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 2433a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose /// Get the lvalue for an indirect field reference. 2443a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose SVal getLValue(const IndirectFieldDecl *decl, SVal Base) const; 2453a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose 246ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Get the lvalue for an array index. 247ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SVal getLValue(QualType ElementType, SVal Idx, SVal Base) const; 248ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 249ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const llvm::APSInt *getSymVal(SymbolRef sym) const; 250ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 251ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Returns the SVal bound to the statement 'S' in the state's environment. 2525eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal getSVal(const Stmt *S, const LocationContext *LCtx, 2535eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek bool useOnlyDirectBindings = false) const; 254ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 2555eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek SVal getSValAsScalarOrLoc(const Stmt *Ex, const LocationContext *LCtx) const; 256ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 2574335a48214dcbb258e08c8867c45648e25edb2ecAnna Zaks /// \brief Return the value bound to the specified location. 2584335a48214dcbb258e08c8867c45648e25edb2ecAnna Zaks /// Returns UnknownVal() if none found. 259ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SVal getSVal(Loc LV, QualType T = QualType()) const; 260ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 261ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Returns the "raw" SVal bound to LV before any value simplfication. 262ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SVal getRawSVal(Loc LV, QualType T= QualType()) const; 263ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 2644335a48214dcbb258e08c8867c45648e25edb2ecAnna Zaks /// \brief Return the value bound to the specified location. 2654335a48214dcbb258e08c8867c45648e25edb2ecAnna Zaks /// Returns UnknownVal() if none found. 266ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SVal getSVal(const MemRegion* R) const; 267ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 268ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SVal getSValAsScalarOrLoc(const MemRegion *R) const; 269ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 2705f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// \brief Visits the symbols reachable from the given SVal using the provided 2715f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// SymbolVisitor. 2725f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// 2735f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// This is a convenience API. Consider using ScanReachableSymbols class 2745f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// directly when making multiple scans on the same state with the same 2755f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// visitor to avoid repeated initialization cost. 2765f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// \sa ScanReachableSymbols 277ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek bool scanReachableSymbols(SVal val, SymbolVisitor& visitor) const; 278ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 2795f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// \brief Visits the symbols reachable from the SVals in the given range 2805f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// using the provided SymbolVisitor. 281ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek bool scanReachableSymbols(const SVal *I, const SVal *E, 282ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SymbolVisitor &visitor) const; 283ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 2845f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// \brief Visits the symbols reachable from the regions in the given 2855f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks /// MemRegions range using the provided SymbolVisitor. 286ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek bool scanReachableSymbols(const MemRegion * const *I, 287ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const MemRegion * const *E, 288ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SymbolVisitor &visitor) const; 289ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 290ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename CB> CB scanReachableSymbols(SVal val) const; 291ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename CB> CB scanReachableSymbols(const SVal *beg, 292ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const SVal *end) const; 293ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 294ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename CB> CB 295ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek scanReachableSymbols(const MemRegion * const *beg, 296ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const MemRegion * const *end) const; 297ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 298ceac1d6e0521161adf7ac9834b1a7ad79d73fea4Anna Zaks /// Create a new state in which the statement is marked as tainted. 2998bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef addTaint(const Stmt *S, const LocationContext *LCtx, 300ceac1d6e0521161adf7ac9834b1a7ad79d73fea4Anna Zaks TaintTagType Kind = TaintTagGeneric) const; 301ceac1d6e0521161adf7ac9834b1a7ad79d73fea4Anna Zaks 302ceac1d6e0521161adf7ac9834b1a7ad79d73fea4Anna Zaks /// Create a new state in which the symbol is marked as tainted. 3038bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef addTaint(SymbolRef S, 304ceac1d6e0521161adf7ac9834b1a7ad79d73fea4Anna Zaks TaintTagType Kind = TaintTagGeneric) const; 305ceac1d6e0521161adf7ac9834b1a7ad79d73fea4Anna Zaks 30628fd98d66dab4569316de2b5881d91b534a42461Anna Zaks /// Create a new state in which the region symbol is marked as tainted. 3078bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef addTaint(const MemRegion *R, 30828fd98d66dab4569316de2b5881d91b534a42461Anna Zaks TaintTagType Kind = TaintTagGeneric) const; 30928fd98d66dab4569316de2b5881d91b534a42461Anna Zaks 310ceac1d6e0521161adf7ac9834b1a7ad79d73fea4Anna Zaks /// Check if the statement is tainted in the current state. 3115eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek bool isTainted(const Stmt *S, const LocationContext *LCtx, 3125eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek TaintTagType Kind = TaintTagGeneric) const; 313ceac1d6e0521161adf7ac9834b1a7ad79d73fea4Anna Zaks bool isTainted(SVal V, TaintTagType Kind = TaintTagGeneric) const; 3149f03b62036a7abc0a227b17f4a49b9eefced9450Anna Zaks bool isTainted(SymbolRef Sym, TaintTagType Kind = TaintTagGeneric) const; 315dcf06fa1fbb9c018e152629ef3f3fa7b1acffe7aAnna Zaks bool isTainted(const MemRegion *Reg, TaintTagType Kind=TaintTagGeneric) const; 316ceac1d6e0521161adf7ac9834b1a7ad79d73fea4Anna Zaks 317c7ecc43c33a21b82c49664910b19fcc1f555aa51Anna Zaks /// \brief Get dynamic type information for a region. 3182d18419a7c8f9a2975d4ed74a202de6467308ad1Anna Zaks DynamicTypeInfo getDynamicTypeInfo(const MemRegion *Reg) const; 319c7ecc43c33a21b82c49664910b19fcc1f555aa51Anna Zaks 320d4fe57f7f7a8793227effc1274d70ec44cee9a4fAnna Zaks /// \brief Set dynamic type information of the region; return the new state. 321d4fe57f7f7a8793227effc1274d70ec44cee9a4fAnna Zaks ProgramStateRef setDynamicTypeInfo(const MemRegion *Reg, 322c7ecc43c33a21b82c49664910b19fcc1f555aa51Anna Zaks DynamicTypeInfo NewTy) const; 323c7ecc43c33a21b82c49664910b19fcc1f555aa51Anna Zaks 324d4fe57f7f7a8793227effc1274d70ec44cee9a4fAnna Zaks /// \brief Set dynamic type information of the region; return the new state. 325d4fe57f7f7a8793227effc1274d70ec44cee9a4fAnna Zaks ProgramStateRef setDynamicTypeInfo(const MemRegion *Reg, 32654918ba02ba900c0e0bb4fd3d749b6b1ac4e50a9Anna Zaks QualType NewTy, 32754918ba02ba900c0e0bb4fd3d749b6b1ac4e50a9Anna Zaks bool CanBeSubClassed = true) const { 32854918ba02ba900c0e0bb4fd3d749b6b1ac4e50a9Anna Zaks return setDynamicTypeInfo(Reg, DynamicTypeInfo(NewTy, CanBeSubClassed)); 329c7ecc43c33a21b82c49664910b19fcc1f555aa51Anna Zaks } 3302d18419a7c8f9a2975d4ed74a202de6467308ad1Anna Zaks 331ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek //==---------------------------------------------------------------------==// 332ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Accessing the Generic Data Map (GDM). 333ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek //==---------------------------------------------------------------------==// 334ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 335ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void *const* FindGDM(void *K) const; 336ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 337ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template<typename T> 3388bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef add(typename ProgramStateTrait<T>::key_type K) const; 339ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 340ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename T> 341ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::data_type 342ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek get() const { 343ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return ProgramStateTrait<T>::MakeData(FindGDM(ProgramStateTrait<T>::GDMIndex())); 344ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 345ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 346ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template<typename T> 347ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::lookup_type 348ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek get(typename ProgramStateTrait<T>::key_type key) const { 349ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void *const* d = FindGDM(ProgramStateTrait<T>::GDMIndex()); 350ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return ProgramStateTrait<T>::Lookup(ProgramStateTrait<T>::MakeData(d), key); 351ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 352ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 353ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename T> 354ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::context_type get_context() const; 355ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 356ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 357ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template<typename T> 3588bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef remove(typename ProgramStateTrait<T>::key_type K) const; 359ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 360ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template<typename T> 3618bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef remove(typename ProgramStateTrait<T>::key_type K, 362ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::context_type C) const; 363ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename T> 3648bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef remove() const; 365ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 366ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template<typename T> 3678bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef set(typename ProgramStateTrait<T>::data_type D) const; 368ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 369ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template<typename T> 3708bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef set(typename ProgramStateTrait<T>::key_type K, 371ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::value_type E) const; 372ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 373ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template<typename T> 3748bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef set(typename ProgramStateTrait<T>::key_type K, 375ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::value_type E, 376ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::context_type C) const; 377ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 378ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template<typename T> 379ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek bool contains(typename ProgramStateTrait<T>::key_type key) const { 380ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void *const* d = FindGDM(ProgramStateTrait<T>::GDMIndex()); 381ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return ProgramStateTrait<T>::Contains(ProgramStateTrait<T>::MakeData(d), key); 382ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 383ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 384ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Pretty-printing. 3855eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek void print(raw_ostream &Out, const char *nl = "\n", 386ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const char *sep = "") const; 3875eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek void printDOT(raw_ostream &Out) const; 388be97b7edb112520d764c24e8b9a159cdc692bcb6Anna Zaks void printTaint(raw_ostream &Out, const char *nl = "\n", 389be97b7edb112520d764c24e8b9a159cdc692bcb6Anna Zaks const char *sep = "") const; 390ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 391d0167853f46cc78787b06255a44f9dcedd04a8ecAnna Zaks void dump() const; 392be97b7edb112520d764c24e8b9a159cdc692bcb6Anna Zaks void dumpTaint() const; 393d0167853f46cc78787b06255a44f9dcedd04a8ecAnna Zaks 394ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekprivate: 395a5888f61be9f8d76e9b48a453dbced50523bd2e0Argyrios Kyrtzidis friend void ProgramStateRetain(const ProgramState *state); 396a5888f61be9f8d76e9b48a453dbced50523bd2e0Argyrios Kyrtzidis friend void ProgramStateRelease(const ProgramState *state); 397ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 3988bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef 399537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose invalidateRegionsImpl(ArrayRef<const MemRegion *> Regions, 400537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose const Expr *E, unsigned BlockCount, 4013133f79cf451e6302dd05262b4bb53a3e4fd6300Ted Kremenek const LocationContext *LCtx, 402537716ad8dd10f984b6cfe6985afade1185c5e3cJordy Rose StoreManager::InvalidatedSymbols &IS, 403740d490593e0de8732a697c9f77b90ddd463863bJordan Rose const CallEvent *Call) const; 404ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek}; 405ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 406ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek//===----------------------------------------------------------------------===// 407ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek// ProgramStateManager - Factory object for ProgramStates. 408ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek//===----------------------------------------------------------------------===// 409ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 410ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekclass ProgramStateManager { 411ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek friend class ProgramState; 412a5888f61be9f8d76e9b48a453dbced50523bd2e0Argyrios Kyrtzidis friend void ProgramStateRelease(const ProgramState *state); 413ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekprivate: 414ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Eng - The SubEngine that owns this state manager. 415ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SubEngine *Eng; /* Can be null. */ 416ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 417ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek EnvironmentManager EnvMgr; 4186f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<StoreManager> StoreMgr; 4196f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<ConstraintManager> ConstraintMgr; 420ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 421ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramState::GenericDataMap::Factory GDMFactory; 422ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 423ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typedef llvm::DenseMap<void*,std::pair<void*,void (*)(void*)> > GDMContextsTy; 424ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek GDMContextsTy GDMContexts; 425ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 426ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// StateSet - FoldingSet containing all the states created for analyzing 427ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// a particular function. This is used to unique states. 428ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek llvm::FoldingSet<ProgramState> StateSet; 429ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 430ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Object that manages the data for all created SVals. 4316f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<SValBuilder> svalBuilder; 432ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 433972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose /// Manages memory for created CallEvents. 434972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose OwningPtr<CallEventManager> CallEventMgr; 435972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 436ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// A BumpPtrAllocator to allocate states. 437ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek llvm::BumpPtrAllocator &Alloc; 438ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 439ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// A vector of ProgramStates that we can reuse. 440ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek std::vector<ProgramState *> freeStates; 441ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 442ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekpublic: 443ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramStateManager(ASTContext &Ctx, 444ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek StoreManagerCreator CreateStoreManager, 445ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ConstraintManagerCreator CreateConstraintManager, 446ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek llvm::BumpPtrAllocator& alloc, 447972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose SubEngine &subeng); 448ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 449ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ~ProgramStateManager(); 450ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 4518bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef getInitialState(const LocationContext *InitLoc); 452ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 453ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ASTContext &getContext() { return svalBuilder->getContext(); } 454ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const ASTContext &getContext() const { return svalBuilder->getContext(); } 455ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 456ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek BasicValueFactory &getBasicVals() { 457ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return svalBuilder->getBasicValueFactory(); 458ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 459ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const BasicValueFactory& getBasicVals() const { 460ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return svalBuilder->getBasicValueFactory(); 461ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 462ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 463ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SValBuilder &getSValBuilder() { 464ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return *svalBuilder; 465ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 466ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 467ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SymbolManager &getSymbolManager() { 468ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return svalBuilder->getSymbolManager(); 469ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 470ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const SymbolManager &getSymbolManager() const { 471ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return svalBuilder->getSymbolManager(); 472ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 473ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 474ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek llvm::BumpPtrAllocator& getAllocator() { return Alloc; } 475ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 476ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek MemRegionManager& getRegionManager() { 477ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return svalBuilder->getRegionManager(); 478ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 479ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const MemRegionManager& getRegionManager() const { 480ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return svalBuilder->getRegionManager(); 481ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 482ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 483972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose CallEventManager &getCallEventManager() { return *CallEventMgr; } 484972a3680bdd95f2e9d6316b391f1c47513dc78ccJordan Rose 485ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek StoreManager& getStoreManager() { return *StoreMgr; } 486ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ConstraintManager& getConstraintManager() { return *ConstraintMgr; } 487ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SubEngine* getOwningEngine() { return Eng; } 488ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 4898bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef removeDeadBindings(ProgramStateRef St, 490ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const StackFrameContext *LCtx, 491ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SymbolReaper& SymReaper); 492ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 493ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// Marshal a new state for the callee in another translation unit. 494ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek /// 'state' is owned by the caller's engine. 4958bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef MarshalState(ProgramStateRef state, const StackFrameContext *L); 496ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 497ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekpublic: 498ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 499ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek SVal ArrayToPointer(Loc Array) { 500ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return StoreMgr->ArrayToPointer(Array); 501ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 502ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 503ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Methods that manipulate the GDM. 5048bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef addGDM(ProgramStateRef St, void *Key, void *Data); 5058bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef removeGDM(ProgramStateRef state, void *Key); 506ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 507ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Methods that query & manipulate the Store. 508ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 5098bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek void iterBindings(ProgramStateRef state, StoreManager::BindingsHandler& F) { 510ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek StoreMgr->iterBindings(state->getStore(), F); 511ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 512ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 5138bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef getPersistentState(ProgramState &Impl); 5148bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef getPersistentStateWithGDM(ProgramStateRef FromState, 5158bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef GDMState); 516ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 5178bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek bool haveEqualEnvironments(ProgramStateRef S1, ProgramStateRef S2) { 518ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return S1->Env == S2->Env; 519ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 520ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 5218bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek bool haveEqualStores(ProgramStateRef S1, ProgramStateRef S2) { 522ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return S1->store == S2->store; 523ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 524ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 525ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek //==---------------------------------------------------------------------==// 526ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Generic Data Map methods. 527ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek //==---------------------------------------------------------------------==// 528ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // 529ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // ProgramStateManager and ProgramState support a "generic data map" that allows 530ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // different clients of ProgramState objects to embed arbitrary data within a 531ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // ProgramState object. The generic data map is essentially an immutable map 532ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // from a "tag" (that acts as the "key" for a client) and opaque values. 533ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Tags/keys and values are simply void* values. The typical way that clients 534ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // generate unique tags are by taking the address of a static variable. 535ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Clients are responsible for ensuring that data values referred to by a 536ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // the data pointer are immutable (and thus are essentially purely functional 537ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // data). 538ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // 539ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // The templated methods below use the ProgramStateTrait<T> class 540ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // to resolve keys into the GDM and to return data values to clients. 541ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // 542ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 543ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek // Trait based GDM dispatch. 544ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename T> 5458bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef set(ProgramStateRef st, typename ProgramStateTrait<T>::data_type D) { 546ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return addGDM(st, ProgramStateTrait<T>::GDMIndex(), 547ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramStateTrait<T>::MakeVoidPtr(D)); 548ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 549ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 550ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template<typename T> 5518bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef set(ProgramStateRef st, 552ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::key_type K, 553ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::value_type V, 554ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::context_type C) { 555ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 556ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return addGDM(st, ProgramStateTrait<T>::GDMIndex(), 557ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramStateTrait<T>::MakeVoidPtr(ProgramStateTrait<T>::Set(st->get<T>(), K, V, C))); 558ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 559ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 560ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename T> 5618bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef add(ProgramStateRef st, 562ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::key_type K, 563ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::context_type C) { 564ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return addGDM(st, ProgramStateTrait<T>::GDMIndex(), 565ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramStateTrait<T>::MakeVoidPtr(ProgramStateTrait<T>::Add(st->get<T>(), K, C))); 566ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 567ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 568ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename T> 5698bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef remove(ProgramStateRef st, 570ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::key_type K, 571ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::context_type C) { 572ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 573ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return addGDM(st, ProgramStateTrait<T>::GDMIndex(), 574ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramStateTrait<T>::MakeVoidPtr(ProgramStateTrait<T>::Remove(st->get<T>(), K, C))); 575ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 576ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 577ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename T> 5788bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef remove(ProgramStateRef st) { 579ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return removeGDM(st, ProgramStateTrait<T>::GDMIndex()); 580ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 581ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 582ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void *FindGDMContext(void *index, 583ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void *(*CreateContext)(llvm::BumpPtrAllocator&), 584ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void (*DeleteContext)(void*)); 585ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 586ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek template <typename T> 587ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::context_type get_context() { 588ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek void *p = FindGDMContext(ProgramStateTrait<T>::GDMIndex(), 589ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramStateTrait<T>::CreateContext, 590ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ProgramStateTrait<T>::DeleteContext); 591ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 592ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return ProgramStateTrait<T>::MakeContext(p); 593ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 594ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 5958bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek const llvm::APSInt* getSymVal(ProgramStateRef St, SymbolRef sym) { 596ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return ConstraintMgr->getSymVal(St, sym); 597ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 598ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 5998bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek void EndPath(ProgramStateRef St) { 600ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek ConstraintMgr->EndPath(St); 601ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 602ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek}; 603ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 604ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 605ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek//===----------------------------------------------------------------------===// 606ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek// Out-of-line method definitions for ProgramState. 607ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek//===----------------------------------------------------------------------===// 608ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 609ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline const VarRegion* ProgramState::getRegion(const VarDecl *D, 6105eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LC) const 6115eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek{ 612ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().getRegionManager().getVarRegion(D, LC); 613ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 614ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 6158bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekinline ProgramStateRef ProgramState::assume(DefinedOrUnknownSVal Cond, 616ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek bool Assumption) const { 617ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek if (Cond.isUnknown()) 618ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return this; 619ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 620ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().ConstraintMgr->assume(this, cast<DefinedSVal>(Cond), 621ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek Assumption); 622ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 623ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 6248bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekinline std::pair<ProgramStateRef , ProgramStateRef > 625ae160f880d183ab938fd7ce3b891694ae2f569c0Ted KremenekProgramState::assume(DefinedOrUnknownSVal Cond) const { 626ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek if (Cond.isUnknown()) 627ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return std::make_pair(this, this); 628ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 629ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().ConstraintMgr->assumeDual(this, 630ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek cast<DefinedSVal>(Cond)); 631ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 632ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 6338bef8238181a30e52dea380789a7e2d760eac532Ted Kremenekinline ProgramStateRef ProgramState::bindLoc(SVal LV, SVal V) const { 634ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return !isa<Loc>(LV) ? this : bindLoc(cast<Loc>(LV), V); 635ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 636ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 637ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline Loc ProgramState::getLValue(const VarDecl *VD, 638ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const LocationContext *LC) const { 639ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().StoreMgr->getLValueVar(VD, LC); 640ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 641ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 642ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline Loc ProgramState::getLValue(const CompoundLiteralExpr *literal, 643ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const LocationContext *LC) const { 644ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().StoreMgr->getLValueCompoundLiteral(literal, LC); 645ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 646ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 647ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline SVal ProgramState::getLValue(const ObjCIvarDecl *D, SVal Base) const { 648ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().StoreMgr->getLValueIvar(D, Base); 649ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 650ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 651ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline SVal ProgramState::getLValue(const FieldDecl *D, SVal Base) const { 652ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().StoreMgr->getLValueField(D, Base); 653ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 654ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 6553a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Roseinline SVal ProgramState::getLValue(const IndirectFieldDecl *D, 6563a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose SVal Base) const { 6573a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose StoreManager &SM = *getStateManager().StoreMgr; 6583a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose for (IndirectFieldDecl::chain_iterator I = D->chain_begin(), 6593a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose E = D->chain_end(); 6603a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose I != E; ++I) { 6613a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose Base = SM.getLValueField(cast<FieldDecl>(*I), Base); 6623a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose } 6633a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose 6643a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose return Base; 6653a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose} 6663a0a9e3e8bbaa45f3ca22b1e20b3beaac0f5861eJordan Rose 667ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline SVal ProgramState::getLValue(QualType ElementType, SVal Idx, SVal Base) const{ 668ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek if (NonLoc *N = dyn_cast<NonLoc>(&Idx)) 669ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().StoreMgr->getLValueElement(ElementType, *N, Base); 670ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return UnknownVal(); 671ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 672ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 673ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline const llvm::APSInt *ProgramState::getSymVal(SymbolRef sym) const { 674ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().getSymVal(this, sym); 675ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 676ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 6775eca482fe895ea57bc82410222e6426c09e63284Ted Kremenekinline SVal ProgramState::getSVal(const Stmt *Ex, const LocationContext *LCtx, 6785eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek bool useOnlyDirectBindings) const{ 6795eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek return Env.getSVal(EnvironmentEntry(Ex, LCtx), 6805eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek *getStateManager().svalBuilder, 681ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek useOnlyDirectBindings); 682ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 683ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 6845eca482fe895ea57bc82410222e6426c09e63284Ted Kremenekinline SVal 6855eca482fe895ea57bc82410222e6426c09e63284Ted KremenekProgramState::getSValAsScalarOrLoc(const Stmt *S, 6865eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *LCtx) const { 687ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek if (const Expr *Ex = dyn_cast<Expr>(S)) { 688ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek QualType T = Ex->getType(); 689591b5f53c0e11d87401b4804bb1be1a53f95c619Anna Zaks if (Ex->isGLValue() || Loc::isLocType(T) || T->isIntegerType()) 6905eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek return getSVal(S, LCtx); 691ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek } 692ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 693ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return UnknownVal(); 694ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 695ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 696ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline SVal ProgramState::getRawSVal(Loc LV, QualType T) const { 6971437425a62dbf7bdb0a855d3ed3b05ed2019ec1eAnna Zaks return getStateManager().StoreMgr->getBinding(getStore(), LV, T); 698ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 699ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 700ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline SVal ProgramState::getSVal(const MemRegion* R) const { 7011437425a62dbf7bdb0a855d3ed3b05ed2019ec1eAnna Zaks return getStateManager().StoreMgr->getBinding(getStore(), 7021437425a62dbf7bdb0a855d3ed3b05ed2019ec1eAnna Zaks loc::MemRegionVal(R)); 703ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 704ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 705ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline BasicValueFactory &ProgramState::getBasicVals() const { 706ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().getBasicVals(); 707ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 708ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 709ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenekinline SymbolManager &ProgramState::getSymbolManager() const { 710ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().getSymbolManager(); 711ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 712ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 713ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate<typename T> 7148bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef ProgramState::add(typename ProgramStateTrait<T>::key_type K) const { 715ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().add<T>(this, K, get_context<T>()); 716ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 717ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 718ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate <typename T> 719ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektypename ProgramStateTrait<T>::context_type ProgramState::get_context() const { 720ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().get_context<T>(); 721ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 722ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 723ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate<typename T> 7248bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef ProgramState::remove(typename ProgramStateTrait<T>::key_type K) const { 725ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().remove<T>(this, K, get_context<T>()); 726ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 727ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 728ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate<typename T> 7298bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef ProgramState::remove(typename ProgramStateTrait<T>::key_type K, 730ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::context_type C) const { 731ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().remove<T>(this, K, C); 732ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 733ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 734ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate <typename T> 7358bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef ProgramState::remove() const { 736ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().remove<T>(this); 737ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 738ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 739ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate<typename T> 7408bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef ProgramState::set(typename ProgramStateTrait<T>::data_type D) const { 741ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().set<T>(this, D); 742ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 743ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 744ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate<typename T> 7458bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef ProgramState::set(typename ProgramStateTrait<T>::key_type K, 746ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::value_type E) const { 747ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().set<T>(this, K, E, get_context<T>()); 748ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 749ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 750ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate<typename T> 7518bef8238181a30e52dea380789a7e2d760eac532Ted KremenekProgramStateRef ProgramState::set(typename ProgramStateTrait<T>::key_type K, 752ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::value_type E, 753ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek typename ProgramStateTrait<T>::context_type C) const { 754ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return getStateManager().set<T>(this, K, E, C); 755ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 756ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 757ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate <typename CB> 758ae160f880d183ab938fd7ce3b891694ae2f569c0Ted KremenekCB ProgramState::scanReachableSymbols(SVal val) const { 759ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek CB cb(this); 760ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek scanReachableSymbols(val, cb); 761ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return cb; 762ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 763ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 764ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate <typename CB> 765ae160f880d183ab938fd7ce3b891694ae2f569c0Ted KremenekCB ProgramState::scanReachableSymbols(const SVal *beg, const SVal *end) const { 766ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek CB cb(this); 767ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek scanReachableSymbols(beg, end, cb); 768ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return cb; 769ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 770ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 771ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenektemplate <typename CB> 772ae160f880d183ab938fd7ce3b891694ae2f569c0Ted KremenekCB ProgramState::scanReachableSymbols(const MemRegion * const *beg, 773ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek const MemRegion * const *end) const { 774ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek CB cb(this); 775ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek scanReachableSymbols(beg, end, cb); 776ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek return cb; 777ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} 778ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 7795f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks/// \class ScanReachableSymbols 7805f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks/// A Utility class that allows to visit the reachable symbols using a custom 7815f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks/// SymbolVisitor. 782e0d24eb1060a213ec9820dc02c45f26b2d5b348bJordan Roseclass ScanReachableSymbols { 7835f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks typedef llvm::DenseMap<const void*, unsigned> VisitedItems; 7845f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks 7855f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks VisitedItems visited; 7868bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef state; 7875f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks SymbolVisitor &visitor; 7885f625712f622f6e57de17b6f7eec242956b993eeAnna Zakspublic: 7895f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks 7908bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ScanReachableSymbols(ProgramStateRef st, SymbolVisitor& v) 7915f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks : state(st), visitor(v) {} 7925f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks 7935f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks bool scan(nonloc::CompoundVal val); 7945f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks bool scan(SVal val); 7955f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks bool scan(const MemRegion *R); 7965f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks bool scan(const SymExpr *sym); 7975f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks}; 7985f625712f622f6e57de17b6f7eec242956b993eeAnna Zaks 799e54778d77d4f2b2d006bdb7e16f49271e1e9d13dAnna Zaks} // end ento namespace 800ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 801ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek} // end clang namespace 802ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek 803ae160f880d183ab938fd7ce3b891694ae2f569c0Ted Kremenek#endif 804