1218887Sdim//== RegionStore.cpp - Field-sensitive store model --------------*- C++ -*--==// 2218887Sdim// 3218887Sdim// The LLVM Compiler Infrastructure 4218887Sdim// 5218887Sdim// This file is distributed under the University of Illinois Open Source 6218887Sdim// License. See LICENSE.TXT for details. 7218887Sdim// 8218887Sdim//===----------------------------------------------------------------------===// 9218887Sdim// 10218887Sdim// This file defines a basic region store model. In this model, we do have field 11218887Sdim// sensitivity. But we assume nothing about the heap shape. So recursive data 12218887Sdim// structures are largely ignored. Basically we do 1-limiting analysis. 13218887Sdim// Parameter pointers are assumed with no aliasing. Pointee objects of 14218887Sdim// parameters are created lazily. 15218887Sdim// 16218887Sdim//===----------------------------------------------------------------------===// 17249423Sdim#include "clang/AST/Attr.h" 18218887Sdim#include "clang/AST/CharUnits.h" 19218887Sdim#include "clang/Analysis/Analyses/LiveVariables.h" 20218887Sdim#include "clang/Analysis/AnalysisContext.h" 21218887Sdim#include "clang/Basic/TargetInfo.h" 22251662Sdim#include "clang/StaticAnalyzer/Core/PathSensitive/AnalysisManager.h" 23239462Sdim#include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h" 24249423Sdim#include "clang/StaticAnalyzer/Core/PathSensitive/MemRegion.h" 25226633Sdim#include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState.h" 26226633Sdim#include "clang/StaticAnalyzer/Core/PathSensitive/ProgramStateTrait.h" 27251662Sdim#include "clang/StaticAnalyzer/Core/PathSensitive/SubEngine.h" 28218887Sdim#include "llvm/ADT/ImmutableList.h" 29218887Sdim#include "llvm/ADT/ImmutableMap.h" 30218887Sdim#include "llvm/ADT/Optional.h" 31218887Sdim#include "llvm/Support/raw_ostream.h" 32218887Sdim 33218887Sdimusing namespace clang; 34218887Sdimusing namespace ento; 35218887Sdim 36218887Sdim//===----------------------------------------------------------------------===// 37218887Sdim// Representation of binding keys. 38218887Sdim//===----------------------------------------------------------------------===// 39218887Sdim 40218887Sdimnamespace { 41218887Sdimclass BindingKey { 42218887Sdimpublic: 43239462Sdim enum Kind { Default = 0x0, Direct = 0x1 }; 44218887Sdimprivate: 45239462Sdim enum { Symbolic = 0x2 }; 46218887Sdim 47239462Sdim llvm::PointerIntPair<const MemRegion *, 2> P; 48239462Sdim uint64_t Data; 49239462Sdim 50249423Sdim /// Create a key for a binding to region \p r, which has a symbolic offset 51249423Sdim /// from region \p Base. 52249423Sdim explicit BindingKey(const SubRegion *r, const SubRegion *Base, Kind k) 53239462Sdim : P(r, k | Symbolic), Data(reinterpret_cast<uintptr_t>(Base)) { 54239462Sdim assert(r && Base && "Must have known regions."); 55239462Sdim assert(getConcreteOffsetRegion() == Base && "Failed to store base region"); 56239462Sdim } 57249423Sdim 58249423Sdim /// Create a key for a binding at \p offset from base region \p r. 59218887Sdim explicit BindingKey(const MemRegion *r, uint64_t offset, Kind k) 60239462Sdim : P(r, k), Data(offset) { 61239462Sdim assert(r && "Must have known regions."); 62239462Sdim assert(getOffset() == offset && "Failed to store offset"); 63239462Sdim assert((r == r->getBaseRegion() || isa<ObjCIvarRegion>(r)) && "Not a base"); 64239462Sdim } 65218887Sdimpublic: 66218887Sdim 67239462Sdim bool isDirect() const { return P.getInt() & Direct; } 68239462Sdim bool hasSymbolicOffset() const { return P.getInt() & Symbolic; } 69218887Sdim 70218887Sdim const MemRegion *getRegion() const { return P.getPointer(); } 71239462Sdim uint64_t getOffset() const { 72239462Sdim assert(!hasSymbolicOffset()); 73239462Sdim return Data; 74239462Sdim } 75218887Sdim 76249423Sdim const SubRegion *getConcreteOffsetRegion() const { 77239462Sdim assert(hasSymbolicOffset()); 78249423Sdim return reinterpret_cast<const SubRegion *>(static_cast<uintptr_t>(Data)); 79239462Sdim } 80239462Sdim 81239462Sdim const MemRegion *getBaseRegion() const { 82239462Sdim if (hasSymbolicOffset()) 83239462Sdim return getConcreteOffsetRegion()->getBaseRegion(); 84239462Sdim return getRegion()->getBaseRegion(); 85239462Sdim } 86239462Sdim 87218887Sdim void Profile(llvm::FoldingSetNodeID& ID) const { 88218887Sdim ID.AddPointer(P.getOpaqueValue()); 89239462Sdim ID.AddInteger(Data); 90218887Sdim } 91218887Sdim 92218887Sdim static BindingKey Make(const MemRegion *R, Kind k); 93218887Sdim 94218887Sdim bool operator<(const BindingKey &X) const { 95218887Sdim if (P.getOpaqueValue() < X.P.getOpaqueValue()) 96218887Sdim return true; 97218887Sdim if (P.getOpaqueValue() > X.P.getOpaqueValue()) 98218887Sdim return false; 99239462Sdim return Data < X.Data; 100218887Sdim } 101218887Sdim 102218887Sdim bool operator==(const BindingKey &X) const { 103218887Sdim return P.getOpaqueValue() == X.P.getOpaqueValue() && 104239462Sdim Data == X.Data; 105218887Sdim } 106218887Sdim 107239462Sdim LLVM_ATTRIBUTE_USED void dump() const; 108218887Sdim}; 109218887Sdim} // end anonymous namespace 110218887Sdim 111218887SdimBindingKey BindingKey::Make(const MemRegion *R, Kind k) { 112239462Sdim const RegionOffset &RO = R->getAsOffset(); 113239462Sdim if (RO.hasSymbolicOffset()) 114249423Sdim return BindingKey(cast<SubRegion>(R), cast<SubRegion>(RO.getRegion()), k); 115218887Sdim 116239462Sdim return BindingKey(RO.getRegion(), RO.getOffset(), k); 117218887Sdim} 118218887Sdim 119218887Sdimnamespace llvm { 120218887Sdim static inline 121226633Sdim raw_ostream &operator<<(raw_ostream &os, BindingKey K) { 122239462Sdim os << '(' << K.getRegion(); 123239462Sdim if (!K.hasSymbolicOffset()) 124239462Sdim os << ',' << K.getOffset(); 125239462Sdim os << ',' << (K.isDirect() ? "direct" : "default") 126218887Sdim << ')'; 127218887Sdim return os; 128218887Sdim } 129249423Sdim 130249423Sdim template <typename T> struct isPodLike; 131249423Sdim template <> struct isPodLike<BindingKey> { 132249423Sdim static const bool value = true; 133249423Sdim }; 134218887Sdim} // end llvm namespace 135218887Sdim 136239462Sdimvoid BindingKey::dump() const { 137239462Sdim llvm::errs() << *this; 138239462Sdim} 139239462Sdim 140218887Sdim//===----------------------------------------------------------------------===// 141218887Sdim// Actual Store type. 142218887Sdim//===----------------------------------------------------------------------===// 143218887Sdim 144249423Sdimtypedef llvm::ImmutableMap<BindingKey, SVal> ClusterBindings; 145249423Sdimtypedef llvm::ImmutableMapRef<BindingKey, SVal> ClusterBindingsRef; 146249423Sdimtypedef std::pair<BindingKey, SVal> BindingPair; 147218887Sdim 148249423Sdimtypedef llvm::ImmutableMap<const MemRegion *, ClusterBindings> 149249423Sdim RegionBindings; 150249423Sdim 151249423Sdimnamespace { 152249423Sdimclass RegionBindingsRef : public llvm::ImmutableMapRef<const MemRegion *, 153249423Sdim ClusterBindings> { 154249423Sdim ClusterBindings::Factory &CBFactory; 155249423Sdimpublic: 156249423Sdim typedef llvm::ImmutableMapRef<const MemRegion *, ClusterBindings> 157249423Sdim ParentTy; 158249423Sdim 159249423Sdim RegionBindingsRef(ClusterBindings::Factory &CBFactory, 160249423Sdim const RegionBindings::TreeTy *T, 161249423Sdim RegionBindings::TreeTy::Factory *F) 162249423Sdim : llvm::ImmutableMapRef<const MemRegion *, ClusterBindings>(T, F), 163249423Sdim CBFactory(CBFactory) {} 164249423Sdim 165249423Sdim RegionBindingsRef(const ParentTy &P, ClusterBindings::Factory &CBFactory) 166249423Sdim : llvm::ImmutableMapRef<const MemRegion *, ClusterBindings>(P), 167249423Sdim CBFactory(CBFactory) {} 168249423Sdim 169249423Sdim RegionBindingsRef add(key_type_ref K, data_type_ref D) const { 170249423Sdim return RegionBindingsRef(static_cast<const ParentTy*>(this)->add(K, D), 171249423Sdim CBFactory); 172249423Sdim } 173249423Sdim 174249423Sdim RegionBindingsRef remove(key_type_ref K) const { 175249423Sdim return RegionBindingsRef(static_cast<const ParentTy*>(this)->remove(K), 176249423Sdim CBFactory); 177249423Sdim } 178249423Sdim 179249423Sdim RegionBindingsRef addBinding(BindingKey K, SVal V) const; 180249423Sdim 181249423Sdim RegionBindingsRef addBinding(const MemRegion *R, 182249423Sdim BindingKey::Kind k, SVal V) const; 183249423Sdim 184249423Sdim RegionBindingsRef &operator=(const RegionBindingsRef &X) { 185249423Sdim *static_cast<ParentTy*>(this) = X; 186249423Sdim return *this; 187249423Sdim } 188249423Sdim 189249423Sdim const SVal *lookup(BindingKey K) const; 190249423Sdim const SVal *lookup(const MemRegion *R, BindingKey::Kind k) const; 191249423Sdim const ClusterBindings *lookup(const MemRegion *R) const { 192249423Sdim return static_cast<const ParentTy*>(this)->lookup(R); 193249423Sdim } 194249423Sdim 195249423Sdim RegionBindingsRef removeBinding(BindingKey K); 196249423Sdim 197249423Sdim RegionBindingsRef removeBinding(const MemRegion *R, 198249423Sdim BindingKey::Kind k); 199249423Sdim 200249423Sdim RegionBindingsRef removeBinding(const MemRegion *R) { 201249423Sdim return removeBinding(R, BindingKey::Direct). 202249423Sdim removeBinding(R, BindingKey::Default); 203249423Sdim } 204249423Sdim 205249423Sdim Optional<SVal> getDirectBinding(const MemRegion *R) const; 206249423Sdim 207249423Sdim /// getDefaultBinding - Returns an SVal* representing an optional default 208249423Sdim /// binding associated with a region and its subregions. 209249423Sdim Optional<SVal> getDefaultBinding(const MemRegion *R) const; 210249423Sdim 211249423Sdim /// Return the internal tree as a Store. 212249423Sdim Store asStore() const { 213249423Sdim return asImmutableMap().getRootWithoutRetain(); 214249423Sdim } 215249423Sdim 216249423Sdim void dump(raw_ostream &OS, const char *nl) const { 217249423Sdim for (iterator I = begin(), E = end(); I != E; ++I) { 218249423Sdim const ClusterBindings &Cluster = I.getData(); 219249423Sdim for (ClusterBindings::iterator CI = Cluster.begin(), CE = Cluster.end(); 220249423Sdim CI != CE; ++CI) { 221249423Sdim OS << ' ' << CI.getKey() << " : " << CI.getData() << nl; 222249423Sdim } 223249423Sdim OS << nl; 224249423Sdim } 225249423Sdim } 226249423Sdim 227249423Sdim LLVM_ATTRIBUTE_USED void dump() const { 228249423Sdim dump(llvm::errs(), "\n"); 229249423Sdim } 230249423Sdim}; 231249423Sdim} // end anonymous namespace 232249423Sdim 233249423Sdimtypedef const RegionBindingsRef& RegionBindingsConstRef; 234249423Sdim 235249423SdimOptional<SVal> RegionBindingsRef::getDirectBinding(const MemRegion *R) const { 236249423Sdim return Optional<SVal>::create(lookup(R, BindingKey::Direct)); 237249423Sdim} 238249423Sdim 239249423SdimOptional<SVal> RegionBindingsRef::getDefaultBinding(const MemRegion *R) const { 240249423Sdim if (R->isBoundable()) 241249423Sdim if (const TypedValueRegion *TR = dyn_cast<TypedValueRegion>(R)) 242249423Sdim if (TR->getValueType()->isUnionType()) 243249423Sdim return UnknownVal(); 244249423Sdim 245249423Sdim return Optional<SVal>::create(lookup(R, BindingKey::Default)); 246249423Sdim} 247249423Sdim 248249423SdimRegionBindingsRef RegionBindingsRef::addBinding(BindingKey K, SVal V) const { 249249423Sdim const MemRegion *Base = K.getBaseRegion(); 250249423Sdim 251249423Sdim const ClusterBindings *ExistingCluster = lookup(Base); 252249423Sdim ClusterBindings Cluster = (ExistingCluster ? *ExistingCluster 253249423Sdim : CBFactory.getEmptyMap()); 254249423Sdim 255249423Sdim ClusterBindings NewCluster = CBFactory.add(Cluster, K, V); 256249423Sdim return add(Base, NewCluster); 257249423Sdim} 258249423Sdim 259249423Sdim 260249423SdimRegionBindingsRef RegionBindingsRef::addBinding(const MemRegion *R, 261249423Sdim BindingKey::Kind k, 262249423Sdim SVal V) const { 263249423Sdim return addBinding(BindingKey::Make(R, k), V); 264249423Sdim} 265249423Sdim 266249423Sdimconst SVal *RegionBindingsRef::lookup(BindingKey K) const { 267249423Sdim const ClusterBindings *Cluster = lookup(K.getBaseRegion()); 268249423Sdim if (!Cluster) 269249423Sdim return 0; 270249423Sdim return Cluster->lookup(K); 271249423Sdim} 272249423Sdim 273249423Sdimconst SVal *RegionBindingsRef::lookup(const MemRegion *R, 274249423Sdim BindingKey::Kind k) const { 275249423Sdim return lookup(BindingKey::Make(R, k)); 276249423Sdim} 277249423Sdim 278249423SdimRegionBindingsRef RegionBindingsRef::removeBinding(BindingKey K) { 279249423Sdim const MemRegion *Base = K.getBaseRegion(); 280249423Sdim const ClusterBindings *Cluster = lookup(Base); 281249423Sdim if (!Cluster) 282249423Sdim return *this; 283249423Sdim 284249423Sdim ClusterBindings NewCluster = CBFactory.remove(*Cluster, K); 285249423Sdim if (NewCluster.isEmpty()) 286249423Sdim return remove(Base); 287249423Sdim return add(Base, NewCluster); 288249423Sdim} 289249423Sdim 290249423SdimRegionBindingsRef RegionBindingsRef::removeBinding(const MemRegion *R, 291249423Sdim BindingKey::Kind k){ 292249423Sdim return removeBinding(BindingKey::Make(R, k)); 293249423Sdim} 294249423Sdim 295218887Sdim//===----------------------------------------------------------------------===// 296218887Sdim// Fine-grained control of RegionStoreManager. 297218887Sdim//===----------------------------------------------------------------------===// 298218887Sdim 299218887Sdimnamespace { 300218887Sdimstruct minimal_features_tag {}; 301218887Sdimstruct maximal_features_tag {}; 302218887Sdim 303218887Sdimclass RegionStoreFeatures { 304218887Sdim bool SupportsFields; 305218887Sdimpublic: 306218887Sdim RegionStoreFeatures(minimal_features_tag) : 307218887Sdim SupportsFields(false) {} 308218887Sdim 309218887Sdim RegionStoreFeatures(maximal_features_tag) : 310218887Sdim SupportsFields(true) {} 311218887Sdim 312218887Sdim void enableFields(bool t) { SupportsFields = t; } 313218887Sdim 314218887Sdim bool supportsFields() const { return SupportsFields; } 315218887Sdim}; 316218887Sdim} 317218887Sdim 318218887Sdim//===----------------------------------------------------------------------===// 319218887Sdim// Main RegionStore logic. 320218887Sdim//===----------------------------------------------------------------------===// 321218887Sdim 322218887Sdimnamespace { 323249423Sdimclass invalidateRegionsWorker; 324218887Sdim 325218887Sdimclass RegionStoreManager : public StoreManager { 326249423Sdimpublic: 327218887Sdim const RegionStoreFeatures Features; 328251662Sdim 329218887Sdim RegionBindings::Factory RBFactory; 330249423Sdim mutable ClusterBindings::Factory CBFactory; 331218887Sdim 332249423Sdim typedef std::vector<SVal> SValListTy; 333249423Sdimprivate: 334249423Sdim typedef llvm::DenseMap<const LazyCompoundValData *, 335249423Sdim SValListTy> LazyBindingsMapTy; 336249423Sdim LazyBindingsMapTy LazyBindingsMap; 337249423Sdim 338251662Sdim /// The largest number of fields a struct can have and still be 339251662Sdim /// considered "small". 340251662Sdim /// 341251662Sdim /// This is currently used to decide whether or not it is worth "forcing" a 342251662Sdim /// LazyCompoundVal on bind. 343251662Sdim /// 344251662Sdim /// This is controlled by 'region-store-small-struct-limit' option. 345251662Sdim /// To disable all small-struct-dependent behavior, set the option to "0". 346251662Sdim unsigned SmallStructLimit; 347251662Sdim 348249423Sdim /// \brief A helper used to populate the work list with the given set of 349249423Sdim /// regions. 350249423Sdim void populateWorkList(invalidateRegionsWorker &W, 351249423Sdim ArrayRef<SVal> Values, 352249423Sdim InvalidatedRegions *TopLevelRegions); 353249423Sdim 354218887Sdimpublic: 355226633Sdim RegionStoreManager(ProgramStateManager& mgr, const RegionStoreFeatures &f) 356239462Sdim : StoreManager(mgr), Features(f), 357251662Sdim RBFactory(mgr.getAllocator()), CBFactory(mgr.getAllocator()), 358251662Sdim SmallStructLimit(0) { 359251662Sdim if (SubEngine *Eng = StateMgr.getOwningEngine()) { 360251662Sdim AnalyzerOptions &Options = Eng->getAnalysisManager().options; 361251662Sdim SmallStructLimit = 362251662Sdim Options.getOptionAsInteger("region-store-small-struct-limit", 2); 363251662Sdim } 364251662Sdim } 365218887Sdim 366218887Sdim 367218887Sdim /// setImplicitDefaultValue - Set the default binding for the provided 368218887Sdim /// MemRegion to the value implicitly defined for compound literals when 369218887Sdim /// the value is not specified. 370249423Sdim RegionBindingsRef setImplicitDefaultValue(RegionBindingsConstRef B, 371249423Sdim const MemRegion *R, QualType T); 372218887Sdim 373218887Sdim /// ArrayToPointer - Emulates the "decay" of an array to a pointer 374218887Sdim /// type. 'Array' represents the lvalue of the array being decayed 375218887Sdim /// to a pointer, and the returned SVal represents the decayed 376218887Sdim /// version of that lvalue (i.e., a pointer to the first element of 377218887Sdim /// the array). This is called by ExprEngine when evaluating 378218887Sdim /// casts from arrays to pointers. 379263508Sdim SVal ArrayToPointer(Loc Array, QualType ElementTy); 380218887Sdim 381218887Sdim StoreRef getInitialStore(const LocationContext *InitLoc) { 382218887Sdim return StoreRef(RBFactory.getEmptyMap().getRootWithoutRetain(), *this); 383218887Sdim } 384218887Sdim 385218887Sdim //===-------------------------------------------------------------------===// 386218887Sdim // Binding values to regions. 387218887Sdim //===-------------------------------------------------------------------===// 388249423Sdim RegionBindingsRef invalidateGlobalRegion(MemRegion::Kind K, 389249423Sdim const Expr *Ex, 390249423Sdim unsigned Count, 391249423Sdim const LocationContext *LCtx, 392249423Sdim RegionBindingsRef B, 393249423Sdim InvalidatedRegions *Invalidated); 394218887Sdim 395249423Sdim StoreRef invalidateRegions(Store store, 396249423Sdim ArrayRef<SVal> Values, 397218887Sdim const Expr *E, unsigned Count, 398234353Sdim const LocationContext *LCtx, 399249423Sdim const CallEvent *Call, 400223017Sdim InvalidatedSymbols &IS, 401263508Sdim RegionAndSymbolInvalidationTraits &ITraits, 402249423Sdim InvalidatedRegions *Invalidated, 403263508Sdim InvalidatedRegions *InvalidatedTopLevel); 404218887Sdim 405239462Sdim bool scanReachableSymbols(Store S, const MemRegion *R, 406239462Sdim ScanReachableSymbols &Callbacks); 407239462Sdim 408249423Sdim RegionBindingsRef removeSubRegionBindings(RegionBindingsConstRef B, 409249423Sdim const SubRegion *R); 410218887Sdim 411249423Sdimpublic: // Part of public interface to class. 412218887Sdim 413249423Sdim virtual StoreRef Bind(Store store, Loc LV, SVal V) { 414249423Sdim return StoreRef(bind(getRegionBindings(store), LV, V).asStore(), *this); 415218887Sdim } 416218887Sdim 417249423Sdim RegionBindingsRef bind(RegionBindingsConstRef B, Loc LV, SVal V); 418239462Sdim 419218887Sdim // BindDefault is only used to initialize a region with a default value. 420218887Sdim StoreRef BindDefault(Store store, const MemRegion *R, SVal V) { 421249423Sdim RegionBindingsRef B = getRegionBindings(store); 422249423Sdim assert(!B.lookup(R, BindingKey::Direct)); 423263508Sdim 424263508Sdim BindingKey Key = BindingKey::Make(R, BindingKey::Default); 425263508Sdim if (B.lookup(Key)) { 426263508Sdim const SubRegion *SR = cast<SubRegion>(R); 427263508Sdim assert(SR->getAsOffset().getOffset() == 428263508Sdim SR->getSuperRegion()->getAsOffset().getOffset() && 429263508Sdim "A default value must come from a super-region"); 430263508Sdim B = removeSubRegionBindings(B, SR); 431263508Sdim } else { 432263508Sdim B = B.addBinding(Key, V); 433263508Sdim } 434263508Sdim 435263508Sdim return StoreRef(B.asImmutableMap().getRootWithoutRetain(), *this); 436218887Sdim } 437218887Sdim 438251662Sdim /// Attempt to extract the fields of \p LCV and bind them to the struct region 439251662Sdim /// \p R. 440243830Sdim /// 441251662Sdim /// This path is used when it seems advantageous to "force" loading the values 442251662Sdim /// within a LazyCompoundVal to bind memberwise to the struct region, rather 443251662Sdim /// than using a Default binding at the base of the entire region. This is a 444251662Sdim /// heuristic attempting to avoid building long chains of LazyCompoundVals. 445243830Sdim /// 446251662Sdim /// \returns The updated store bindings, or \c None if binding non-lazily 447251662Sdim /// would be too expensive. 448251662Sdim Optional<RegionBindingsRef> tryBindSmallStruct(RegionBindingsConstRef B, 449251662Sdim const TypedValueRegion *R, 450251662Sdim const RecordDecl *RD, 451251662Sdim nonloc::LazyCompoundVal LCV); 452218887Sdim 453218887Sdim /// BindStruct - Bind a compound value to a structure. 454249423Sdim RegionBindingsRef bindStruct(RegionBindingsConstRef B, 455249423Sdim const TypedValueRegion* R, SVal V); 456218887Sdim 457239462Sdim /// BindVector - Bind a compound value to a vector. 458249423Sdim RegionBindingsRef bindVector(RegionBindingsConstRef B, 459249423Sdim const TypedValueRegion* R, SVal V); 460239462Sdim 461249423Sdim RegionBindingsRef bindArray(RegionBindingsConstRef B, 462249423Sdim const TypedValueRegion* R, 463249423Sdim SVal V); 464218887Sdim 465239462Sdim /// Clears out all bindings in the given region and assigns a new value 466239462Sdim /// as a Default binding. 467249423Sdim RegionBindingsRef bindAggregate(RegionBindingsConstRef B, 468249423Sdim const TypedRegion *R, 469249423Sdim SVal DefaultVal); 470218887Sdim 471243830Sdim /// \brief Create a new store with the specified binding removed. 472243830Sdim /// \param ST the original store, that is the basis for the new store. 473243830Sdim /// \param L the location whose binding should be removed. 474249423Sdim virtual StoreRef killBinding(Store ST, Loc L); 475218887Sdim 476218887Sdim void incrementReferenceCount(Store store) { 477249423Sdim getRegionBindings(store).manualRetain(); 478218887Sdim } 479218887Sdim 480218887Sdim /// If the StoreManager supports it, decrement the reference count of 481218887Sdim /// the specified Store object. If the reference count hits 0, the memory 482218887Sdim /// associated with the object is recycled. 483218887Sdim void decrementReferenceCount(Store store) { 484249423Sdim getRegionBindings(store).manualRelease(); 485218887Sdim } 486226633Sdim 487226633Sdim bool includedInBindings(Store store, const MemRegion *region) const; 488218887Sdim 489234353Sdim /// \brief Return the value bound to specified location in a given state. 490234353Sdim /// 491218887Sdim /// The high level logic for this method is this: 492234353Sdim /// getBinding (L) 493218887Sdim /// if L has binding 494218887Sdim /// return L's binding 495218887Sdim /// else if L is in killset 496218887Sdim /// return unknown 497218887Sdim /// else 498218887Sdim /// if L is on stack or heap 499218887Sdim /// return undefined 500218887Sdim /// else 501218887Sdim /// return symbolic 502249423Sdim virtual SVal getBinding(Store S, Loc L, QualType T) { 503249423Sdim return getBinding(getRegionBindings(S), L, T); 504249423Sdim } 505218887Sdim 506249423Sdim SVal getBinding(RegionBindingsConstRef B, Loc L, QualType T = QualType()); 507218887Sdim 508249423Sdim SVal getBindingForElement(RegionBindingsConstRef B, const ElementRegion *R); 509218887Sdim 510249423Sdim SVal getBindingForField(RegionBindingsConstRef B, const FieldRegion *R); 511218887Sdim 512249423Sdim SVal getBindingForObjCIvar(RegionBindingsConstRef B, const ObjCIvarRegion *R); 513218887Sdim 514249423Sdim SVal getBindingForVar(RegionBindingsConstRef B, const VarRegion *R); 515249423Sdim 516234353Sdim SVal getBindingForLazySymbol(const TypedValueRegion *R); 517218887Sdim 518249423Sdim SVal getBindingForFieldOrElementCommon(RegionBindingsConstRef B, 519249423Sdim const TypedValueRegion *R, 520251662Sdim QualType Ty); 521221345Sdim 522249423Sdim SVal getLazyBinding(const SubRegion *LazyBindingRegion, 523249423Sdim RegionBindingsRef LazyBinding); 524218887Sdim 525234353Sdim /// Get bindings for the values in a struct and return a CompoundVal, used 526234353Sdim /// when doing struct copy: 527218887Sdim /// struct s x, y; 528218887Sdim /// x = y; 529218887Sdim /// y's value is retrieved by this method. 530249423Sdim SVal getBindingForStruct(RegionBindingsConstRef B, const TypedValueRegion *R); 531249423Sdim SVal getBindingForArray(RegionBindingsConstRef B, const TypedValueRegion *R); 532249423Sdim NonLoc createLazyBinding(RegionBindingsConstRef B, const TypedValueRegion *R); 533218887Sdim 534218887Sdim /// Used to lazily generate derived symbols for bindings that are defined 535249423Sdim /// implicitly by default bindings in a super region. 536249423Sdim /// 537249423Sdim /// Note that callers may need to specially handle LazyCompoundVals, which 538249423Sdim /// are returned as is in case the caller needs to treat them differently. 539249423Sdim Optional<SVal> getBindingForDerivedDefaultValue(RegionBindingsConstRef B, 540234353Sdim const MemRegion *superR, 541234353Sdim const TypedValueRegion *R, 542234353Sdim QualType Ty); 543218887Sdim 544249423Sdim /// Get the state and region whose binding this region \p R corresponds to. 545249423Sdim /// 546249423Sdim /// If there is no lazy binding for \p R, the returned value will have a null 547249423Sdim /// \c second. Note that a null pointer can represents a valid Store. 548249423Sdim std::pair<Store, const SubRegion *> 549249423Sdim findLazyBinding(RegionBindingsConstRef B, const SubRegion *R, 550249423Sdim const SubRegion *originalRegion); 551218887Sdim 552249423Sdim /// Returns the cached set of interesting SVals contained within a lazy 553249423Sdim /// binding. 554249423Sdim /// 555249423Sdim /// The precise value of "interesting" is determined for the purposes of 556249423Sdim /// RegionStore's internal analysis. It must always contain all regions and 557249423Sdim /// symbols, but may omit constants and other kinds of SVal. 558249423Sdim const SValListTy &getInterestingValues(nonloc::LazyCompoundVal LCV); 559249423Sdim 560218887Sdim //===------------------------------------------------------------------===// 561218887Sdim // State pruning. 562218887Sdim //===------------------------------------------------------------------===// 563218887Sdim 564218887Sdim /// removeDeadBindings - Scans the RegionStore of 'state' for dead values. 565218887Sdim /// It returns a new Store with these values removed. 566218887Sdim StoreRef removeDeadBindings(Store store, const StackFrameContext *LCtx, 567226633Sdim SymbolReaper& SymReaper); 568239462Sdim 569218887Sdim //===------------------------------------------------------------------===// 570218887Sdim // Region "extents". 571218887Sdim //===------------------------------------------------------------------===// 572218887Sdim 573218887Sdim // FIXME: This method will soon be eliminated; see the note in Store.h. 574234353Sdim DefinedOrUnknownSVal getSizeInElements(ProgramStateRef state, 575218887Sdim const MemRegion* R, QualType EleTy); 576218887Sdim 577218887Sdim //===------------------------------------------------------------------===// 578218887Sdim // Utility methods. 579218887Sdim //===------------------------------------------------------------------===// 580218887Sdim 581249423Sdim RegionBindingsRef getRegionBindings(Store store) const { 582249423Sdim return RegionBindingsRef(CBFactory, 583249423Sdim static_cast<const RegionBindings::TreeTy*>(store), 584249423Sdim RBFactory.getTreeFactory()); 585218887Sdim } 586218887Sdim 587226633Sdim void print(Store store, raw_ostream &Out, const char* nl, 588218887Sdim const char *sep); 589218887Sdim 590218887Sdim void iterBindings(Store store, BindingsHandler& f) { 591249423Sdim RegionBindingsRef B = getRegionBindings(store); 592249423Sdim for (RegionBindingsRef::iterator I = B.begin(), E = B.end(); I != E; ++I) { 593239462Sdim const ClusterBindings &Cluster = I.getData(); 594239462Sdim for (ClusterBindings::iterator CI = Cluster.begin(), CE = Cluster.end(); 595239462Sdim CI != CE; ++CI) { 596239462Sdim const BindingKey &K = CI.getKey(); 597239462Sdim if (!K.isDirect()) 598239462Sdim continue; 599239462Sdim if (const SubRegion *R = dyn_cast<SubRegion>(K.getRegion())) { 600239462Sdim // FIXME: Possibly incorporate the offset? 601239462Sdim if (!f.HandleBinding(*this, store, R, CI.getData())) 602239462Sdim return; 603239462Sdim } 604218887Sdim } 605218887Sdim } 606218887Sdim } 607218887Sdim}; 608218887Sdim 609218887Sdim} // end anonymous namespace 610218887Sdim 611218887Sdim//===----------------------------------------------------------------------===// 612218887Sdim// RegionStore creation. 613218887Sdim//===----------------------------------------------------------------------===// 614218887Sdim 615226633SdimStoreManager *ento::CreateRegionStoreManager(ProgramStateManager& StMgr) { 616218887Sdim RegionStoreFeatures F = maximal_features_tag(); 617218887Sdim return new RegionStoreManager(StMgr, F); 618218887Sdim} 619218887Sdim 620234353SdimStoreManager * 621234353Sdimento::CreateFieldsOnlyRegionStoreManager(ProgramStateManager &StMgr) { 622218887Sdim RegionStoreFeatures F = minimal_features_tag(); 623218887Sdim F.enableFields(true); 624218887Sdim return new RegionStoreManager(StMgr, F); 625218887Sdim} 626218887Sdim 627218887Sdim 628218887Sdim//===----------------------------------------------------------------------===// 629218887Sdim// Region Cluster analysis. 630218887Sdim//===----------------------------------------------------------------------===// 631218887Sdim 632218887Sdimnamespace { 633251662Sdim/// Used to determine which global regions are automatically included in the 634251662Sdim/// initial worklist of a ClusterAnalysis. 635251662Sdimenum GlobalsFilterKind { 636251662Sdim /// Don't include any global regions. 637251662Sdim GFK_None, 638251662Sdim /// Only include system globals. 639251662Sdim GFK_SystemOnly, 640251662Sdim /// Include all global regions. 641251662Sdim GFK_All 642251662Sdim}; 643251662Sdim 644218887Sdimtemplate <typename DERIVED> 645218887Sdimclass ClusterAnalysis { 646218887Sdimprotected: 647239462Sdim typedef llvm::DenseMap<const MemRegion *, const ClusterBindings *> ClusterMap; 648263508Sdim typedef const MemRegion * WorkListElement; 649249423Sdim typedef SmallVector<WorkListElement, 10> WorkList; 650218887Sdim 651239462Sdim llvm::SmallPtrSet<const ClusterBindings *, 16> Visited; 652239462Sdim 653218887Sdim WorkList WL; 654218887Sdim 655218887Sdim RegionStoreManager &RM; 656218887Sdim ASTContext &Ctx; 657218887Sdim SValBuilder &svalBuilder; 658218887Sdim 659249423Sdim RegionBindingsRef B; 660218887Sdim 661251662Sdimprivate: 662251662Sdim GlobalsFilterKind GlobalsFilter; 663251662Sdim 664251662Sdimprotected: 665239462Sdim const ClusterBindings *getCluster(const MemRegion *R) { 666239462Sdim return B.lookup(R); 667239462Sdim } 668239462Sdim 669251662Sdim /// Returns true if the memory space of the given region is one of the global 670251662Sdim /// regions specially included at the start of analysis. 671251662Sdim bool isInitiallyIncludedGlobalRegion(const MemRegion *R) { 672251662Sdim switch (GlobalsFilter) { 673251662Sdim case GFK_None: 674251662Sdim return false; 675251662Sdim case GFK_SystemOnly: 676251662Sdim return isa<GlobalSystemSpaceRegion>(R->getMemorySpace()); 677251662Sdim case GFK_All: 678251662Sdim return isa<NonStaticGlobalSpaceRegion>(R->getMemorySpace()); 679251662Sdim } 680251662Sdim 681251662Sdim llvm_unreachable("unknown globals filter"); 682251662Sdim } 683251662Sdim 684218887Sdimpublic: 685226633Sdim ClusterAnalysis(RegionStoreManager &rm, ProgramStateManager &StateMgr, 686251662Sdim RegionBindingsRef b, GlobalsFilterKind GFK) 687218887Sdim : RM(rm), Ctx(StateMgr.getContext()), 688218887Sdim svalBuilder(StateMgr.getSValBuilder()), 689251662Sdim B(b), GlobalsFilter(GFK) {} 690218887Sdim 691249423Sdim RegionBindingsRef getRegionBindings() const { return B; } 692218887Sdim 693218887Sdim bool isVisited(const MemRegion *R) { 694239462Sdim return Visited.count(getCluster(R)); 695218887Sdim } 696218887Sdim 697218887Sdim void GenerateClusters() { 698239462Sdim // Scan the entire set of bindings and record the region clusters. 699249423Sdim for (RegionBindingsRef::iterator RI = B.begin(), RE = B.end(); 700249423Sdim RI != RE; ++RI){ 701239462Sdim const MemRegion *Base = RI.getKey(); 702239462Sdim 703239462Sdim const ClusterBindings &Cluster = RI.getData(); 704239462Sdim assert(!Cluster.isEmpty() && "Empty clusters should be removed"); 705239462Sdim static_cast<DERIVED*>(this)->VisitAddedToCluster(Base, Cluster); 706239462Sdim 707251662Sdim // If this is an interesting global region, add it the work list up front. 708251662Sdim if (isInitiallyIncludedGlobalRegion(Base)) 709251662Sdim AddToWorkList(WorkListElement(Base), &Cluster); 710218887Sdim } 711218887Sdim } 712218887Sdim 713249423Sdim bool AddToWorkList(WorkListElement E, const ClusterBindings *C) { 714243830Sdim if (C && !Visited.insert(C)) 715243830Sdim return false; 716249423Sdim WL.push_back(E); 717218887Sdim return true; 718218887Sdim } 719218887Sdim 720263508Sdim bool AddToWorkList(const MemRegion *R) { 721249423Sdim const MemRegion *BaseR = R->getBaseRegion(); 722263508Sdim return AddToWorkList(WorkListElement(BaseR), getCluster(BaseR)); 723218887Sdim } 724218887Sdim 725218887Sdim void RunWorkList() { 726218887Sdim while (!WL.empty()) { 727249423Sdim WorkListElement E = WL.pop_back_val(); 728263508Sdim const MemRegion *BaseR = E; 729218887Sdim 730263508Sdim static_cast<DERIVED*>(this)->VisitCluster(BaseR, getCluster(BaseR)); 731218887Sdim } 732218887Sdim } 733218887Sdim 734239462Sdim void VisitAddedToCluster(const MemRegion *baseR, const ClusterBindings &C) {} 735249423Sdim void VisitCluster(const MemRegion *baseR, const ClusterBindings *C) {} 736249423Sdim 737249423Sdim void VisitCluster(const MemRegion *BaseR, const ClusterBindings *C, 738249423Sdim bool Flag) { 739249423Sdim static_cast<DERIVED*>(this)->VisitCluster(BaseR, C); 740249423Sdim } 741218887Sdim}; 742218887Sdim} 743218887Sdim 744218887Sdim//===----------------------------------------------------------------------===// 745218887Sdim// Binding invalidation. 746218887Sdim//===----------------------------------------------------------------------===// 747218887Sdim 748239462Sdimbool RegionStoreManager::scanReachableSymbols(Store S, const MemRegion *R, 749239462Sdim ScanReachableSymbols &Callbacks) { 750239462Sdim assert(R == R->getBaseRegion() && "Should only be called for base regions"); 751249423Sdim RegionBindingsRef B = getRegionBindings(S); 752239462Sdim const ClusterBindings *Cluster = B.lookup(R); 753218887Sdim 754239462Sdim if (!Cluster) 755239462Sdim return true; 756218887Sdim 757239462Sdim for (ClusterBindings::iterator RI = Cluster->begin(), RE = Cluster->end(); 758239462Sdim RI != RE; ++RI) { 759239462Sdim if (!Callbacks.scan(RI.getData())) 760239462Sdim return false; 761239462Sdim } 762239462Sdim 763239462Sdim return true; 764218887Sdim} 765218887Sdim 766243830Sdimstatic inline bool isUnionField(const FieldRegion *FR) { 767243830Sdim return FR->getDecl()->getParent()->isUnion(); 768243830Sdim} 769243830Sdim 770243830Sdimtypedef SmallVector<const FieldDecl *, 8> FieldVector; 771243830Sdim 772243830Sdimvoid getSymbolicOffsetFields(BindingKey K, FieldVector &Fields) { 773243830Sdim assert(K.hasSymbolicOffset() && "Not implemented for concrete offset keys"); 774243830Sdim 775243830Sdim const MemRegion *Base = K.getConcreteOffsetRegion(); 776243830Sdim const MemRegion *R = K.getRegion(); 777243830Sdim 778243830Sdim while (R != Base) { 779243830Sdim if (const FieldRegion *FR = dyn_cast<FieldRegion>(R)) 780243830Sdim if (!isUnionField(FR)) 781243830Sdim Fields.push_back(FR->getDecl()); 782243830Sdim 783243830Sdim R = cast<SubRegion>(R)->getSuperRegion(); 784243830Sdim } 785243830Sdim} 786243830Sdim 787243830Sdimstatic bool isCompatibleWithFields(BindingKey K, const FieldVector &Fields) { 788243830Sdim assert(K.hasSymbolicOffset() && "Not implemented for concrete offset keys"); 789243830Sdim 790243830Sdim if (Fields.empty()) 791243830Sdim return true; 792243830Sdim 793243830Sdim FieldVector FieldsInBindingKey; 794243830Sdim getSymbolicOffsetFields(K, FieldsInBindingKey); 795243830Sdim 796243830Sdim ptrdiff_t Delta = FieldsInBindingKey.size() - Fields.size(); 797243830Sdim if (Delta >= 0) 798243830Sdim return std::equal(FieldsInBindingKey.begin() + Delta, 799243830Sdim FieldsInBindingKey.end(), 800243830Sdim Fields.begin()); 801243830Sdim else 802243830Sdim return std::equal(FieldsInBindingKey.begin(), FieldsInBindingKey.end(), 803243830Sdim Fields.begin() - Delta); 804243830Sdim} 805243830Sdim 806249423Sdim/// Collects all bindings in \p Cluster that may refer to bindings within 807249423Sdim/// \p Top. 808249423Sdim/// 809249423Sdim/// Each binding is a pair whose \c first is the key (a BindingKey) and whose 810249423Sdim/// \c second is the value (an SVal). 811249423Sdim/// 812249423Sdim/// The \p IncludeAllDefaultBindings parameter specifies whether to include 813249423Sdim/// default bindings that may extend beyond \p Top itself, e.g. if \p Top is 814249423Sdim/// an aggregate within a larger aggregate with a default binding. 815249423Sdimstatic void 816249423SdimcollectSubRegionBindings(SmallVectorImpl<BindingPair> &Bindings, 817249423Sdim SValBuilder &SVB, const ClusterBindings &Cluster, 818249423Sdim const SubRegion *Top, BindingKey TopKey, 819249423Sdim bool IncludeAllDefaultBindings) { 820243830Sdim FieldVector FieldsInSymbolicSubregions; 821249423Sdim if (TopKey.hasSymbolicOffset()) { 822249423Sdim getSymbolicOffsetFields(TopKey, FieldsInSymbolicSubregions); 823249423Sdim Top = cast<SubRegion>(TopKey.getConcreteOffsetRegion()); 824249423Sdim TopKey = BindingKey::Make(Top, BindingKey::Default); 825239462Sdim } 826239462Sdim 827249423Sdim // Find the length (in bits) of the region being invalidated. 828239462Sdim uint64_t Length = UINT64_MAX; 829249423Sdim SVal Extent = Top->getExtent(SVB); 830249423Sdim if (Optional<nonloc::ConcreteInt> ExtentCI = 831249423Sdim Extent.getAs<nonloc::ConcreteInt>()) { 832239462Sdim const llvm::APSInt &ExtentInt = ExtentCI->getValue(); 833239462Sdim assert(ExtentInt.isNonNegative() || ExtentInt.isUnsigned()); 834239462Sdim // Extents are in bytes but region offsets are in bits. Be careful! 835249423Sdim Length = ExtentInt.getLimitedValue() * SVB.getContext().getCharWidth(); 836249423Sdim } else if (const FieldRegion *FR = dyn_cast<FieldRegion>(Top)) { 837249423Sdim if (FR->getDecl()->isBitField()) 838249423Sdim Length = FR->getDecl()->getBitWidthValue(SVB.getContext()); 839239462Sdim } 840239462Sdim 841249423Sdim for (ClusterBindings::iterator I = Cluster.begin(), E = Cluster.end(); 842239462Sdim I != E; ++I) { 843239462Sdim BindingKey NextKey = I.getKey(); 844249423Sdim if (NextKey.getRegion() == TopKey.getRegion()) { 845243830Sdim // FIXME: This doesn't catch the case where we're really invalidating a 846243830Sdim // region with a symbolic offset. Example: 847243830Sdim // R: points[i].y 848243830Sdim // Next: points[0].x 849243830Sdim 850249423Sdim if (NextKey.getOffset() > TopKey.getOffset() && 851249423Sdim NextKey.getOffset() - TopKey.getOffset() < Length) { 852239462Sdim // Case 1: The next binding is inside the region we're invalidating. 853249423Sdim // Include it. 854249423Sdim Bindings.push_back(*I); 855243830Sdim 856249423Sdim } else if (NextKey.getOffset() == TopKey.getOffset()) { 857239462Sdim // Case 2: The next binding is at the same offset as the region we're 858239462Sdim // invalidating. In this case, we need to leave default bindings alone, 859239462Sdim // since they may be providing a default value for a regions beyond what 860239462Sdim // we're invalidating. 861239462Sdim // FIXME: This is probably incorrect; consider invalidating an outer 862239462Sdim // struct whose first field is bound to a LazyCompoundVal. 863249423Sdim if (IncludeAllDefaultBindings || NextKey.isDirect()) 864249423Sdim Bindings.push_back(*I); 865239462Sdim } 866249423Sdim 867239462Sdim } else if (NextKey.hasSymbolicOffset()) { 868239462Sdim const MemRegion *Base = NextKey.getConcreteOffsetRegion(); 869249423Sdim if (Top->isSubRegionOf(Base)) { 870239462Sdim // Case 3: The next key is symbolic and we just changed something within 871239462Sdim // its concrete region. We don't know if the binding is still valid, so 872249423Sdim // we'll be conservative and include it. 873249423Sdim if (IncludeAllDefaultBindings || NextKey.isDirect()) 874243830Sdim if (isCompatibleWithFields(NextKey, FieldsInSymbolicSubregions)) 875249423Sdim Bindings.push_back(*I); 876239462Sdim } else if (const SubRegion *BaseSR = dyn_cast<SubRegion>(Base)) { 877239462Sdim // Case 4: The next key is symbolic, but we changed a known 878249423Sdim // super-region. In this case the binding is certainly included. 879249423Sdim if (Top == Base || BaseSR->isSubRegionOf(Top)) 880243830Sdim if (isCompatibleWithFields(NextKey, FieldsInSymbolicSubregions)) 881249423Sdim Bindings.push_back(*I); 882239462Sdim } 883239462Sdim } 884239462Sdim } 885249423Sdim} 886239462Sdim 887249423Sdimstatic void 888249423SdimcollectSubRegionBindings(SmallVectorImpl<BindingPair> &Bindings, 889249423Sdim SValBuilder &SVB, const ClusterBindings &Cluster, 890249423Sdim const SubRegion *Top, bool IncludeAllDefaultBindings) { 891249423Sdim collectSubRegionBindings(Bindings, SVB, Cluster, Top, 892249423Sdim BindingKey::Make(Top, BindingKey::Default), 893249423Sdim IncludeAllDefaultBindings); 894249423Sdim} 895249423Sdim 896249423SdimRegionBindingsRef 897249423SdimRegionStoreManager::removeSubRegionBindings(RegionBindingsConstRef B, 898249423Sdim const SubRegion *Top) { 899249423Sdim BindingKey TopKey = BindingKey::Make(Top, BindingKey::Default); 900249423Sdim const MemRegion *ClusterHead = TopKey.getBaseRegion(); 901249423Sdim 902249423Sdim if (Top == ClusterHead) { 903249423Sdim // We can remove an entire cluster's bindings all in one go. 904249423Sdim return B.remove(Top); 905249423Sdim } 906249423Sdim 907249423Sdim const ClusterBindings *Cluster = B.lookup(ClusterHead); 908249423Sdim if (!Cluster) { 909249423Sdim // If we're invalidating a region with a symbolic offset, we need to make 910249423Sdim // sure we don't treat the base region as uninitialized anymore. 911249423Sdim if (TopKey.hasSymbolicOffset()) { 912249423Sdim const SubRegion *Concrete = TopKey.getConcreteOffsetRegion(); 913249423Sdim return B.addBinding(Concrete, BindingKey::Default, UnknownVal()); 914249423Sdim } 915249423Sdim return B; 916249423Sdim } 917249423Sdim 918249423Sdim SmallVector<BindingPair, 32> Bindings; 919249423Sdim collectSubRegionBindings(Bindings, svalBuilder, *Cluster, Top, TopKey, 920249423Sdim /*IncludeAllDefaultBindings=*/false); 921249423Sdim 922249423Sdim ClusterBindingsRef Result(*Cluster, CBFactory); 923249423Sdim for (SmallVectorImpl<BindingPair>::const_iterator I = Bindings.begin(), 924249423Sdim E = Bindings.end(); 925249423Sdim I != E; ++I) 926249423Sdim Result = Result.remove(I->first); 927249423Sdim 928243830Sdim // If we're invalidating a region with a symbolic offset, we need to make sure 929243830Sdim // we don't treat the base region as uninitialized anymore. 930249423Sdim // FIXME: This isn't very precise; see the example in 931249423Sdim // collectSubRegionBindings. 932249423Sdim if (TopKey.hasSymbolicOffset()) { 933249423Sdim const SubRegion *Concrete = TopKey.getConcreteOffsetRegion(); 934249423Sdim Result = Result.add(BindingKey::Make(Concrete, BindingKey::Default), 935249423Sdim UnknownVal()); 936249423Sdim } 937243830Sdim 938239462Sdim if (Result.isEmpty()) 939249423Sdim return B.remove(ClusterHead); 940249423Sdim return B.add(ClusterHead, Result.asImmutableMap()); 941239462Sdim} 942239462Sdim 943218887Sdimnamespace { 944218887Sdimclass invalidateRegionsWorker : public ClusterAnalysis<invalidateRegionsWorker> 945218887Sdim{ 946218887Sdim const Expr *Ex; 947218887Sdim unsigned Count; 948234353Sdim const LocationContext *LCtx; 949249423Sdim InvalidatedSymbols &IS; 950263508Sdim RegionAndSymbolInvalidationTraits &ITraits; 951218887Sdim StoreManager::InvalidatedRegions *Regions; 952218887Sdimpublic: 953218887Sdim invalidateRegionsWorker(RegionStoreManager &rm, 954226633Sdim ProgramStateManager &stateMgr, 955249423Sdim RegionBindingsRef b, 956218887Sdim const Expr *ex, unsigned count, 957234353Sdim const LocationContext *lctx, 958249423Sdim InvalidatedSymbols &is, 959263508Sdim RegionAndSymbolInvalidationTraits &ITraitsIn, 960218887Sdim StoreManager::InvalidatedRegions *r, 961251662Sdim GlobalsFilterKind GFK) 962251662Sdim : ClusterAnalysis<invalidateRegionsWorker>(rm, stateMgr, b, GFK), 963263508Sdim Ex(ex), Count(count), LCtx(lctx), IS(is), ITraits(ITraitsIn), Regions(r){} 964218887Sdim 965263508Sdim void VisitCluster(const MemRegion *baseR, const ClusterBindings *C); 966218887Sdim void VisitBinding(SVal V); 967218887Sdim}; 968218887Sdim} 969218887Sdim 970218887Sdimvoid invalidateRegionsWorker::VisitBinding(SVal V) { 971218887Sdim // A symbol? Mark it touched by the invalidation. 972223017Sdim if (SymbolRef Sym = V.getAsSymbol()) 973223017Sdim IS.insert(Sym); 974218887Sdim 975218887Sdim if (const MemRegion *R = V.getAsRegion()) { 976218887Sdim AddToWorkList(R); 977218887Sdim return; 978218887Sdim } 979218887Sdim 980218887Sdim // Is it a LazyCompoundVal? All references get invalidated as well. 981249423Sdim if (Optional<nonloc::LazyCompoundVal> LCS = 982249423Sdim V.getAs<nonloc::LazyCompoundVal>()) { 983218887Sdim 984249423Sdim const RegionStoreManager::SValListTy &Vals = RM.getInterestingValues(*LCS); 985218887Sdim 986249423Sdim for (RegionStoreManager::SValListTy::const_iterator I = Vals.begin(), 987249423Sdim E = Vals.end(); 988249423Sdim I != E; ++I) 989249423Sdim VisitBinding(*I); 990218887Sdim 991218887Sdim return; 992218887Sdim } 993218887Sdim} 994218887Sdim 995249423Sdimvoid invalidateRegionsWorker::VisitCluster(const MemRegion *baseR, 996263508Sdim const ClusterBindings *C) { 997263508Sdim 998263508Sdim bool PreserveRegionsContents = 999263508Sdim ITraits.hasTrait(baseR, 1000263508Sdim RegionAndSymbolInvalidationTraits::TK_PreserveContents); 1001263508Sdim 1002249423Sdim if (C) { 1003249423Sdim for (ClusterBindings::iterator I = C->begin(), E = C->end(); I != E; ++I) 1004249423Sdim VisitBinding(I.getData()); 1005218887Sdim 1006263508Sdim // Invalidate regions contents. 1007263508Sdim if (!PreserveRegionsContents) 1008249423Sdim B = B.remove(baseR); 1009249423Sdim } 1010218887Sdim 1011218887Sdim // BlockDataRegion? If so, invalidate captured variables that are passed 1012218887Sdim // by reference. 1013218887Sdim if (const BlockDataRegion *BR = dyn_cast<BlockDataRegion>(baseR)) { 1014218887Sdim for (BlockDataRegion::referenced_vars_iterator 1015218887Sdim BI = BR->referenced_vars_begin(), BE = BR->referenced_vars_end() ; 1016218887Sdim BI != BE; ++BI) { 1017249423Sdim const VarRegion *VR = BI.getCapturedRegion(); 1018218887Sdim const VarDecl *VD = VR->getDecl(); 1019239462Sdim if (VD->getAttr<BlocksAttr>() || !VD->hasLocalStorage()) { 1020218887Sdim AddToWorkList(VR); 1021239462Sdim } 1022239462Sdim else if (Loc::isLocType(VR->getValueType())) { 1023239462Sdim // Map the current bindings to a Store to retrieve the value 1024239462Sdim // of the binding. If that binding itself is a region, we should 1025239462Sdim // invalidate that region. This is because a block may capture 1026239462Sdim // a pointer value, but the thing pointed by that pointer may 1027239462Sdim // get invalidated. 1028249423Sdim SVal V = RM.getBinding(B, loc::MemRegionVal(VR)); 1029249423Sdim if (Optional<Loc> L = V.getAs<Loc>()) { 1030239462Sdim if (const MemRegion *LR = L->getAsRegion()) 1031239462Sdim AddToWorkList(LR); 1032239462Sdim } 1033239462Sdim } 1034218887Sdim } 1035218887Sdim return; 1036218887Sdim } 1037218887Sdim 1038249423Sdim // Symbolic region? 1039263508Sdim if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(baseR)) 1040263508Sdim IS.insert(SR->getSymbol()); 1041249423Sdim 1042263508Sdim // Nothing else should be done in the case when we preserve regions context. 1043263508Sdim if (PreserveRegionsContents) 1044251662Sdim return; 1045251662Sdim 1046218887Sdim // Otherwise, we have a normal data region. Record that we touched the region. 1047218887Sdim if (Regions) 1048218887Sdim Regions->push_back(baseR); 1049218887Sdim 1050218887Sdim if (isa<AllocaRegion>(baseR) || isa<SymbolicRegion>(baseR)) { 1051218887Sdim // Invalidate the region by setting its default value to 1052263508Sdim // conjured symbol. The type of the symbol is irrelevant. 1053218887Sdim DefinedOrUnknownSVal V = 1054243830Sdim svalBuilder.conjureSymbolVal(baseR, Ex, LCtx, Ctx.IntTy, Count); 1055249423Sdim B = B.addBinding(baseR, BindingKey::Default, V); 1056218887Sdim return; 1057218887Sdim } 1058218887Sdim 1059218887Sdim if (!baseR->isBoundable()) 1060218887Sdim return; 1061218887Sdim 1062226633Sdim const TypedValueRegion *TR = cast<TypedValueRegion>(baseR); 1063218887Sdim QualType T = TR->getValueType(); 1064218887Sdim 1065251662Sdim if (isInitiallyIncludedGlobalRegion(baseR)) { 1066251662Sdim // If the region is a global and we are invalidating all globals, 1067251662Sdim // erasing the entry is good enough. This causes all globals to be lazily 1068251662Sdim // symbolicated from the same base symbol. 1069251662Sdim return; 1070251662Sdim } 1071251662Sdim 1072221345Sdim if (T->isStructureOrClassType()) { 1073218887Sdim // Invalidate the region by setting its default value to 1074263508Sdim // conjured symbol. The type of the symbol is irrelevant. 1075243830Sdim DefinedOrUnknownSVal V = svalBuilder.conjureSymbolVal(baseR, Ex, LCtx, 1076243830Sdim Ctx.IntTy, Count); 1077249423Sdim B = B.addBinding(baseR, BindingKey::Default, V); 1078218887Sdim return; 1079218887Sdim } 1080218887Sdim 1081218887Sdim if (const ArrayType *AT = Ctx.getAsArrayType(T)) { 1082218887Sdim // Set the default value of the array to conjured symbol. 1083218887Sdim DefinedOrUnknownSVal V = 1084243830Sdim svalBuilder.conjureSymbolVal(baseR, Ex, LCtx, 1085234353Sdim AT->getElementType(), Count); 1086249423Sdim B = B.addBinding(baseR, BindingKey::Default, V); 1087218887Sdim return; 1088218887Sdim } 1089218887Sdim 1090243830Sdim DefinedOrUnknownSVal V = svalBuilder.conjureSymbolVal(baseR, Ex, LCtx, 1091243830Sdim T,Count); 1092218887Sdim assert(SymbolManager::canSymbolicate(T) || V.isUnknown()); 1093249423Sdim B = B.addBinding(baseR, BindingKey::Direct, V); 1094218887Sdim} 1095218887Sdim 1096249423SdimRegionBindingsRef 1097249423SdimRegionStoreManager::invalidateGlobalRegion(MemRegion::Kind K, 1098249423Sdim const Expr *Ex, 1099249423Sdim unsigned Count, 1100249423Sdim const LocationContext *LCtx, 1101249423Sdim RegionBindingsRef B, 1102249423Sdim InvalidatedRegions *Invalidated) { 1103234353Sdim // Bind the globals memory space to a new symbol that we will use to derive 1104234353Sdim // the bindings for all globals. 1105234353Sdim const GlobalsSpaceRegion *GS = MRMgr.getGlobalsRegion(K); 1106243830Sdim SVal V = svalBuilder.conjureSymbolVal(/* SymbolTag = */ (const void*) GS, Ex, LCtx, 1107243830Sdim /* type does not matter */ Ctx.IntTy, 1108243830Sdim Count); 1109234353Sdim 1110249423Sdim B = B.removeBinding(GS) 1111249423Sdim .addBinding(BindingKey::Make(GS, BindingKey::Default), V); 1112234353Sdim 1113234353Sdim // Even if there are no bindings in the global scope, we still need to 1114234353Sdim // record that we touched it. 1115234353Sdim if (Invalidated) 1116234353Sdim Invalidated->push_back(GS); 1117234353Sdim 1118234353Sdim return B; 1119234353Sdim} 1120234353Sdim 1121249423Sdimvoid RegionStoreManager::populateWorkList(invalidateRegionsWorker &W, 1122249423Sdim ArrayRef<SVal> Values, 1123249423Sdim InvalidatedRegions *TopLevelRegions) { 1124249423Sdim for (ArrayRef<SVal>::iterator I = Values.begin(), 1125249423Sdim E = Values.end(); I != E; ++I) { 1126249423Sdim SVal V = *I; 1127249423Sdim if (Optional<nonloc::LazyCompoundVal> LCS = 1128249423Sdim V.getAs<nonloc::LazyCompoundVal>()) { 1129218887Sdim 1130249423Sdim const SValListTy &Vals = getInterestingValues(*LCS); 1131249423Sdim 1132249423Sdim for (SValListTy::const_iterator I = Vals.begin(), 1133249423Sdim E = Vals.end(); I != E; ++I) { 1134249423Sdim // Note: the last argument is false here because these are 1135249423Sdim // non-top-level regions. 1136249423Sdim if (const MemRegion *R = (*I).getAsRegion()) 1137263508Sdim W.AddToWorkList(R); 1138249423Sdim } 1139249423Sdim continue; 1140249423Sdim } 1141249423Sdim 1142249423Sdim if (const MemRegion *R = V.getAsRegion()) { 1143249423Sdim if (TopLevelRegions) 1144249423Sdim TopLevelRegions->push_back(R); 1145263508Sdim W.AddToWorkList(R); 1146249423Sdim continue; 1147249423Sdim } 1148249423Sdim } 1149249423Sdim} 1150249423Sdim 1151249423SdimStoreRef 1152249423SdimRegionStoreManager::invalidateRegions(Store store, 1153263508Sdim ArrayRef<SVal> Values, 1154263508Sdim const Expr *Ex, unsigned Count, 1155263508Sdim const LocationContext *LCtx, 1156263508Sdim const CallEvent *Call, 1157263508Sdim InvalidatedSymbols &IS, 1158263508Sdim RegionAndSymbolInvalidationTraits &ITraits, 1159263508Sdim InvalidatedRegions *TopLevelRegions, 1160263508Sdim InvalidatedRegions *Invalidated) { 1161251662Sdim GlobalsFilterKind GlobalsFilter; 1162251662Sdim if (Call) { 1163251662Sdim if (Call->isInSystemHeader()) 1164251662Sdim GlobalsFilter = GFK_SystemOnly; 1165251662Sdim else 1166251662Sdim GlobalsFilter = GFK_All; 1167251662Sdim } else { 1168251662Sdim GlobalsFilter = GFK_None; 1169251662Sdim } 1170251662Sdim 1171251662Sdim RegionBindingsRef B = getRegionBindings(store); 1172263508Sdim invalidateRegionsWorker W(*this, StateMgr, B, Ex, Count, LCtx, IS, ITraits, 1173251662Sdim Invalidated, GlobalsFilter); 1174249423Sdim 1175218887Sdim // Scan the bindings and generate the clusters. 1176218887Sdim W.GenerateClusters(); 1177218887Sdim 1178226633Sdim // Add the regions to the worklist. 1179263508Sdim populateWorkList(W, Values, TopLevelRegions); 1180218887Sdim 1181218887Sdim W.RunWorkList(); 1182218887Sdim 1183218887Sdim // Return the new bindings. 1184249423Sdim B = W.getRegionBindings(); 1185218887Sdim 1186249423Sdim // For calls, determine which global regions should be invalidated and 1187249423Sdim // invalidate them. (Note that function-static and immutable globals are never 1188249423Sdim // invalidated by this.) 1189234353Sdim // TODO: This could possibly be more precise with modules. 1190251662Sdim switch (GlobalsFilter) { 1191251662Sdim case GFK_All: 1192251662Sdim B = invalidateGlobalRegion(MemRegion::GlobalInternalSpaceRegionKind, 1193251662Sdim Ex, Count, LCtx, B, Invalidated); 1194251662Sdim // FALLTHROUGH 1195251662Sdim case GFK_SystemOnly: 1196234353Sdim B = invalidateGlobalRegion(MemRegion::GlobalSystemSpaceRegionKind, 1197234353Sdim Ex, Count, LCtx, B, Invalidated); 1198251662Sdim // FALLTHROUGH 1199251662Sdim case GFK_None: 1200251662Sdim break; 1201218887Sdim } 1202218887Sdim 1203249423Sdim return StoreRef(B.asStore(), *this); 1204218887Sdim} 1205218887Sdim 1206218887Sdim//===----------------------------------------------------------------------===// 1207218887Sdim// Extents for regions. 1208218887Sdim//===----------------------------------------------------------------------===// 1209218887Sdim 1210234353SdimDefinedOrUnknownSVal 1211234353SdimRegionStoreManager::getSizeInElements(ProgramStateRef state, 1212234353Sdim const MemRegion *R, 1213234353Sdim QualType EleTy) { 1214218887Sdim SVal Size = cast<SubRegion>(R)->getExtent(svalBuilder); 1215218887Sdim const llvm::APSInt *SizeInt = svalBuilder.getKnownValue(state, Size); 1216218887Sdim if (!SizeInt) 1217218887Sdim return UnknownVal(); 1218218887Sdim 1219218887Sdim CharUnits RegionSize = CharUnits::fromQuantity(SizeInt->getSExtValue()); 1220218887Sdim 1221218887Sdim if (Ctx.getAsVariableArrayType(EleTy)) { 1222218887Sdim // FIXME: We need to track extra state to properly record the size 1223218887Sdim // of VLAs. Returning UnknownVal here, however, is a stop-gap so that 1224218887Sdim // we don't have a divide-by-zero below. 1225218887Sdim return UnknownVal(); 1226218887Sdim } 1227218887Sdim 1228218887Sdim CharUnits EleSize = Ctx.getTypeSizeInChars(EleTy); 1229218887Sdim 1230218887Sdim // If a variable is reinterpreted as a type that doesn't fit into a larger 1231218887Sdim // type evenly, round it down. 1232218887Sdim // This is a signed value, since it's used in arithmetic with signed indices. 1233218887Sdim return svalBuilder.makeIntVal(RegionSize / EleSize, false); 1234218887Sdim} 1235218887Sdim 1236218887Sdim//===----------------------------------------------------------------------===// 1237218887Sdim// Location and region casting. 1238218887Sdim//===----------------------------------------------------------------------===// 1239218887Sdim 1240218887Sdim/// ArrayToPointer - Emulates the "decay" of an array to a pointer 1241218887Sdim/// type. 'Array' represents the lvalue of the array being decayed 1242218887Sdim/// to a pointer, and the returned SVal represents the decayed 1243218887Sdim/// version of that lvalue (i.e., a pointer to the first element of 1244218887Sdim/// the array). This is called by ExprEngine when evaluating casts 1245218887Sdim/// from arrays to pointers. 1246263508SdimSVal RegionStoreManager::ArrayToPointer(Loc Array, QualType T) { 1247249423Sdim if (!Array.getAs<loc::MemRegionVal>()) 1248218887Sdim return UnknownVal(); 1249218887Sdim 1250249423Sdim const MemRegion* R = Array.castAs<loc::MemRegionVal>().getRegion(); 1251218887Sdim NonLoc ZeroIdx = svalBuilder.makeZeroArrayIndex(); 1252263508Sdim return loc::MemRegionVal(MRMgr.getElementRegion(T, ZeroIdx, R, Ctx)); 1253218887Sdim} 1254218887Sdim 1255218887Sdim//===----------------------------------------------------------------------===// 1256218887Sdim// Loading values from regions. 1257218887Sdim//===----------------------------------------------------------------------===// 1258218887Sdim 1259249423SdimSVal RegionStoreManager::getBinding(RegionBindingsConstRef B, Loc L, QualType T) { 1260249423Sdim assert(!L.getAs<UnknownVal>() && "location unknown"); 1261249423Sdim assert(!L.getAs<UndefinedVal>() && "location undefined"); 1262218887Sdim 1263218887Sdim // For access to concrete addresses, return UnknownVal. Checks 1264218887Sdim // for null dereferences (and similar errors) are done by checkers, not 1265218887Sdim // the Store. 1266218887Sdim // FIXME: We can consider lazily symbolicating such memory, but we really 1267218887Sdim // should defer this when we can reason easily about symbolicating arrays 1268218887Sdim // of bytes. 1269249423Sdim if (L.getAs<loc::ConcreteInt>()) { 1270218887Sdim return UnknownVal(); 1271218887Sdim } 1272249423Sdim if (!L.getAs<loc::MemRegionVal>()) { 1273218887Sdim return UnknownVal(); 1274218887Sdim } 1275218887Sdim 1276249423Sdim const MemRegion *MR = L.castAs<loc::MemRegionVal>().getRegion(); 1277218887Sdim 1278234353Sdim if (isa<AllocaRegion>(MR) || 1279234353Sdim isa<SymbolicRegion>(MR) || 1280234353Sdim isa<CodeTextRegion>(MR)) { 1281218887Sdim if (T.isNull()) { 1282234353Sdim if (const TypedRegion *TR = dyn_cast<TypedRegion>(MR)) 1283234353Sdim T = TR->getLocationType(); 1284234353Sdim else { 1285234353Sdim const SymbolicRegion *SR = cast<SymbolicRegion>(MR); 1286243830Sdim T = SR->getSymbol()->getType(); 1287234353Sdim } 1288218887Sdim } 1289218887Sdim MR = GetElementZeroRegion(MR, T); 1290218887Sdim } 1291218887Sdim 1292218887Sdim // FIXME: Perhaps this method should just take a 'const MemRegion*' argument 1293218887Sdim // instead of 'Loc', and have the other Loc cases handled at a higher level. 1294226633Sdim const TypedValueRegion *R = cast<TypedValueRegion>(MR); 1295218887Sdim QualType RTy = R->getValueType(); 1296218887Sdim 1297249423Sdim // FIXME: we do not yet model the parts of a complex type, so treat the 1298249423Sdim // whole thing as "unknown". 1299249423Sdim if (RTy->isAnyComplexType()) 1300249423Sdim return UnknownVal(); 1301249423Sdim 1302218887Sdim // FIXME: We should eventually handle funny addressing. e.g.: 1303218887Sdim // 1304218887Sdim // int x = ...; 1305218887Sdim // int *p = &x; 1306218887Sdim // char *q = (char*) p; 1307218887Sdim // char c = *q; // returns the first byte of 'x'. 1308218887Sdim // 1309218887Sdim // Such funny addressing will occur due to layering of regions. 1310218887Sdim if (RTy->isStructureOrClassType()) 1311249423Sdim return getBindingForStruct(B, R); 1312218887Sdim 1313218887Sdim // FIXME: Handle unions. 1314218887Sdim if (RTy->isUnionType()) 1315263508Sdim return createLazyBinding(B, R); 1316218887Sdim 1317239462Sdim if (RTy->isArrayType()) { 1318239462Sdim if (RTy->isConstantArrayType()) 1319249423Sdim return getBindingForArray(B, R); 1320239462Sdim else 1321239462Sdim return UnknownVal(); 1322239462Sdim } 1323218887Sdim 1324218887Sdim // FIXME: handle Vector types. 1325218887Sdim if (RTy->isVectorType()) 1326218887Sdim return UnknownVal(); 1327218887Sdim 1328218887Sdim if (const FieldRegion* FR = dyn_cast<FieldRegion>(R)) 1329249423Sdim return CastRetrievedVal(getBindingForField(B, FR), FR, T, false); 1330218887Sdim 1331218887Sdim if (const ElementRegion* ER = dyn_cast<ElementRegion>(R)) { 1332218887Sdim // FIXME: Here we actually perform an implicit conversion from the loaded 1333218887Sdim // value to the element type. Eventually we want to compose these values 1334218887Sdim // more intelligently. For example, an 'element' can encompass multiple 1335218887Sdim // bound regions (e.g., several bound bytes), or could be a subset of 1336218887Sdim // a larger value. 1337249423Sdim return CastRetrievedVal(getBindingForElement(B, ER), ER, T, false); 1338218887Sdim } 1339218887Sdim 1340218887Sdim if (const ObjCIvarRegion *IVR = dyn_cast<ObjCIvarRegion>(R)) { 1341218887Sdim // FIXME: Here we actually perform an implicit conversion from the loaded 1342218887Sdim // value to the ivar type. What we should model is stores to ivars 1343218887Sdim // that blow past the extent of the ivar. If the address of the ivar is 1344218887Sdim // reinterpretted, it is possible we stored a different value that could 1345218887Sdim // fit within the ivar. Either we need to cast these when storing them 1346218887Sdim // or reinterpret them lazily (as we do here). 1347249423Sdim return CastRetrievedVal(getBindingForObjCIvar(B, IVR), IVR, T, false); 1348218887Sdim } 1349218887Sdim 1350218887Sdim if (const VarRegion *VR = dyn_cast<VarRegion>(R)) { 1351218887Sdim // FIXME: Here we actually perform an implicit conversion from the loaded 1352218887Sdim // value to the variable type. What we should model is stores to variables 1353218887Sdim // that blow past the extent of the variable. If the address of the 1354218887Sdim // variable is reinterpretted, it is possible we stored a different value 1355218887Sdim // that could fit within the variable. Either we need to cast these when 1356218887Sdim // storing them or reinterpret them lazily (as we do here). 1357249423Sdim return CastRetrievedVal(getBindingForVar(B, VR), VR, T, false); 1358218887Sdim } 1359218887Sdim 1360249423Sdim const SVal *V = B.lookup(R, BindingKey::Direct); 1361218887Sdim 1362218887Sdim // Check if the region has a binding. 1363218887Sdim if (V) 1364218887Sdim return *V; 1365218887Sdim 1366218887Sdim // The location does not have a bound value. This means that it has 1367218887Sdim // the value it had upon its creation and/or entry to the analyzed 1368218887Sdim // function/method. These are either symbolic values or 'undefined'. 1369218887Sdim if (R->hasStackNonParametersStorage()) { 1370218887Sdim // All stack variables are considered to have undefined values 1371218887Sdim // upon creation. All heap allocated blocks are considered to 1372218887Sdim // have undefined values as well unless they are explicitly bound 1373218887Sdim // to specific values. 1374218887Sdim return UndefinedVal(); 1375218887Sdim } 1376218887Sdim 1377218887Sdim // All other values are symbolic. 1378218887Sdim return svalBuilder.getRegionValueSymbolVal(R); 1379218887Sdim} 1380218887Sdim 1381249423Sdimstatic QualType getUnderlyingType(const SubRegion *R) { 1382249423Sdim QualType RegionTy; 1383249423Sdim if (const TypedValueRegion *TVR = dyn_cast<TypedValueRegion>(R)) 1384249423Sdim RegionTy = TVR->getValueType(); 1385249423Sdim 1386249423Sdim if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(R)) 1387249423Sdim RegionTy = SR->getSymbol()->getType(); 1388249423Sdim 1389249423Sdim return RegionTy; 1390249423Sdim} 1391249423Sdim 1392249423Sdim/// Checks to see if store \p B has a lazy binding for region \p R. 1393249423Sdim/// 1394249423Sdim/// If \p AllowSubregionBindings is \c false, a lazy binding will be rejected 1395249423Sdim/// if there are additional bindings within \p R. 1396249423Sdim/// 1397249423Sdim/// Note that unlike RegionStoreManager::findLazyBinding, this will not search 1398249423Sdim/// for lazy bindings for super-regions of \p R. 1399249423Sdimstatic Optional<nonloc::LazyCompoundVal> 1400249423SdimgetExistingLazyBinding(SValBuilder &SVB, RegionBindingsConstRef B, 1401249423Sdim const SubRegion *R, bool AllowSubregionBindings) { 1402249423Sdim Optional<SVal> V = B.getDefaultBinding(R); 1403249423Sdim if (!V) 1404249423Sdim return None; 1405249423Sdim 1406249423Sdim Optional<nonloc::LazyCompoundVal> LCV = V->getAs<nonloc::LazyCompoundVal>(); 1407249423Sdim if (!LCV) 1408249423Sdim return None; 1409249423Sdim 1410249423Sdim // If the LCV is for a subregion, the types might not match, and we shouldn't 1411249423Sdim // reuse the binding. 1412249423Sdim QualType RegionTy = getUnderlyingType(R); 1413249423Sdim if (!RegionTy.isNull() && 1414249423Sdim !RegionTy->isVoidPointerType()) { 1415249423Sdim QualType SourceRegionTy = LCV->getRegion()->getValueType(); 1416249423Sdim if (!SVB.getContext().hasSameUnqualifiedType(RegionTy, SourceRegionTy)) 1417249423Sdim return None; 1418249423Sdim } 1419249423Sdim 1420249423Sdim if (!AllowSubregionBindings) { 1421249423Sdim // If there are any other bindings within this region, we shouldn't reuse 1422249423Sdim // the top-level binding. 1423249423Sdim SmallVector<BindingPair, 16> Bindings; 1424249423Sdim collectSubRegionBindings(Bindings, SVB, *B.lookup(R->getBaseRegion()), R, 1425249423Sdim /*IncludeAllDefaultBindings=*/true); 1426249423Sdim if (Bindings.size() > 1) 1427249423Sdim return None; 1428249423Sdim } 1429249423Sdim 1430249423Sdim return *LCV; 1431249423Sdim} 1432249423Sdim 1433249423Sdim 1434249423Sdimstd::pair<Store, const SubRegion *> 1435249423SdimRegionStoreManager::findLazyBinding(RegionBindingsConstRef B, 1436249423Sdim const SubRegion *R, 1437249423Sdim const SubRegion *originalRegion) { 1438221345Sdim if (originalRegion != R) { 1439249423Sdim if (Optional<nonloc::LazyCompoundVal> V = 1440249423Sdim getExistingLazyBinding(svalBuilder, B, R, true)) 1441249423Sdim return std::make_pair(V->getStore(), V->getRegion()); 1442221345Sdim } 1443249423Sdim 1444249423Sdim typedef std::pair<Store, const SubRegion *> StoreRegionPair; 1445249423Sdim StoreRegionPair Result = StoreRegionPair(); 1446249423Sdim 1447218887Sdim if (const ElementRegion *ER = dyn_cast<ElementRegion>(R)) { 1448249423Sdim Result = findLazyBinding(B, cast<SubRegion>(ER->getSuperRegion()), 1449249423Sdim originalRegion); 1450218887Sdim 1451249423Sdim if (Result.second) 1452249423Sdim Result.second = MRMgr.getElementRegionWithSuper(ER, Result.second); 1453218887Sdim 1454249423Sdim } else if (const FieldRegion *FR = dyn_cast<FieldRegion>(R)) { 1455249423Sdim Result = findLazyBinding(B, cast<SubRegion>(FR->getSuperRegion()), 1456249423Sdim originalRegion); 1457249423Sdim 1458249423Sdim if (Result.second) 1459249423Sdim Result.second = MRMgr.getFieldRegionWithSuper(FR, Result.second); 1460249423Sdim 1461249423Sdim } else if (const CXXBaseObjectRegion *BaseReg = 1462249423Sdim dyn_cast<CXXBaseObjectRegion>(R)) { 1463249423Sdim // C++ base object region is another kind of region that we should blast 1464249423Sdim // through to look for lazy compound value. It is like a field region. 1465249423Sdim Result = findLazyBinding(B, cast<SubRegion>(BaseReg->getSuperRegion()), 1466249423Sdim originalRegion); 1467218887Sdim 1468249423Sdim if (Result.second) 1469249423Sdim Result.second = MRMgr.getCXXBaseObjectRegionWithSuper(BaseReg, 1470249423Sdim Result.second); 1471218887Sdim } 1472221345Sdim 1473249423Sdim return Result; 1474218887Sdim} 1475218887Sdim 1476249423SdimSVal RegionStoreManager::getBindingForElement(RegionBindingsConstRef B, 1477239462Sdim const ElementRegion* R) { 1478239462Sdim // We do not currently model bindings of the CompoundLiteralregion. 1479239462Sdim if (isa<CompoundLiteralRegion>(R->getBaseRegion())) 1480239462Sdim return UnknownVal(); 1481239462Sdim 1482218887Sdim // Check if the region has a binding. 1483249423Sdim if (const Optional<SVal> &V = B.getDirectBinding(R)) 1484218887Sdim return *V; 1485218887Sdim 1486218887Sdim const MemRegion* superR = R->getSuperRegion(); 1487218887Sdim 1488218887Sdim // Check if the region is an element region of a string literal. 1489218887Sdim if (const StringRegion *StrR=dyn_cast<StringRegion>(superR)) { 1490218887Sdim // FIXME: Handle loads from strings where the literal is treated as 1491218887Sdim // an integer, e.g., *((unsigned int*)"hello") 1492218887Sdim QualType T = Ctx.getAsArrayType(StrR->getValueType())->getElementType(); 1493263508Sdim if (!Ctx.hasSameUnqualifiedType(T, R->getElementType())) 1494218887Sdim return UnknownVal(); 1495218887Sdim 1496218887Sdim const StringLiteral *Str = StrR->getStringLiteral(); 1497218887Sdim SVal Idx = R->getIndex(); 1498249423Sdim if (Optional<nonloc::ConcreteInt> CI = Idx.getAs<nonloc::ConcreteInt>()) { 1499218887Sdim int64_t i = CI->getValue().getSExtValue(); 1500226633Sdim // Abort on string underrun. This can be possible by arbitrary 1501234353Sdim // clients of getBindingForElement(). 1502226633Sdim if (i < 0) 1503226633Sdim return UndefinedVal(); 1504234353Sdim int64_t length = Str->getLength(); 1505234353Sdim // Technically, only i == length is guaranteed to be null. 1506218887Sdim // However, such overflows should be caught before reaching this point; 1507218887Sdim // the only time such an access would be made is if a string literal was 1508218887Sdim // used to initialize a larger array. 1509234353Sdim char c = (i >= length) ? '\0' : Str->getCodeUnit(i); 1510218887Sdim return svalBuilder.makeIntVal(c, T); 1511218887Sdim } 1512218887Sdim } 1513218887Sdim 1514218887Sdim // Check for loads from a code text region. For such loads, just give up. 1515218887Sdim if (isa<CodeTextRegion>(superR)) 1516218887Sdim return UnknownVal(); 1517218887Sdim 1518218887Sdim // Handle the case where we are indexing into a larger scalar object. 1519218887Sdim // For example, this handles: 1520218887Sdim // int x = ... 1521218887Sdim // char *y = &x; 1522218887Sdim // return *y; 1523218887Sdim // FIXME: This is a hack, and doesn't do anything really intelligent yet. 1524218887Sdim const RegionRawOffset &O = R->getAsArrayOffset(); 1525223017Sdim 1526223017Sdim // If we cannot reason about the offset, return an unknown value. 1527223017Sdim if (!O.getRegion()) 1528223017Sdim return UnknownVal(); 1529223017Sdim 1530226633Sdim if (const TypedValueRegion *baseR = 1531226633Sdim dyn_cast_or_null<TypedValueRegion>(O.getRegion())) { 1532218887Sdim QualType baseT = baseR->getValueType(); 1533218887Sdim if (baseT->isScalarType()) { 1534218887Sdim QualType elemT = R->getElementType(); 1535218887Sdim if (elemT->isScalarType()) { 1536218887Sdim if (Ctx.getTypeSizeInChars(baseT) >= Ctx.getTypeSizeInChars(elemT)) { 1537249423Sdim if (const Optional<SVal> &V = B.getDirectBinding(superR)) { 1538218887Sdim if (SymbolRef parentSym = V->getAsSymbol()) 1539218887Sdim return svalBuilder.getDerivedRegionValueSymbolVal(parentSym, R); 1540218887Sdim 1541218887Sdim if (V->isUnknownOrUndef()) 1542218887Sdim return *V; 1543218887Sdim // Other cases: give up. We are indexing into a larger object 1544218887Sdim // that has some value, but we don't know how to handle that yet. 1545218887Sdim return UnknownVal(); 1546218887Sdim } 1547218887Sdim } 1548218887Sdim } 1549218887Sdim } 1550218887Sdim } 1551251662Sdim return getBindingForFieldOrElementCommon(B, R, R->getElementType()); 1552218887Sdim} 1553218887Sdim 1554249423SdimSVal RegionStoreManager::getBindingForField(RegionBindingsConstRef B, 1555249423Sdim const FieldRegion* R) { 1556218887Sdim 1557218887Sdim // Check if the region has a binding. 1558249423Sdim if (const Optional<SVal> &V = B.getDirectBinding(R)) 1559218887Sdim return *V; 1560218887Sdim 1561218887Sdim QualType Ty = R->getValueType(); 1562251662Sdim return getBindingForFieldOrElementCommon(B, R, Ty); 1563218887Sdim} 1564218887Sdim 1565218887SdimOptional<SVal> 1566249423SdimRegionStoreManager::getBindingForDerivedDefaultValue(RegionBindingsConstRef B, 1567234353Sdim const MemRegion *superR, 1568234353Sdim const TypedValueRegion *R, 1569234353Sdim QualType Ty) { 1570218887Sdim 1571249423Sdim if (const Optional<SVal> &D = B.getDefaultBinding(superR)) { 1572221345Sdim const SVal &val = D.getValue(); 1573221345Sdim if (SymbolRef parentSym = val.getAsSymbol()) 1574218887Sdim return svalBuilder.getDerivedRegionValueSymbolVal(parentSym, R); 1575218887Sdim 1576221345Sdim if (val.isZeroConstant()) 1577218887Sdim return svalBuilder.makeZeroVal(Ty); 1578218887Sdim 1579221345Sdim if (val.isUnknownOrUndef()) 1580221345Sdim return val; 1581218887Sdim 1582249423Sdim // Lazy bindings are usually handled through getExistingLazyBinding(). 1583249423Sdim // We should unify these two code paths at some point. 1584249423Sdim if (val.getAs<nonloc::LazyCompoundVal>()) 1585249423Sdim return val; 1586221345Sdim 1587226633Sdim llvm_unreachable("Unknown default value"); 1588218887Sdim } 1589218887Sdim 1590249423Sdim return None; 1591218887Sdim} 1592218887Sdim 1593249423SdimSVal RegionStoreManager::getLazyBinding(const SubRegion *LazyBindingRegion, 1594249423Sdim RegionBindingsRef LazyBinding) { 1595249423Sdim SVal Result; 1596249423Sdim if (const ElementRegion *ER = dyn_cast<ElementRegion>(LazyBindingRegion)) 1597249423Sdim Result = getBindingForElement(LazyBinding, ER); 1598249423Sdim else 1599249423Sdim Result = getBindingForField(LazyBinding, 1600249423Sdim cast<FieldRegion>(LazyBindingRegion)); 1601249423Sdim 1602249423Sdim // FIXME: This is a hack to deal with RegionStore's inability to distinguish a 1603249423Sdim // default value for /part/ of an aggregate from a default value for the 1604249423Sdim // /entire/ aggregate. The most common case of this is when struct Outer 1605249423Sdim // has as its first member a struct Inner, which is copied in from a stack 1606249423Sdim // variable. In this case, even if the Outer's default value is symbolic, 0, 1607249423Sdim // or unknown, it gets overridden by the Inner's default value of undefined. 1608249423Sdim // 1609249423Sdim // This is a general problem -- if the Inner is zero-initialized, the Outer 1610249423Sdim // will now look zero-initialized. The proper way to solve this is with a 1611249423Sdim // new version of RegionStore that tracks the extent of a binding as well 1612249423Sdim // as the offset. 1613249423Sdim // 1614249423Sdim // This hack only takes care of the undefined case because that can very 1615249423Sdim // quickly result in a warning. 1616249423Sdim if (Result.isUndef()) 1617249423Sdim Result = UnknownVal(); 1618249423Sdim 1619249423Sdim return Result; 1620221345Sdim} 1621221345Sdim 1622249423SdimSVal 1623249423SdimRegionStoreManager::getBindingForFieldOrElementCommon(RegionBindingsConstRef B, 1624226633Sdim const TypedValueRegion *R, 1625251662Sdim QualType Ty) { 1626218887Sdim 1627234353Sdim // At this point we have already checked in either getBindingForElement or 1628234353Sdim // getBindingForField if 'R' has a direct binding. 1629239462Sdim 1630239462Sdim // Lazy binding? 1631239462Sdim Store lazyBindingStore = NULL; 1632249423Sdim const SubRegion *lazyBindingRegion = NULL; 1633249423Sdim llvm::tie(lazyBindingStore, lazyBindingRegion) = findLazyBinding(B, R, R); 1634239462Sdim if (lazyBindingRegion) 1635249423Sdim return getLazyBinding(lazyBindingRegion, 1636249423Sdim getRegionBindings(lazyBindingStore)); 1637239462Sdim 1638234353Sdim // Record whether or not we see a symbolic index. That can completely 1639234353Sdim // be out of scope of our lookup. 1640234353Sdim bool hasSymbolicIndex = false; 1641218887Sdim 1642249423Sdim // FIXME: This is a hack to deal with RegionStore's inability to distinguish a 1643249423Sdim // default value for /part/ of an aggregate from a default value for the 1644249423Sdim // /entire/ aggregate. The most common case of this is when struct Outer 1645249423Sdim // has as its first member a struct Inner, which is copied in from a stack 1646249423Sdim // variable. In this case, even if the Outer's default value is symbolic, 0, 1647249423Sdim // or unknown, it gets overridden by the Inner's default value of undefined. 1648249423Sdim // 1649249423Sdim // This is a general problem -- if the Inner is zero-initialized, the Outer 1650249423Sdim // will now look zero-initialized. The proper way to solve this is with a 1651249423Sdim // new version of RegionStore that tracks the extent of a binding as well 1652249423Sdim // as the offset. 1653249423Sdim // 1654249423Sdim // This hack only takes care of the undefined case because that can very 1655249423Sdim // quickly result in a warning. 1656249423Sdim bool hasPartialLazyBinding = false; 1657249423Sdim 1658251662Sdim const SubRegion *SR = dyn_cast<SubRegion>(R); 1659251662Sdim while (SR) { 1660251662Sdim const MemRegion *Base = SR->getSuperRegion(); 1661249423Sdim if (Optional<SVal> D = getBindingForDerivedDefaultValue(B, Base, R, Ty)) { 1662249423Sdim if (D->getAs<nonloc::LazyCompoundVal>()) { 1663249423Sdim hasPartialLazyBinding = true; 1664249423Sdim break; 1665249423Sdim } 1666249423Sdim 1667218887Sdim return *D; 1668249423Sdim } 1669218887Sdim 1670249423Sdim if (const ElementRegion *ER = dyn_cast<ElementRegion>(Base)) { 1671234353Sdim NonLoc index = ER->getIndex(); 1672234353Sdim if (!index.isConstant()) 1673234353Sdim hasSymbolicIndex = true; 1674234353Sdim } 1675234353Sdim 1676218887Sdim // If our super region is a field or element itself, walk up the region 1677218887Sdim // hierarchy to see if there is a default value installed in an ancestor. 1678251662Sdim SR = dyn_cast<SubRegion>(Base); 1679218887Sdim } 1680218887Sdim 1681218887Sdim if (R->hasStackNonParametersStorage()) { 1682234353Sdim if (isa<ElementRegion>(R)) { 1683218887Sdim // Currently we don't reason specially about Clang-style vectors. Check 1684218887Sdim // if superR is a vector and if so return Unknown. 1685226633Sdim if (const TypedValueRegion *typedSuperR = 1686251662Sdim dyn_cast<TypedValueRegion>(R->getSuperRegion())) { 1687218887Sdim if (typedSuperR->getValueType()->isVectorType()) 1688218887Sdim return UnknownVal(); 1689218887Sdim } 1690218887Sdim } 1691218887Sdim 1692234353Sdim // FIXME: We also need to take ElementRegions with symbolic indexes into 1693234353Sdim // account. This case handles both directly accessing an ElementRegion 1694234353Sdim // with a symbolic offset, but also fields within an element with 1695234353Sdim // a symbolic offset. 1696234353Sdim if (hasSymbolicIndex) 1697234353Sdim return UnknownVal(); 1698249423Sdim 1699249423Sdim if (!hasPartialLazyBinding) 1700249423Sdim return UndefinedVal(); 1701218887Sdim } 1702218887Sdim 1703218887Sdim // All other values are symbolic. 1704218887Sdim return svalBuilder.getRegionValueSymbolVal(R); 1705218887Sdim} 1706218887Sdim 1707249423SdimSVal RegionStoreManager::getBindingForObjCIvar(RegionBindingsConstRef B, 1708234353Sdim const ObjCIvarRegion* R) { 1709249423Sdim // Check if the region has a binding. 1710249423Sdim if (const Optional<SVal> &V = B.getDirectBinding(R)) 1711218887Sdim return *V; 1712218887Sdim 1713218887Sdim const MemRegion *superR = R->getSuperRegion(); 1714218887Sdim 1715218887Sdim // Check if the super region has a default binding. 1716249423Sdim if (const Optional<SVal> &V = B.getDefaultBinding(superR)) { 1717218887Sdim if (SymbolRef parentSym = V->getAsSymbol()) 1718218887Sdim return svalBuilder.getDerivedRegionValueSymbolVal(parentSym, R); 1719218887Sdim 1720218887Sdim // Other cases: give up. 1721218887Sdim return UnknownVal(); 1722218887Sdim } 1723218887Sdim 1724234353Sdim return getBindingForLazySymbol(R); 1725218887Sdim} 1726218887Sdim 1727249423SdimSVal RegionStoreManager::getBindingForVar(RegionBindingsConstRef B, 1728249423Sdim const VarRegion *R) { 1729249423Sdim 1730218887Sdim // Check if the region has a binding. 1731249423Sdim if (const Optional<SVal> &V = B.getDirectBinding(R)) 1732218887Sdim return *V; 1733218887Sdim 1734218887Sdim // Lazily derive a value for the VarRegion. 1735218887Sdim const VarDecl *VD = R->getDecl(); 1736218887Sdim const MemSpaceRegion *MS = R->getMemorySpace(); 1737218887Sdim 1738249423Sdim // Arguments are always symbolic. 1739249423Sdim if (isa<StackArgumentsSpaceRegion>(MS)) 1740218887Sdim return svalBuilder.getRegionValueSymbolVal(R); 1741218887Sdim 1742249423Sdim // Is 'VD' declared constant? If so, retrieve the constant value. 1743251662Sdim if (VD->getType().isConstQualified()) 1744251662Sdim if (const Expr *Init = VD->getInit()) 1745251662Sdim if (Optional<SVal> V = svalBuilder.getConstantVal(Init)) 1746251662Sdim return *V; 1747249423Sdim 1748249423Sdim // This must come after the check for constants because closure-captured 1749249423Sdim // constant variables may appear in UnknownSpaceRegion. 1750249423Sdim if (isa<UnknownSpaceRegion>(MS)) 1751249423Sdim return svalBuilder.getRegionValueSymbolVal(R); 1752249423Sdim 1753218887Sdim if (isa<GlobalsSpaceRegion>(MS)) { 1754249423Sdim QualType T = VD->getType(); 1755218887Sdim 1756249423Sdim // Function-scoped static variables are default-initialized to 0; if they 1757249423Sdim // have an initializer, it would have been processed by now. 1758249423Sdim if (isa<StaticGlobalSpaceRegion>(MS)) 1759249423Sdim return svalBuilder.makeZeroVal(T); 1760218887Sdim 1761249423Sdim if (Optional<SVal> V = getBindingForDerivedDefaultValue(B, MS, R, T)) { 1762249423Sdim assert(!V->getAs<nonloc::LazyCompoundVal>()); 1763249423Sdim return V.getValue(); 1764218887Sdim } 1765218887Sdim 1766249423Sdim return svalBuilder.getRegionValueSymbolVal(R); 1767218887Sdim } 1768218887Sdim 1769218887Sdim return UndefinedVal(); 1770218887Sdim} 1771218887Sdim 1772234353SdimSVal RegionStoreManager::getBindingForLazySymbol(const TypedValueRegion *R) { 1773218887Sdim // All other values are symbolic. 1774218887Sdim return svalBuilder.getRegionValueSymbolVal(R); 1775218887Sdim} 1776218887Sdim 1777249423Sdimconst RegionStoreManager::SValListTy & 1778249423SdimRegionStoreManager::getInterestingValues(nonloc::LazyCompoundVal LCV) { 1779249423Sdim // First, check the cache. 1780249423Sdim LazyBindingsMapTy::iterator I = LazyBindingsMap.find(LCV.getCVData()); 1781249423Sdim if (I != LazyBindingsMap.end()) 1782249423Sdim return I->second; 1783249423Sdim 1784249423Sdim // If we don't have a list of values cached, start constructing it. 1785249423Sdim SValListTy List; 1786249423Sdim 1787249423Sdim const SubRegion *LazyR = LCV.getRegion(); 1788249423Sdim RegionBindingsRef B = getRegionBindings(LCV.getStore()); 1789249423Sdim 1790249423Sdim // If this region had /no/ bindings at the time, there are no interesting 1791249423Sdim // values to return. 1792249423Sdim const ClusterBindings *Cluster = B.lookup(LazyR->getBaseRegion()); 1793249423Sdim if (!Cluster) 1794249423Sdim return (LazyBindingsMap[LCV.getCVData()] = llvm_move(List)); 1795249423Sdim 1796249423Sdim SmallVector<BindingPair, 32> Bindings; 1797249423Sdim collectSubRegionBindings(Bindings, svalBuilder, *Cluster, LazyR, 1798249423Sdim /*IncludeAllDefaultBindings=*/true); 1799249423Sdim for (SmallVectorImpl<BindingPair>::const_iterator I = Bindings.begin(), 1800249423Sdim E = Bindings.end(); 1801249423Sdim I != E; ++I) { 1802249423Sdim SVal V = I->second; 1803249423Sdim if (V.isUnknownOrUndef() || V.isConstant()) 1804249423Sdim continue; 1805249423Sdim 1806249423Sdim if (Optional<nonloc::LazyCompoundVal> InnerLCV = 1807249423Sdim V.getAs<nonloc::LazyCompoundVal>()) { 1808249423Sdim const SValListTy &InnerList = getInterestingValues(*InnerLCV); 1809249423Sdim List.insert(List.end(), InnerList.begin(), InnerList.end()); 1810249423Sdim continue; 1811249423Sdim } 1812249423Sdim 1813249423Sdim List.push_back(V); 1814249423Sdim } 1815249423Sdim 1816249423Sdim return (LazyBindingsMap[LCV.getCVData()] = llvm_move(List)); 1817239462Sdim} 1818239462Sdim 1819249423SdimNonLoc RegionStoreManager::createLazyBinding(RegionBindingsConstRef B, 1820249423Sdim const TypedValueRegion *R) { 1821249423Sdim if (Optional<nonloc::LazyCompoundVal> V = 1822249423Sdim getExistingLazyBinding(svalBuilder, B, R, false)) 1823249423Sdim return *V; 1824249423Sdim 1825249423Sdim return svalBuilder.makeLazyCompoundVal(StoreRef(B.asStore(), *this), R); 1826249423Sdim} 1827249423Sdim 1828263508Sdimstatic bool isRecordEmpty(const RecordDecl *RD) { 1829263508Sdim if (!RD->field_empty()) 1830263508Sdim return false; 1831263508Sdim if (const CXXRecordDecl *CRD = dyn_cast<CXXRecordDecl>(RD)) 1832263508Sdim return CRD->getNumBases() == 0; 1833263508Sdim return true; 1834263508Sdim} 1835263508Sdim 1836249423SdimSVal RegionStoreManager::getBindingForStruct(RegionBindingsConstRef B, 1837249423Sdim const TypedValueRegion *R) { 1838239462Sdim const RecordDecl *RD = R->getValueType()->castAs<RecordType>()->getDecl(); 1839263508Sdim if (!RD->getDefinition() || isRecordEmpty(RD)) 1840239462Sdim return UnknownVal(); 1841239462Sdim 1842249423Sdim return createLazyBinding(B, R); 1843218887Sdim} 1844218887Sdim 1845249423SdimSVal RegionStoreManager::getBindingForArray(RegionBindingsConstRef B, 1846249423Sdim const TypedValueRegion *R) { 1847249423Sdim assert(Ctx.getAsConstantArrayType(R->getValueType()) && 1848249423Sdim "Only constant array types can have compound bindings."); 1849239462Sdim 1850249423Sdim return createLazyBinding(B, R); 1851218887Sdim} 1852218887Sdim 1853226633Sdimbool RegionStoreManager::includedInBindings(Store store, 1854226633Sdim const MemRegion *region) const { 1855249423Sdim RegionBindingsRef B = getRegionBindings(store); 1856226633Sdim region = region->getBaseRegion(); 1857239462Sdim 1858239462Sdim // Quick path: if the base is the head of a cluster, the region is live. 1859239462Sdim if (B.lookup(region)) 1860239462Sdim return true; 1861239462Sdim 1862239462Sdim // Slow path: if the region is the VALUE of any binding, it is live. 1863249423Sdim for (RegionBindingsRef::iterator RI = B.begin(), RE = B.end(); RI != RE; ++RI) { 1864239462Sdim const ClusterBindings &Cluster = RI.getData(); 1865239462Sdim for (ClusterBindings::iterator CI = Cluster.begin(), CE = Cluster.end(); 1866239462Sdim CI != CE; ++CI) { 1867239462Sdim const SVal &D = CI.getData(); 1868239462Sdim if (const MemRegion *R = D.getAsRegion()) 1869239462Sdim if (R->getBaseRegion() == region) 1870239462Sdim return true; 1871239462Sdim } 1872226633Sdim } 1873239462Sdim 1874226633Sdim return false; 1875226633Sdim} 1876226633Sdim 1877218887Sdim//===----------------------------------------------------------------------===// 1878218887Sdim// Binding values to regions. 1879218887Sdim//===----------------------------------------------------------------------===// 1880218887Sdim 1881243830SdimStoreRef RegionStoreManager::killBinding(Store ST, Loc L) { 1882249423Sdim if (Optional<loc::MemRegionVal> LV = L.getAs<loc::MemRegionVal>()) 1883249423Sdim if (const MemRegion* R = LV->getRegion()) 1884249423Sdim return StoreRef(getRegionBindings(ST).removeBinding(R) 1885249423Sdim .asImmutableMap() 1886249423Sdim .getRootWithoutRetain(), 1887218887Sdim *this); 1888218887Sdim 1889243830Sdim return StoreRef(ST, *this); 1890218887Sdim} 1891218887Sdim 1892249423SdimRegionBindingsRef 1893249423SdimRegionStoreManager::bind(RegionBindingsConstRef B, Loc L, SVal V) { 1894249423Sdim if (L.getAs<loc::ConcreteInt>()) 1895249423Sdim return B; 1896218887Sdim 1897218887Sdim // If we get here, the location should be a region. 1898249423Sdim const MemRegion *R = L.castAs<loc::MemRegionVal>().getRegion(); 1899218887Sdim 1900218887Sdim // Check if the region is a struct region. 1901239462Sdim if (const TypedValueRegion* TR = dyn_cast<TypedValueRegion>(R)) { 1902239462Sdim QualType Ty = TR->getValueType(); 1903243830Sdim if (Ty->isArrayType()) 1904249423Sdim return bindArray(B, TR, V); 1905239462Sdim if (Ty->isStructureOrClassType()) 1906249423Sdim return bindStruct(B, TR, V); 1907239462Sdim if (Ty->isVectorType()) 1908249423Sdim return bindVector(B, TR, V); 1909263508Sdim if (Ty->isUnionType()) 1910263508Sdim return bindAggregate(B, TR, V); 1911239462Sdim } 1912218887Sdim 1913239462Sdim if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(R)) { 1914218887Sdim // Binding directly to a symbolic region should be treated as binding 1915218887Sdim // to element 0. 1916243830Sdim QualType T = SR->getSymbol()->getType(); 1917243830Sdim if (T->isAnyPointerType() || T->isReferenceType()) 1918243830Sdim T = T->getPointeeType(); 1919218887Sdim 1920218887Sdim R = GetElementZeroRegion(SR, T); 1921218887Sdim } 1922218887Sdim 1923239462Sdim // Clear out bindings that may overlap with this binding. 1924249423Sdim RegionBindingsRef NewB = removeSubRegionBindings(B, cast<SubRegion>(R)); 1925249423Sdim return NewB.addBinding(BindingKey::Make(R, BindingKey::Direct), V); 1926218887Sdim} 1927218887Sdim 1928249423SdimRegionBindingsRef 1929249423SdimRegionStoreManager::setImplicitDefaultValue(RegionBindingsConstRef B, 1930249423Sdim const MemRegion *R, 1931249423Sdim QualType T) { 1932218887Sdim SVal V; 1933218887Sdim 1934218887Sdim if (Loc::isLocType(T)) 1935218887Sdim V = svalBuilder.makeNull(); 1936251662Sdim else if (T->isIntegralOrEnumerationType()) 1937218887Sdim V = svalBuilder.makeZeroVal(T); 1938218887Sdim else if (T->isStructureOrClassType() || T->isArrayType()) { 1939218887Sdim // Set the default value to a zero constant when it is a structure 1940218887Sdim // or array. The type doesn't really matter. 1941218887Sdim V = svalBuilder.makeZeroVal(Ctx.IntTy); 1942218887Sdim } 1943218887Sdim else { 1944224145Sdim // We can't represent values of this type, but we still need to set a value 1945224145Sdim // to record that the region has been initialized. 1946224145Sdim // If this assertion ever fires, a new case should be added above -- we 1947224145Sdim // should know how to default-initialize any value we can symbolicate. 1948224145Sdim assert(!SymbolManager::canSymbolicate(T) && "This type is representable"); 1949224145Sdim V = UnknownVal(); 1950218887Sdim } 1951218887Sdim 1952249423Sdim return B.addBinding(R, BindingKey::Default, V); 1953218887Sdim} 1954218887Sdim 1955249423SdimRegionBindingsRef 1956249423SdimRegionStoreManager::bindArray(RegionBindingsConstRef B, 1957249423Sdim const TypedValueRegion* R, 1958249423Sdim SVal Init) { 1959218887Sdim 1960218887Sdim const ArrayType *AT =cast<ArrayType>(Ctx.getCanonicalType(R->getValueType())); 1961218887Sdim QualType ElementTy = AT->getElementType(); 1962218887Sdim Optional<uint64_t> Size; 1963218887Sdim 1964218887Sdim if (const ConstantArrayType* CAT = dyn_cast<ConstantArrayType>(AT)) 1965218887Sdim Size = CAT->getSize().getZExtValue(); 1966218887Sdim 1967218887Sdim // Check if the init expr is a string literal. 1968249423Sdim if (Optional<loc::MemRegionVal> MRV = Init.getAs<loc::MemRegionVal>()) { 1969218887Sdim const StringRegion *S = cast<StringRegion>(MRV->getRegion()); 1970218887Sdim 1971218887Sdim // Treat the string as a lazy compound value. 1972249423Sdim StoreRef store(B.asStore(), *this); 1973249423Sdim nonloc::LazyCompoundVal LCV = svalBuilder.makeLazyCompoundVal(store, S) 1974249423Sdim .castAs<nonloc::LazyCompoundVal>(); 1975249423Sdim return bindAggregate(B, R, LCV); 1976218887Sdim } 1977218887Sdim 1978218887Sdim // Handle lazy compound values. 1979249423Sdim if (Init.getAs<nonloc::LazyCompoundVal>()) 1980249423Sdim return bindAggregate(B, R, Init); 1981218887Sdim 1982218887Sdim // Remaining case: explicit compound values. 1983218887Sdim 1984218887Sdim if (Init.isUnknown()) 1985249423Sdim return setImplicitDefaultValue(B, R, ElementTy); 1986218887Sdim 1987249423Sdim const nonloc::CompoundVal& CV = Init.castAs<nonloc::CompoundVal>(); 1988218887Sdim nonloc::CompoundVal::iterator VI = CV.begin(), VE = CV.end(); 1989218887Sdim uint64_t i = 0; 1990218887Sdim 1991249423Sdim RegionBindingsRef NewB(B); 1992249423Sdim 1993218887Sdim for (; Size.hasValue() ? i < Size.getValue() : true ; ++i, ++VI) { 1994218887Sdim // The init list might be shorter than the array length. 1995218887Sdim if (VI == VE) 1996218887Sdim break; 1997218887Sdim 1998218887Sdim const NonLoc &Idx = svalBuilder.makeArrayIndex(i); 1999218887Sdim const ElementRegion *ER = MRMgr.getElementRegion(ElementTy, Idx, R, Ctx); 2000218887Sdim 2001218887Sdim if (ElementTy->isStructureOrClassType()) 2002249423Sdim NewB = bindStruct(NewB, ER, *VI); 2003218887Sdim else if (ElementTy->isArrayType()) 2004249423Sdim NewB = bindArray(NewB, ER, *VI); 2005218887Sdim else 2006251662Sdim NewB = bind(NewB, loc::MemRegionVal(ER), *VI); 2007218887Sdim } 2008218887Sdim 2009218887Sdim // If the init list is shorter than the array length, set the 2010218887Sdim // array default value. 2011218887Sdim if (Size.hasValue() && i < Size.getValue()) 2012249423Sdim NewB = setImplicitDefaultValue(NewB, R, ElementTy); 2013218887Sdim 2014249423Sdim return NewB; 2015218887Sdim} 2016218887Sdim 2017249423SdimRegionBindingsRef RegionStoreManager::bindVector(RegionBindingsConstRef B, 2018249423Sdim const TypedValueRegion* R, 2019249423Sdim SVal V) { 2020239462Sdim QualType T = R->getValueType(); 2021239462Sdim assert(T->isVectorType()); 2022239462Sdim const VectorType *VT = T->getAs<VectorType>(); // Use getAs for typedefs. 2023239462Sdim 2024239462Sdim // Handle lazy compound values and symbolic values. 2025249423Sdim if (V.getAs<nonloc::LazyCompoundVal>() || V.getAs<nonloc::SymbolVal>()) 2026249423Sdim return bindAggregate(B, R, V); 2027239462Sdim 2028239462Sdim // We may get non-CompoundVal accidentally due to imprecise cast logic or 2029239462Sdim // that we are binding symbolic struct value. Kill the field values, and if 2030239462Sdim // the value is symbolic go and bind it as a "default" binding. 2031249423Sdim if (!V.getAs<nonloc::CompoundVal>()) { 2032249423Sdim return bindAggregate(B, R, UnknownVal()); 2033239462Sdim } 2034239462Sdim 2035239462Sdim QualType ElemType = VT->getElementType(); 2036249423Sdim nonloc::CompoundVal CV = V.castAs<nonloc::CompoundVal>(); 2037239462Sdim nonloc::CompoundVal::iterator VI = CV.begin(), VE = CV.end(); 2038239462Sdim unsigned index = 0, numElements = VT->getNumElements(); 2039249423Sdim RegionBindingsRef NewB(B); 2040249423Sdim 2041239462Sdim for ( ; index != numElements ; ++index) { 2042239462Sdim if (VI == VE) 2043239462Sdim break; 2044239462Sdim 2045239462Sdim NonLoc Idx = svalBuilder.makeArrayIndex(index); 2046239462Sdim const ElementRegion *ER = MRMgr.getElementRegion(ElemType, Idx, R, Ctx); 2047251662Sdim 2048239462Sdim if (ElemType->isArrayType()) 2049249423Sdim NewB = bindArray(NewB, ER, *VI); 2050239462Sdim else if (ElemType->isStructureOrClassType()) 2051249423Sdim NewB = bindStruct(NewB, ER, *VI); 2052239462Sdim else 2053251662Sdim NewB = bind(NewB, loc::MemRegionVal(ER), *VI); 2054239462Sdim } 2055249423Sdim return NewB; 2056239462Sdim} 2057239462Sdim 2058251662SdimOptional<RegionBindingsRef> 2059251662SdimRegionStoreManager::tryBindSmallStruct(RegionBindingsConstRef B, 2060251662Sdim const TypedValueRegion *R, 2061251662Sdim const RecordDecl *RD, 2062251662Sdim nonloc::LazyCompoundVal LCV) { 2063251662Sdim FieldVector Fields; 2064251662Sdim 2065251662Sdim if (const CXXRecordDecl *Class = dyn_cast<CXXRecordDecl>(RD)) 2066251662Sdim if (Class->getNumBases() != 0 || Class->getNumVBases() != 0) 2067251662Sdim return None; 2068251662Sdim 2069251662Sdim for (RecordDecl::field_iterator I = RD->field_begin(), E = RD->field_end(); 2070251662Sdim I != E; ++I) { 2071251662Sdim const FieldDecl *FD = *I; 2072251662Sdim if (FD->isUnnamedBitfield()) 2073251662Sdim continue; 2074251662Sdim 2075251662Sdim // If there are too many fields, or if any of the fields are aggregates, 2076251662Sdim // just use the LCV as a default binding. 2077251662Sdim if (Fields.size() == SmallStructLimit) 2078251662Sdim return None; 2079251662Sdim 2080251662Sdim QualType Ty = FD->getType(); 2081251662Sdim if (!(Ty->isScalarType() || Ty->isReferenceType())) 2082251662Sdim return None; 2083251662Sdim 2084251662Sdim Fields.push_back(*I); 2085251662Sdim } 2086251662Sdim 2087251662Sdim RegionBindingsRef NewB = B; 2088251662Sdim 2089251662Sdim for (FieldVector::iterator I = Fields.begin(), E = Fields.end(); I != E; ++I){ 2090251662Sdim const FieldRegion *SourceFR = MRMgr.getFieldRegion(*I, LCV.getRegion()); 2091251662Sdim SVal V = getBindingForField(getRegionBindings(LCV.getStore()), SourceFR); 2092251662Sdim 2093251662Sdim const FieldRegion *DestFR = MRMgr.getFieldRegion(*I, R); 2094251662Sdim NewB = bind(NewB, loc::MemRegionVal(DestFR), V); 2095251662Sdim } 2096251662Sdim 2097251662Sdim return NewB; 2098251662Sdim} 2099251662Sdim 2100249423SdimRegionBindingsRef RegionStoreManager::bindStruct(RegionBindingsConstRef B, 2101249423Sdim const TypedValueRegion* R, 2102249423Sdim SVal V) { 2103218887Sdim if (!Features.supportsFields()) 2104249423Sdim return B; 2105218887Sdim 2106218887Sdim QualType T = R->getValueType(); 2107218887Sdim assert(T->isStructureOrClassType()); 2108218887Sdim 2109218887Sdim const RecordType* RT = T->getAs<RecordType>(); 2110251662Sdim const RecordDecl *RD = RT->getDecl(); 2111218887Sdim 2112226633Sdim if (!RD->isCompleteDefinition()) 2113249423Sdim return B; 2114218887Sdim 2115239462Sdim // Handle lazy compound values and symbolic values. 2116251662Sdim if (Optional<nonloc::LazyCompoundVal> LCV = 2117251662Sdim V.getAs<nonloc::LazyCompoundVal>()) { 2118251662Sdim if (Optional<RegionBindingsRef> NewB = tryBindSmallStruct(B, R, RD, *LCV)) 2119251662Sdim return *NewB; 2120249423Sdim return bindAggregate(B, R, V); 2121251662Sdim } 2122251662Sdim if (V.getAs<nonloc::SymbolVal>()) 2123251662Sdim return bindAggregate(B, R, V); 2124218887Sdim 2125218887Sdim // We may get non-CompoundVal accidentally due to imprecise cast logic or 2126218887Sdim // that we are binding symbolic struct value. Kill the field values, and if 2127218887Sdim // the value is symbolic go and bind it as a "default" binding. 2128249423Sdim if (V.isUnknown() || !V.getAs<nonloc::CompoundVal>()) 2129249423Sdim return bindAggregate(B, R, UnknownVal()); 2130218887Sdim 2131249423Sdim const nonloc::CompoundVal& CV = V.castAs<nonloc::CompoundVal>(); 2132218887Sdim nonloc::CompoundVal::iterator VI = CV.begin(), VE = CV.end(); 2133218887Sdim 2134218887Sdim RecordDecl::field_iterator FI, FE; 2135249423Sdim RegionBindingsRef NewB(B); 2136249423Sdim 2137234353Sdim for (FI = RD->field_begin(), FE = RD->field_end(); FI != FE; ++FI) { 2138218887Sdim 2139218887Sdim if (VI == VE) 2140218887Sdim break; 2141218887Sdim 2142234353Sdim // Skip any unnamed bitfields to stay in sync with the initializers. 2143239462Sdim if (FI->isUnnamedBitfield()) 2144234353Sdim continue; 2145234353Sdim 2146239462Sdim QualType FTy = FI->getType(); 2147218887Sdim const FieldRegion* FR = MRMgr.getFieldRegion(*FI, R); 2148218887Sdim 2149218887Sdim if (FTy->isArrayType()) 2150249423Sdim NewB = bindArray(NewB, FR, *VI); 2151218887Sdim else if (FTy->isStructureOrClassType()) 2152249423Sdim NewB = bindStruct(NewB, FR, *VI); 2153218887Sdim else 2154251662Sdim NewB = bind(NewB, loc::MemRegionVal(FR), *VI); 2155234353Sdim ++VI; 2156218887Sdim } 2157218887Sdim 2158218887Sdim // There may be fewer values in the initialize list than the fields of struct. 2159218887Sdim if (FI != FE) { 2160249423Sdim NewB = NewB.addBinding(R, BindingKey::Default, 2161249423Sdim svalBuilder.makeIntVal(0, false)); 2162218887Sdim } 2163218887Sdim 2164249423Sdim return NewB; 2165218887Sdim} 2166218887Sdim 2167249423SdimRegionBindingsRef 2168249423SdimRegionStoreManager::bindAggregate(RegionBindingsConstRef B, 2169249423Sdim const TypedRegion *R, 2170249423Sdim SVal Val) { 2171239462Sdim // Remove the old bindings, using 'R' as the root of all regions 2172239462Sdim // we will invalidate. Then add the new binding. 2173249423Sdim return removeSubRegionBindings(B, R).addBinding(R, BindingKey::Default, Val); 2174218887Sdim} 2175218887Sdim 2176218887Sdim//===----------------------------------------------------------------------===// 2177218887Sdim// State pruning. 2178218887Sdim//===----------------------------------------------------------------------===// 2179218887Sdim 2180218887Sdimnamespace { 2181218887Sdimclass removeDeadBindingsWorker : 2182218887Sdim public ClusterAnalysis<removeDeadBindingsWorker> { 2183226633Sdim SmallVector<const SymbolicRegion*, 12> Postponed; 2184218887Sdim SymbolReaper &SymReaper; 2185218887Sdim const StackFrameContext *CurrentLCtx; 2186218887Sdim 2187218887Sdimpublic: 2188234353Sdim removeDeadBindingsWorker(RegionStoreManager &rm, 2189234353Sdim ProgramStateManager &stateMgr, 2190249423Sdim RegionBindingsRef b, SymbolReaper &symReaper, 2191218887Sdim const StackFrameContext *LCtx) 2192251662Sdim : ClusterAnalysis<removeDeadBindingsWorker>(rm, stateMgr, b, GFK_None), 2193218887Sdim SymReaper(symReaper), CurrentLCtx(LCtx) {} 2194218887Sdim 2195218887Sdim // Called by ClusterAnalysis. 2196239462Sdim void VisitAddedToCluster(const MemRegion *baseR, const ClusterBindings &C); 2197249423Sdim void VisitCluster(const MemRegion *baseR, const ClusterBindings *C); 2198249423Sdim using ClusterAnalysis<removeDeadBindingsWorker>::VisitCluster; 2199218887Sdim 2200218887Sdim bool UpdatePostponed(); 2201218887Sdim void VisitBinding(SVal V); 2202218887Sdim}; 2203218887Sdim} 2204218887Sdim 2205218887Sdimvoid removeDeadBindingsWorker::VisitAddedToCluster(const MemRegion *baseR, 2206239462Sdim const ClusterBindings &C) { 2207218887Sdim 2208218887Sdim if (const VarRegion *VR = dyn_cast<VarRegion>(baseR)) { 2209218887Sdim if (SymReaper.isLive(VR)) 2210239462Sdim AddToWorkList(baseR, &C); 2211218887Sdim 2212218887Sdim return; 2213218887Sdim } 2214218887Sdim 2215218887Sdim if (const SymbolicRegion *SR = dyn_cast<SymbolicRegion>(baseR)) { 2216218887Sdim if (SymReaper.isLive(SR->getSymbol())) 2217239462Sdim AddToWorkList(SR, &C); 2218218887Sdim else 2219218887Sdim Postponed.push_back(SR); 2220218887Sdim 2221218887Sdim return; 2222218887Sdim } 2223218887Sdim 2224218887Sdim if (isa<NonStaticGlobalSpaceRegion>(baseR)) { 2225239462Sdim AddToWorkList(baseR, &C); 2226218887Sdim return; 2227218887Sdim } 2228218887Sdim 2229218887Sdim // CXXThisRegion in the current or parent location context is live. 2230218887Sdim if (const CXXThisRegion *TR = dyn_cast<CXXThisRegion>(baseR)) { 2231218887Sdim const StackArgumentsSpaceRegion *StackReg = 2232218887Sdim cast<StackArgumentsSpaceRegion>(TR->getSuperRegion()); 2233218887Sdim const StackFrameContext *RegCtx = StackReg->getStackFrame(); 2234243830Sdim if (CurrentLCtx && 2235243830Sdim (RegCtx == CurrentLCtx || RegCtx->isParentOf(CurrentLCtx))) 2236239462Sdim AddToWorkList(TR, &C); 2237218887Sdim } 2238218887Sdim} 2239218887Sdim 2240218887Sdimvoid removeDeadBindingsWorker::VisitCluster(const MemRegion *baseR, 2241249423Sdim const ClusterBindings *C) { 2242249423Sdim if (!C) 2243249423Sdim return; 2244249423Sdim 2245243830Sdim // Mark the symbol for any SymbolicRegion with live bindings as live itself. 2246243830Sdim // This means we should continue to track that symbol. 2247243830Sdim if (const SymbolicRegion *SymR = dyn_cast<SymbolicRegion>(baseR)) 2248243830Sdim SymReaper.markLive(SymR->getSymbol()); 2249243830Sdim 2250249423Sdim for (ClusterBindings::iterator I = C->begin(), E = C->end(); I != E; ++I) 2251239462Sdim VisitBinding(I.getData()); 2252218887Sdim} 2253218887Sdim 2254218887Sdimvoid removeDeadBindingsWorker::VisitBinding(SVal V) { 2255218887Sdim // Is it a LazyCompoundVal? All referenced regions are live as well. 2256249423Sdim if (Optional<nonloc::LazyCompoundVal> LCS = 2257249423Sdim V.getAs<nonloc::LazyCompoundVal>()) { 2258218887Sdim 2259249423Sdim const RegionStoreManager::SValListTy &Vals = RM.getInterestingValues(*LCS); 2260239462Sdim 2261249423Sdim for (RegionStoreManager::SValListTy::const_iterator I = Vals.begin(), 2262249423Sdim E = Vals.end(); 2263249423Sdim I != E; ++I) 2264249423Sdim VisitBinding(*I); 2265239462Sdim 2266218887Sdim return; 2267218887Sdim } 2268218887Sdim 2269218887Sdim // If V is a region, then add it to the worklist. 2270239462Sdim if (const MemRegion *R = V.getAsRegion()) { 2271218887Sdim AddToWorkList(R); 2272239462Sdim 2273239462Sdim // All regions captured by a block are also live. 2274239462Sdim if (const BlockDataRegion *BR = dyn_cast<BlockDataRegion>(R)) { 2275239462Sdim BlockDataRegion::referenced_vars_iterator I = BR->referenced_vars_begin(), 2276239462Sdim E = BR->referenced_vars_end(); 2277243830Sdim for ( ; I != E; ++I) 2278243830Sdim AddToWorkList(I.getCapturedRegion()); 2279239462Sdim } 2280239462Sdim } 2281239462Sdim 2282218887Sdim 2283234353Sdim // Update the set of live symbols. 2284234353Sdim for (SymExpr::symbol_iterator SI = V.symbol_begin(), SE = V.symbol_end(); 2285234353Sdim SI!=SE; ++SI) 2286218887Sdim SymReaper.markLive(*SI); 2287218887Sdim} 2288218887Sdim 2289218887Sdimbool removeDeadBindingsWorker::UpdatePostponed() { 2290218887Sdim // See if any postponed SymbolicRegions are actually live now, after 2291218887Sdim // having done a scan. 2292218887Sdim bool changed = false; 2293218887Sdim 2294226633Sdim for (SmallVectorImpl<const SymbolicRegion*>::iterator 2295218887Sdim I = Postponed.begin(), E = Postponed.end() ; I != E ; ++I) { 2296243830Sdim if (const SymbolicRegion *SR = *I) { 2297218887Sdim if (SymReaper.isLive(SR->getSymbol())) { 2298218887Sdim changed |= AddToWorkList(SR); 2299218887Sdim *I = NULL; 2300218887Sdim } 2301218887Sdim } 2302218887Sdim } 2303218887Sdim 2304218887Sdim return changed; 2305218887Sdim} 2306218887Sdim 2307218887SdimStoreRef RegionStoreManager::removeDeadBindings(Store store, 2308218887Sdim const StackFrameContext *LCtx, 2309226633Sdim SymbolReaper& SymReaper) { 2310249423Sdim RegionBindingsRef B = getRegionBindings(store); 2311218887Sdim removeDeadBindingsWorker W(*this, StateMgr, B, SymReaper, LCtx); 2312218887Sdim W.GenerateClusters(); 2313218887Sdim 2314218887Sdim // Enqueue the region roots onto the worklist. 2315226633Sdim for (SymbolReaper::region_iterator I = SymReaper.region_begin(), 2316226633Sdim E = SymReaper.region_end(); I != E; ++I) { 2317218887Sdim W.AddToWorkList(*I); 2318226633Sdim } 2319218887Sdim 2320218887Sdim do W.RunWorkList(); while (W.UpdatePostponed()); 2321218887Sdim 2322218887Sdim // We have now scanned the store, marking reachable regions and symbols 2323218887Sdim // as live. We now remove all the regions that are dead from the store 2324218887Sdim // as well as update DSymbols with the set symbols that are now dead. 2325249423Sdim for (RegionBindingsRef::iterator I = B.begin(), E = B.end(); I != E; ++I) { 2326239462Sdim const MemRegion *Base = I.getKey(); 2327218887Sdim 2328218887Sdim // If the cluster has been visited, we know the region has been marked. 2329239462Sdim if (W.isVisited(Base)) 2330218887Sdim continue; 2331218887Sdim 2332218887Sdim // Remove the dead entry. 2333249423Sdim B = B.remove(Base); 2334218887Sdim 2335239462Sdim if (const SymbolicRegion *SymR = dyn_cast<SymbolicRegion>(Base)) 2336218887Sdim SymReaper.maybeDead(SymR->getSymbol()); 2337218887Sdim 2338239462Sdim // Mark all non-live symbols that this binding references as dead. 2339239462Sdim const ClusterBindings &Cluster = I.getData(); 2340239462Sdim for (ClusterBindings::iterator CI = Cluster.begin(), CE = Cluster.end(); 2341239462Sdim CI != CE; ++CI) { 2342239462Sdim SVal X = CI.getData(); 2343239462Sdim SymExpr::symbol_iterator SI = X.symbol_begin(), SE = X.symbol_end(); 2344239462Sdim for (; SI != SE; ++SI) 2345239462Sdim SymReaper.maybeDead(*SI); 2346239462Sdim } 2347218887Sdim } 2348218887Sdim 2349249423Sdim return StoreRef(B.asStore(), *this); 2350218887Sdim} 2351218887Sdim 2352218887Sdim//===----------------------------------------------------------------------===// 2353218887Sdim// Utility methods. 2354218887Sdim//===----------------------------------------------------------------------===// 2355218887Sdim 2356226633Sdimvoid RegionStoreManager::print(Store store, raw_ostream &OS, 2357218887Sdim const char* nl, const char *sep) { 2358249423Sdim RegionBindingsRef B = getRegionBindings(store); 2359239462Sdim OS << "Store (direct and default bindings), " 2360249423Sdim << B.asStore() 2361239462Sdim << " :" << nl; 2362249423Sdim B.dump(OS, nl); 2363218887Sdim} 2364