19e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek//== MemRegion.h - Abstract memory regions for static analysis --*- C++ -*--==// 29e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek// 39e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek// The LLVM Compiler Infrastructure 49e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek// 59e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek// This file is distributed under the University of Illinois Open Source 69e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek// License. See LICENSE.TXT for details. 79e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek// 89e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek//===----------------------------------------------------------------------===// 99e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek// 109e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek// This file defines MemRegion and its subclasses. MemRegion defines a 119e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek// partially-typed abstraction of memory useful for path-sensitive dataflow 129e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek// analyses. 139e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek// 149e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek//===----------------------------------------------------------------------===// 159e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek 165a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis#ifndef LLVM_CLANG_GR_MEMREGION_H 175a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis#define LLVM_CLANG_GR_MEMREGION_H 189e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek 19478851c3ed6bd784e7377dffd8e57b200c1b9ba9Benjamin Kramer#include "clang/AST/ASTContext.h" 209ff2b13aee0f89d23ef4820218f9b88bb5e5c1c1Ken Dyck#include "clang/AST/CharUnits.h" 21993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek#include "clang/AST/Decl.h" 224c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek#include "clang/AST/ExprObjC.h" 23d47d3b0cfeb7e8564ff77f48130fe63282b6d127Chris Lattner#include "clang/Basic/LLVM.h" 249b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/SVals.h" 259c1845dbed9817520f5a7db8bd80a560c6c6ae6bArgyrios Kyrtzidis#include "llvm/Support/ErrorHandling.h" 269e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek#include "llvm/ADT/FoldingSet.h" 279e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek#include <string> 289e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek 295e2d2c2ee3cf410643e0f9a5701708e51409d973Benjamin Kramernamespace llvm { 305e2d2c2ee3cf410643e0f9a5701708e51409d973Benjamin Kramerclass BumpPtrAllocator; 315e2d2c2ee3cf410643e0f9a5701708e51409d973Benjamin Kramer} 329e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek 339e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremeneknamespace clang { 341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 35d17da2b99f323fa91b01e1dd119cc32e0ee8197dTed Kremenekclass LocationContext; 3667d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenekclass StackFrameContext; 375a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 389ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremeneknamespace ento { 395a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 405a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidisclass MemRegionManager; 415a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidisclass MemSpaceRegion; 42c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenekclass SValBuilder; 434240096011a187807058f887eb81df750ffa17feTed Kremenekclass VarRegion; 44dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenekclass CodeTextRegion; 451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 46e888233f6b115d3b0dd73bcb5f35e93794408542Zhongxing Xu/// Represent a region's offset within the top level base region. 47e888233f6b115d3b0dd73bcb5f35e93794408542Zhongxing Xuclass RegionOffset { 48e888233f6b115d3b0dd73bcb5f35e93794408542Zhongxing Xu /// The base region. 49e888233f6b115d3b0dd73bcb5f35e93794408542Zhongxing Xu const MemRegion *R; 50e888233f6b115d3b0dd73bcb5f35e93794408542Zhongxing Xu 51e888233f6b115d3b0dd73bcb5f35e93794408542Zhongxing Xu /// The bit offset within the base region. It shouldn't be negative. 52e3273e78da4716f9c999ae207f6898f376a6e1a4Zhongxing Xu int64_t Offset; 53e888233f6b115d3b0dd73bcb5f35e93794408542Zhongxing Xu 54e888233f6b115d3b0dd73bcb5f35e93794408542Zhongxing Xupublic: 555375d82d1d096ddd8879d8e6641a8f042b0d1d43Aaron Ballman // We're using a const instead of an enumeration due to the size required; 565375d82d1d096ddd8879d8e6641a8f042b0d1d43Aaron Ballman // Visual Studio will only create enumerations of size int, not long long. 575375d82d1d096ddd8879d8e6641a8f042b0d1d43Aaron Ballman static const int64_t Symbolic = INT64_MAX; 58824e07ac8f5c9efdddb4254de0203b9675b1ef0bJordan Rose 59e0d24eb1060a213ec9820dc02c45f26b2d5b348bJordan Rose RegionOffset() : R(0) {} 60e3273e78da4716f9c999ae207f6898f376a6e1a4Zhongxing Xu RegionOffset(const MemRegion *r, int64_t off) : R(r), Offset(off) {} 61e888233f6b115d3b0dd73bcb5f35e93794408542Zhongxing Xu 62e888233f6b115d3b0dd73bcb5f35e93794408542Zhongxing Xu const MemRegion *getRegion() const { return R; } 63824e07ac8f5c9efdddb4254de0203b9675b1ef0bJordan Rose 64824e07ac8f5c9efdddb4254de0203b9675b1ef0bJordan Rose bool hasSymbolicOffset() const { return Offset == Symbolic; } 65824e07ac8f5c9efdddb4254de0203b9675b1ef0bJordan Rose 66824e07ac8f5c9efdddb4254de0203b9675b1ef0bJordan Rose int64_t getOffset() const { 67824e07ac8f5c9efdddb4254de0203b9675b1ef0bJordan Rose assert(!hasSymbolicOffset()); 68824e07ac8f5c9efdddb4254de0203b9675b1ef0bJordan Rose return Offset; 69824e07ac8f5c9efdddb4254de0203b9675b1ef0bJordan Rose } 70e0d24eb1060a213ec9820dc02c45f26b2d5b348bJordan Rose 71e0d24eb1060a213ec9820dc02c45f26b2d5b348bJordan Rose bool isValid() const { return R; } 72e888233f6b115d3b0dd73bcb5f35e93794408542Zhongxing Xu}; 73e888233f6b115d3b0dd73bcb5f35e93794408542Zhongxing Xu 7419e1f0ba5cec738ce6cebe3fe0e1edc782206494Ted Kremenek//===----------------------------------------------------------------------===// 7519e1f0ba5cec738ce6cebe3fe0e1edc782206494Ted Kremenek// Base region classes. 7619e1f0ba5cec738ce6cebe3fe0e1edc782206494Ted Kremenek//===----------------------------------------------------------------------===// 771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 789e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek/// MemRegion - The root abstract class for all memory regions. 799e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekclass MemRegion : public llvm::FoldingSetNode { 804240096011a187807058f887eb81df750ffa17feTed Kremenek friend class MemRegionManager; 819e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekpublic: 8267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek enum Kind { 8367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // Memory spaces. 84dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek GenericMemSpaceRegionKind, 8567d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek StackLocalsSpaceRegionKind, 8667d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek StackArgumentsSpaceRegionKind, 8767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek HeapSpaceRegionKind, 882b87ae45e129b941d0a4d221c9d4842385a119bdTed Kremenek UnknownSpaceRegionKind, 89dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek StaticGlobalSpaceRegionKind, 90eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks GlobalInternalSpaceRegionKind, 91eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks GlobalSystemSpaceRegionKind, 92eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks GlobalImmutableSpaceRegionKind, 93eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks BEG_NON_STATIC_GLOBAL_MEMSPACES = GlobalInternalSpaceRegionKind, 94eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks END_NON_STATIC_GLOBAL_MEMSPACES = GlobalImmutableSpaceRegionKind, 95eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks BEG_GLOBAL_MEMSPACES = StaticGlobalSpaceRegionKind, 96eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks END_GLOBAL_MEMSPACES = GlobalImmutableSpaceRegionKind, 97dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek BEG_MEMSPACES = GenericMemSpaceRegionKind, 98eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks END_MEMSPACES = GlobalImmutableSpaceRegionKind, 9967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // Untyped regions. 10067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek SymbolicRegionKind, 10167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek AllocaRegionKind, 10267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // Typed regions. 10367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek BEG_TYPED_REGIONS, 10467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek FunctionTextRegionKind = BEG_TYPED_REGIONS, 10567d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek BlockTextRegionKind, 1068ecf59afbab1dbf184dc4c0c47e7213cbd32ba0aJordan Rose BlockDataRegionKind, 1079697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek BEG_TYPED_VALUE_REGIONS, 1089697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek CompoundLiteralRegionKind = BEG_TYPED_VALUE_REGIONS, 109de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek CXXThisRegionKind, 11067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek StringRegionKind, 1114c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek ObjCStringRegionKind, 11267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek ElementRegionKind, 11367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek // Decl Regions. 11467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek BEG_DECL_REGIONS, 11567d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek VarRegionKind = BEG_DECL_REGIONS, 11667d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek FieldRegionKind, 11767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek ObjCIvarRegionKind, 1184fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu END_DECL_REGIONS = ObjCIvarRegionKind, 11902fe28c8a6da29d4ad88d0900c133dcf22d24a75Zhongxing Xu CXXTempObjectRegionKind, 1204fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu CXXBaseObjectRegionKind, 121096aef9597b263b4cd6a0feaacf9e7214fa9c75aJordy Rose END_TYPED_VALUE_REGIONS = CXXBaseObjectRegionKind, 122096aef9597b263b4cd6a0feaacf9e7214fa9c75aJordy Rose END_TYPED_REGIONS = CXXBaseObjectRegionKind 12367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek }; 12467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek 1259e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekprivate: 1269e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek const Kind kind; 1271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1289e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekprotected: 1299e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek MemRegion(Kind k) : kind(k) {} 1309e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek virtual ~MemRegion(); 1319e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek 1329e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekpublic: 133a6275a534da701f37d19a068e6361e5f10f983a1Ted Kremenek ASTContext &getContext() const; 1341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1359e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek virtual void Profile(llvm::FoldingSetNodeID& ID) const = 0; 136a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek 137a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek virtual MemRegionManager* getMemRegionManager() const = 0; 138a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek 139bb7c96f290453104ec35ca17111a5165f68a4697Ted Kremenek const MemSpaceRegion *getMemorySpace() const; 1401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 141adca27102ff733c7d42fcbbc2c7e134a7fc026f9Zhongxing Xu const MemRegion *getBaseRegion() const; 142adca27102ff733c7d42fcbbc2c7e134a7fc026f9Zhongxing Xu 143b11a3ada9a22e146c6edd33bcc6301e221fedd7aJordan Rose const MemRegion *StripCasts(bool StripBaseCasts = true) const; 1441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1451508636e99faddf569a57fce82c0fb3aa2124396Ted Kremenek bool hasGlobalsOrParametersStorage() const; 1461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 147de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek bool hasStackStorage() const; 148de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek 149de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek bool hasStackNonParametersStorage() const; 150de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek 151de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek bool hasStackParametersStorage() const; 152b21ff77c8126ea628b66d2ffb931fdaa7884f5d2Zhongxing Xu 153e888233f6b115d3b0dd73bcb5f35e93794408542Zhongxing Xu /// Compute the offset within the top level memory object. 154e888233f6b115d3b0dd73bcb5f35e93794408542Zhongxing Xu RegionOffset getAsOffset() const; 155e888233f6b115d3b0dd73bcb5f35e93794408542Zhongxing Xu 1563d7c44e01d568e5d5c0fac9c6ccb3f080157ba19Anna Zaks /// \brief Get a string representation of a region for debug use. 1573d7c44e01d568e5d5c0fac9c6ccb3f080157ba19Anna Zaks std::string getString() const; 1583d7c44e01d568e5d5c0fac9c6ccb3f080157ba19Anna Zaks 1599c378f705405d37f49795d5e915989de774fe11fTed Kremenek virtual void dumpToStream(raw_ostream &os) const; 1607f39d29cb69e7488f994870800d548008e50e1cbTed Kremenek 1618800ad4eaa1621f6d23c8264971063b9f8da6a2eTed Kremenek void dump() const; 1621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 163919e8a1c6698bfa6848571d366430126bced727dJordan Rose /// \brief Returns true if this region can be printed in a user-friendly way. 164919e8a1c6698bfa6848571d366430126bced727dJordan Rose virtual bool canPrintPretty() const; 165919e8a1c6698bfa6848571d366430126bced727dJordan Rose 1663d7c44e01d568e5d5c0fac9c6ccb3f080157ba19Anna Zaks /// \brief Print the region for use in diagnostics. 167919e8a1c6698bfa6848571d366430126bced727dJordan Rose virtual void printPretty(raw_ostream &os) const; 1683d7c44e01d568e5d5c0fac9c6ccb3f080157ba19Anna Zaks 1691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump Kind getKind() const { return kind; } 1701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 171ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek template<typename RegionTy> const RegionTy* getAs() const; 1721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 173f0f0605c87739c906861f73d4287798a4969b1e0Zhongxing Xu virtual bool isBoundable() const { return false; } 174b21ff77c8126ea628b66d2ffb931fdaa7884f5d2Zhongxing Xu 1759e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek static bool classof(const MemRegion*) { return true; } 1769e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek}; 1771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 178eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks/// MemSpaceRegion - A memory region that represents a "memory space"; 1799e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek/// for example, the set of global variables, the stack frame, etc. 1809e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekclass MemSpaceRegion : public MemRegion { 181a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenekprotected: 18267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek friend class MemRegionManager; 18367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek 184a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek MemRegionManager *Mgr; 185a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek 18667d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek MemSpaceRegion(MemRegionManager *mgr, Kind k = GenericMemSpaceRegionKind) 18767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek : MemRegion(k), Mgr(mgr) { 18867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek assert(classof(this)); 18967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 19067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek 19167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek MemRegionManager* getMemRegionManager() const { return Mgr; } 1921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 19367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenekpublic: 19467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek bool isBoundable() const { return false; } 19567d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek 19667d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek void Profile(llvm::FoldingSetNodeID &ID) const; 19767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek 19867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek static bool classof(const MemRegion *R) { 19967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek Kind k = R->getKind(); 20067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek return k >= BEG_MEMSPACES && k <= END_MEMSPACES; 201a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek } 20267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek}; 20367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek 20467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenekclass GlobalsSpaceRegion : public MemSpaceRegion { 20599ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 206dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenekprotected: 207dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek GlobalsSpaceRegion(MemRegionManager *mgr, Kind k) 208dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek : MemSpaceRegion(mgr, k) {} 209dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenekpublic: 210dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek static bool classof(const MemRegion *R) { 211dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek Kind k = R->getKind(); 212dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek return k >= BEG_GLOBAL_MEMSPACES && k <= END_GLOBAL_MEMSPACES; 213dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek } 214dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek}; 215eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks 216914edfbb07c34d8cad8d0451193b4f9dd02a2d5aDavid Blaikie/// \brief The region of the static variables within the current CodeTextRegion 217eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks/// scope. 218914edfbb07c34d8cad8d0451193b4f9dd02a2d5aDavid Blaikie/// 219eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks/// Currently, only the static locals are placed there, so we know that these 220eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks/// variables do not get invalidated by calls to other functions. 221dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenekclass StaticGlobalSpaceRegion : public GlobalsSpaceRegion { 22267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek friend class MemRegionManager; 223a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek 224dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek const CodeTextRegion *CR; 225dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 226dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek StaticGlobalSpaceRegion(MemRegionManager *mgr, const CodeTextRegion *cr) 227dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek : GlobalsSpaceRegion(mgr, StaticGlobalSpaceRegionKind), CR(cr) {} 228dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 229dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenekpublic: 230dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek void Profile(llvm::FoldingSetNodeID &ID) const; 231dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 2329c378f705405d37f49795d5e915989de774fe11fTed Kremenek void dumpToStream(raw_ostream &os) const; 233fa87d812d7c78d7f0cd1c5636e21e07c23c85341Ted Kremenek 234dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek const CodeTextRegion *getCodeRegion() const { return CR; } 235dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 236dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek static bool classof(const MemRegion *R) { 237dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek return R->getKind() == StaticGlobalSpaceRegionKind; 238dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek } 239dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek}; 240eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks 241914edfbb07c34d8cad8d0451193b4f9dd02a2d5aDavid Blaikie/// \brief The region for all the non-static global variables. 242eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks/// 243eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks/// This class is further split into subclasses for efficient implementation of 244eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks/// invalidating a set of related global values as is done in 245eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks/// RegionStoreManager::invalidateRegions (instead of finding all the dependent 246eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks/// globals, we invalidate the whole parent region). 247dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenekclass NonStaticGlobalSpaceRegion : public GlobalsSpaceRegion { 248dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek friend class MemRegionManager; 249dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 250eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaksprotected: 251eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks NonStaticGlobalSpaceRegion(MemRegionManager *mgr, Kind k) 252eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks : GlobalsSpaceRegion(mgr, k) {} 253dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek 2549e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekpublic: 255fa87d812d7c78d7f0cd1c5636e21e07c23c85341Ted Kremenek 25667d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek static bool classof(const MemRegion *R) { 257eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks Kind k = R->getKind(); 258eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks return k >= BEG_NON_STATIC_GLOBAL_MEMSPACES && 259eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks k <= END_NON_STATIC_GLOBAL_MEMSPACES; 26067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 26167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek}; 262eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks 263914edfbb07c34d8cad8d0451193b4f9dd02a2d5aDavid Blaikie/// \brief The region containing globals which are defined in system/external 264eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks/// headers and are considered modifiable by system calls (ex: errno). 265eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaksclass GlobalSystemSpaceRegion : public NonStaticGlobalSpaceRegion { 266eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks friend class MemRegionManager; 267eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks 268eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks GlobalSystemSpaceRegion(MemRegionManager *mgr) 269eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks : NonStaticGlobalSpaceRegion(mgr, GlobalSystemSpaceRegionKind) {} 270eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks 271eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zakspublic: 272eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks 273eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks void dumpToStream(raw_ostream &os) const; 274eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks 275eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks static bool classof(const MemRegion *R) { 276eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks return R->getKind() == GlobalSystemSpaceRegionKind; 277eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks } 278eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks}; 279eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks 280914edfbb07c34d8cad8d0451193b4f9dd02a2d5aDavid Blaikie/// \brief The region containing globals which are considered not to be modified 281eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks/// or point to data which could be modified as a result of a function call 282eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks/// (system or internal). Ex: Const global scalars would be modeled as part of 283eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks/// this region. This region also includes most system globals since they have 284eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks/// low chance of being modified. 285eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaksclass GlobalImmutableSpaceRegion : public NonStaticGlobalSpaceRegion { 286eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks friend class MemRegionManager; 287eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks 288eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks GlobalImmutableSpaceRegion(MemRegionManager *mgr) 289eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks : NonStaticGlobalSpaceRegion(mgr, GlobalImmutableSpaceRegionKind) {} 290eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks 291eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zakspublic: 292eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks 293eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks void dumpToStream(raw_ostream &os) const; 294eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks 295eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks static bool classof(const MemRegion *R) { 296eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks return R->getKind() == GlobalImmutableSpaceRegionKind; 297eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks } 298eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks}; 299eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks 300914edfbb07c34d8cad8d0451193b4f9dd02a2d5aDavid Blaikie/// \brief The region containing globals which can be modified by calls to 301eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks/// "internally" defined functions - (for now just) functions other then system 302eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks/// calls. 303eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaksclass GlobalInternalSpaceRegion : public NonStaticGlobalSpaceRegion { 304eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks friend class MemRegionManager; 305eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks 306eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks GlobalInternalSpaceRegion(MemRegionManager *mgr) 307eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks : NonStaticGlobalSpaceRegion(mgr, GlobalInternalSpaceRegionKind) {} 308eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks 309eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zakspublic: 310eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks 311eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks void dumpToStream(raw_ostream &os) const; 312eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks 313eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks static bool classof(const MemRegion *R) { 314eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks return R->getKind() == GlobalInternalSpaceRegionKind; 315eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks } 316eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks}; 317eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks 31867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenekclass HeapSpaceRegion : public MemSpaceRegion { 31999ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 32067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek friend class MemRegionManager; 32167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek 32267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek HeapSpaceRegion(MemRegionManager *mgr) 32367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek : MemSpaceRegion(mgr, HeapSpaceRegionKind) {} 32467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenekpublic: 32536397dc6c1bf1513a3bac4eabe9209e5b2295a55Jordan Rose 32636397dc6c1bf1513a3bac4eabe9209e5b2295a55Jordan Rose void dumpToStream(raw_ostream &os) const; 32736397dc6c1bf1513a3bac4eabe9209e5b2295a55Jordan Rose 32867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek static bool classof(const MemRegion *R) { 32967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek return R->getKind() == HeapSpaceRegionKind; 33067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 33167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek}; 33267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek 3332b87ae45e129b941d0a4d221c9d4842385a119bdTed Kremenekclass UnknownSpaceRegion : public MemSpaceRegion { 33499ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 3352b87ae45e129b941d0a4d221c9d4842385a119bdTed Kremenek friend class MemRegionManager; 3362b87ae45e129b941d0a4d221c9d4842385a119bdTed Kremenek UnknownSpaceRegion(MemRegionManager *mgr) 3372b87ae45e129b941d0a4d221c9d4842385a119bdTed Kremenek : MemSpaceRegion(mgr, UnknownSpaceRegionKind) {} 3382b87ae45e129b941d0a4d221c9d4842385a119bdTed Kremenekpublic: 33936397dc6c1bf1513a3bac4eabe9209e5b2295a55Jordan Rose 34036397dc6c1bf1513a3bac4eabe9209e5b2295a55Jordan Rose void dumpToStream(raw_ostream &os) const; 34136397dc6c1bf1513a3bac4eabe9209e5b2295a55Jordan Rose 3422b87ae45e129b941d0a4d221c9d4842385a119bdTed Kremenek static bool classof(const MemRegion *R) { 3432b87ae45e129b941d0a4d221c9d4842385a119bdTed Kremenek return R->getKind() == UnknownSpaceRegionKind; 3442b87ae45e129b941d0a4d221c9d4842385a119bdTed Kremenek } 3452b87ae45e129b941d0a4d221c9d4842385a119bdTed Kremenek}; 3462b87ae45e129b941d0a4d221c9d4842385a119bdTed Kremenek 34767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenekclass StackSpaceRegion : public MemSpaceRegion { 34867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenekprivate: 34967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const StackFrameContext *SFC; 3509e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek 35167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenekprotected: 35267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek StackSpaceRegion(MemRegionManager *mgr, Kind k, const StackFrameContext *sfc) 35367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek : MemSpaceRegion(mgr, k), SFC(sfc) { 35467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek assert(classof(this)); 35567d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 35641168eac256fed59ec5406a75fce91c59cd5dd91Ted Kremenek 35767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenekpublic: 35867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const StackFrameContext *getStackFrame() const { return SFC; } 35967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek 36067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek void Profile(llvm::FoldingSetNodeID &ID) const; 36167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek 36267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek static bool classof(const MemRegion *R) { 36367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek Kind k = R->getKind(); 36467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek return k >= StackLocalsSpaceRegionKind && 36567d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek k <= StackArgumentsSpaceRegionKind; 36667d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 36767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek}; 36867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek 36967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenekclass StackLocalsSpaceRegion : public StackSpaceRegion { 37099ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 37167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek friend class MemRegionManager; 37267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek StackLocalsSpaceRegion(MemRegionManager *mgr, const StackFrameContext *sfc) 37367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek : StackSpaceRegion(mgr, StackLocalsSpaceRegionKind, sfc) {} 37467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenekpublic: 37536397dc6c1bf1513a3bac4eabe9209e5b2295a55Jordan Rose 37636397dc6c1bf1513a3bac4eabe9209e5b2295a55Jordan Rose void dumpToStream(raw_ostream &os) const; 37736397dc6c1bf1513a3bac4eabe9209e5b2295a55Jordan Rose 37867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek static bool classof(const MemRegion *R) { 37967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek return R->getKind() == StackLocalsSpaceRegionKind; 38067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek } 38167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek}; 38267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek 38367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenekclass StackArgumentsSpaceRegion : public StackSpaceRegion { 38467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenekprivate: 38599ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 38667d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek friend class MemRegionManager; 38767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek StackArgumentsSpaceRegion(MemRegionManager *mgr, const StackFrameContext *sfc) 38867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek : StackSpaceRegion(mgr, StackArgumentsSpaceRegionKind, sfc) {} 38967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenekpublic: 39036397dc6c1bf1513a3bac4eabe9209e5b2295a55Jordan Rose 39136397dc6c1bf1513a3bac4eabe9209e5b2295a55Jordan Rose void dumpToStream(raw_ostream &os) const; 39236397dc6c1bf1513a3bac4eabe9209e5b2295a55Jordan Rose 39367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek static bool classof(const MemRegion *R) { 39467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek return R->getKind() == StackArgumentsSpaceRegionKind; 3959e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek } 3969e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek}; 3979e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek 3987caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xu 399993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek/// SubRegion - A region that subsets another larger region. Most regions 400993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek/// are subclasses of SubRegion. 401993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenekclass SubRegion : public MemRegion { 40299ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikieprivate: 40399ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 4049e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekprotected: 4051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const MemRegion* superRegion; 406993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek SubRegion(const MemRegion* sReg, Kind k) : MemRegion(k), superRegion(sReg) {} 4079e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekpublic: 4089e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek const MemRegion* getSuperRegion() const { 4099e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek return superRegion; 4109e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek } 4111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 41232f2656b90900ac04c4b50e87c16749d0ceb9ef2Jordy Rose /// getExtent - Returns the size of the region in bytes. 413c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek virtual DefinedOrUnknownSVal getExtent(SValBuilder &svalBuilder) const { 41432f2656b90900ac04c4b50e87c16749d0ceb9ef2Jordy Rose return UnknownVal(); 41532f2656b90900ac04c4b50e87c16749d0ceb9ef2Jordy Rose } 41632f2656b90900ac04c4b50e87c16749d0ceb9ef2Jordy Rose 417a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek MemRegionManager* getMemRegionManager() const; 4181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4197e5d6ed47dcedce35043de59ee00464b681bc786Zhongxing Xu bool isSubRegionOf(const MemRegion* R) const; 4201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4219e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek static bool classof(const MemRegion* R) { 42267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek return R->getKind() > END_MEMSPACES; 423993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek } 424993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek}; 4251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 42619e1f0ba5cec738ce6cebe3fe0e1edc782206494Ted Kremenek//===----------------------------------------------------------------------===// 42719e1f0ba5cec738ce6cebe3fe0e1edc782206494Ted Kremenek// MemRegion subclasses. 4281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump//===----------------------------------------------------------------------===// 429ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu 43082bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek/// AllocaRegion - A region that represents an untyped blob of bytes created 43182bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek/// by a call to 'alloca'. 43282bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenekclass AllocaRegion : public SubRegion { 43382bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek friend class MemRegionManager; 43482bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenekprotected: 43582bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek unsigned Cnt; // Block counter. Used to distinguish different pieces of 43682bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek // memory allocated by alloca at the same call site. 4379c378f705405d37f49795d5e915989de774fe11fTed Kremenek const Expr *Ex; 43882bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek 4399c378f705405d37f49795d5e915989de774fe11fTed Kremenek AllocaRegion(const Expr *ex, unsigned cnt, const MemRegion *superRegion) 44082bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek : SubRegion(superRegion, AllocaRegionKind), Cnt(cnt), Ex(ex) {} 4411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 44282bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenekpublic: 4431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4449c378f705405d37f49795d5e915989de774fe11fTed Kremenek const Expr *getExpr() const { return Ex; } 4459852b5bf94d4934de63da6356c651c61e81f58d9Zhongxing Xu 4469852b5bf94d4934de63da6356c651c61e81f58d9Zhongxing Xu bool isBoundable() const { return true; } 4479852b5bf94d4934de63da6356c651c61e81f58d9Zhongxing Xu 448c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek DefinedOrUnknownSVal getExtent(SValBuilder &svalBuilder) const; 44932f2656b90900ac04c4b50e87c16749d0ceb9ef2Jordy Rose 45082bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek void Profile(llvm::FoldingSetNodeID& ID) const; 45182bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek 4529c378f705405d37f49795d5e915989de774fe11fTed Kremenek static void ProfileRegion(llvm::FoldingSetNodeID& ID, const Expr *Ex, 4537ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek unsigned Cnt, const MemRegion *superRegion); 4541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4559c378f705405d37f49795d5e915989de774fe11fTed Kremenek void dumpToStream(raw_ostream &os) const; 4561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 45782bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek static bool classof(const MemRegion* R) { 45882bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek return R->getKind() == AllocaRegionKind; 45982bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek } 4601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump}; 4611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 462993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek/// TypedRegion - An abstract class representing regions that are typed. 463993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenekclass TypedRegion : public SubRegion { 46499ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikiepublic: 46599ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 466993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenekprotected: 467993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek TypedRegion(const MemRegion* sReg, Kind k) : SubRegion(sReg, k) {} 4681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 469993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenekpublic: 4709697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek virtual QualType getLocationType() const = 0; 4719697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek 4729697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek QualType getDesugaredLocationType(ASTContext &Context) const { 4739697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek return getLocationType().getDesugaredType(Context); 4749697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek } 4759697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek 4769697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek bool isBoundable() const { return true; } 4779697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek 4789697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek static bool classof(const MemRegion* R) { 4799697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek unsigned k = R->getKind(); 4809697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek return k >= BEG_TYPED_REGIONS && k <= END_TYPED_REGIONS; 4819697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek } 4829697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek}; 4839697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek 4849697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek/// TypedValueRegion - An abstract class representing regions having a typed value. 4859697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenekclass TypedValueRegion : public TypedRegion { 48699ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikiepublic: 48799ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 4889697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenekprotected: 4899697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek TypedValueRegion(const MemRegion* sReg, Kind k) : TypedRegion(sReg, k) {} 4909697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek 4919697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenekpublic: 492018220c343c103b7dfaa117a7a474c7a7fd6d068Zhongxing Xu virtual QualType getValueType() const = 0; 4931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 494018220c343c103b7dfaa117a7a474c7a7fd6d068Zhongxing Xu virtual QualType getLocationType() const { 4956eddeb153415049c7b62de4b45385a759a6906c6Ted Kremenek // FIXME: We can possibly optimize this later to cache this value. 496a6b0b96e5376cd9cf182a3e240e0537feed43cdeTed Kremenek QualType T = getValueType(); 497a6b0b96e5376cd9cf182a3e240e0537feed43cdeTed Kremenek ASTContext &ctx = getContext(); 498a6b0b96e5376cd9cf182a3e240e0537feed43cdeTed Kremenek if (T->getAs<ObjCObjectType>()) 499a6b0b96e5376cd9cf182a3e240e0537feed43cdeTed Kremenek return ctx.getObjCObjectPointerType(T); 500a6b0b96e5376cd9cf182a3e240e0537feed43cdeTed Kremenek return ctx.getPointerType(getValueType()); 5016eddeb153415049c7b62de4b45385a759a6906c6Ted Kremenek } 5021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 50349f4e1cbd839da27ff4814b4ea6d85a79f786cbdJohn McCall QualType getDesugaredValueType(ASTContext &Context) const { 504018220c343c103b7dfaa117a7a474c7a7fd6d068Zhongxing Xu QualType T = getValueType(); 5051ab55e9bb87d98bff1d42c7a0ee502c64755d9f5Douglas Gregor return T.getTypePtrOrNull() ? T.getDesugaredType(Context) : T; 50614553abd17d303b0b310b3ab1523eb0d30d8121cTed Kremenek } 5071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 508e0d24eb1060a213ec9820dc02c45f26b2d5b348bJordan Rose DefinedOrUnknownSVal getExtent(SValBuilder &svalBuilder) const; 509e0d24eb1060a213ec9820dc02c45f26b2d5b348bJordan Rose 510993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek static bool classof(const MemRegion* R) { 5119e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek unsigned k = R->getKind(); 5129697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek return k >= BEG_TYPED_VALUE_REGIONS && k <= END_TYPED_VALUE_REGIONS; 5139e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek } 5149e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek}; 5159e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek 516ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu 517eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenekclass CodeTextRegion : public TypedRegion { 51899ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikiepublic: 51999ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 520eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenekprotected: 521eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek CodeTextRegion(const MemRegion *sreg, Kind k) : TypedRegion(sreg, k) {} 522ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xupublic: 523eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek bool isBoundable() const { return false; } 524eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek 525eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek static bool classof(const MemRegion* R) { 526eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek Kind k = R->getKind(); 527eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek return k >= FunctionTextRegionKind && k <= BlockTextRegionKind; 528eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek } 529eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek}; 530ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu 531eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek/// FunctionTextRegion - A region that represents code texts of function. 532eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenekclass FunctionTextRegion : public CodeTextRegion { 533eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek const FunctionDecl *FD; 534eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenekpublic: 5359c378f705405d37f49795d5e915989de774fe11fTed Kremenek FunctionTextRegion(const FunctionDecl *fd, const MemRegion* sreg) 536eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek : CodeTextRegion(sreg, FunctionTextRegionKind), FD(fd) {} 537eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek 538018220c343c103b7dfaa117a7a474c7a7fd6d068Zhongxing Xu QualType getLocationType() const { 539018220c343c103b7dfaa117a7a474c7a7fd6d068Zhongxing Xu return getContext().getPointerType(FD->getType()); 540ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu } 541eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek 542abd46e13cfd48f2c9bf26d9759edb4366aaa6d5bTed Kremenek const FunctionDecl *getDecl() const { 543abd46e13cfd48f2c9bf26d9759edb4366aaa6d5bTed Kremenek return FD; 54472e032004b0d2c2c298e8e4f7027f23a21c0cc7dTed Kremenek } 545eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek 5469c378f705405d37f49795d5e915989de774fe11fTed Kremenek virtual void dumpToStream(raw_ostream &os) const; 547eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek 548ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu void Profile(llvm::FoldingSetNodeID& ID) const; 549eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek 550abd46e13cfd48f2c9bf26d9759edb4366aaa6d5bTed Kremenek static void ProfileRegion(llvm::FoldingSetNodeID& ID, const FunctionDecl *FD, 551abd46e13cfd48f2c9bf26d9759edb4366aaa6d5bTed Kremenek const MemRegion*); 552eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek 553ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu static bool classof(const MemRegion* R) { 554eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek return R->getKind() == FunctionTextRegionKind; 555eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek } 556eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek}; 557eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek 558eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek 559eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek/// BlockTextRegion - A region that represents code texts of blocks (closures). 5600a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek/// Blocks are represented with two kinds of regions. BlockTextRegions 5610a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek/// represent the "code", while BlockDataRegions represent instances of blocks, 5620a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek/// which correspond to "code+data". The distinction is important, because 5630a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek/// like a closure a block captures the values of externally referenced 5640a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek/// variables. 565eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenekclass BlockTextRegion : public CodeTextRegion { 56667d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek friend class MemRegionManager; 56767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek 568eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek const BlockDecl *BD; 5691d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek AnalysisDeclContext *AC; 570eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek CanQualType locTy; 57167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek 57267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek BlockTextRegion(const BlockDecl *bd, CanQualType lTy, 5731d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek AnalysisDeclContext *ac, const MemRegion* sreg) 57467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek : CodeTextRegion(sreg, BlockTextRegionKind), BD(bd), AC(ac), locTy(lTy) {} 57567d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek 57667d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenekpublic: 577018220c343c103b7dfaa117a7a474c7a7fd6d068Zhongxing Xu QualType getLocationType() const { 578eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek return locTy; 579eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek } 580eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek 581eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek const BlockDecl *getDecl() const { 582eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek return BD; 583eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek } 58467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek 5851d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek AnalysisDeclContext *getAnalysisDeclContext() const { return AC; } 586eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek 5879c378f705405d37f49795d5e915989de774fe11fTed Kremenek virtual void dumpToStream(raw_ostream &os) const; 588eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek 589eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek void Profile(llvm::FoldingSetNodeID& ID) const; 590eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek 591eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek static void ProfileRegion(llvm::FoldingSetNodeID& ID, const BlockDecl *BD, 5921d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek CanQualType, const AnalysisDeclContext*, 59367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const MemRegion*); 594eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek 595eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek static bool classof(const MemRegion* R) { 596eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek return R->getKind() == BlockTextRegionKind; 597ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu } 598ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu}; 5990a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek 6000a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek/// BlockDataRegion - A region that represents a block instance. 6010a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek/// Blocks are represented with two kinds of regions. BlockTextRegions 6020a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek/// represent the "code", while BlockDataRegions represent instances of blocks, 6030a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek/// which correspond to "code+data". The distinction is important, because 6040a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek/// like a closure a block captures the values of externally referenced 6050a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek/// variables. 6068ecf59afbab1dbf184dc4c0c47e7213cbd32ba0aJordan Roseclass BlockDataRegion : public TypedRegion { 60767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek friend class MemRegionManager; 6080a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek const BlockTextRegion *BC; 60967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const LocationContext *LC; // Can be null */ 6104240096011a187807058f887eb81df750ffa17feTed Kremenek void *ReferencedVars; 61185d87df66a50a15a1957f7213802000b451a8ec9Ted Kremenek void *OriginalVars; 61267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek 61367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek BlockDataRegion(const BlockTextRegion *bc, const LocationContext *lc, 6140a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek const MemRegion *sreg) 6158ecf59afbab1dbf184dc4c0c47e7213cbd32ba0aJordan Rose : TypedRegion(sreg, BlockDataRegionKind), BC(bc), LC(lc), 61685d87df66a50a15a1957f7213802000b451a8ec9Ted Kremenek ReferencedVars(0), OriginalVars(0) {} 6170a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek 61885d87df66a50a15a1957f7213802000b451a8ec9Ted Kremenekpublic: 6190a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek const BlockTextRegion *getCodeRegion() const { return BC; } 6204240096011a187807058f887eb81df750ffa17feTed Kremenek 621d02e83a548359df978f40cc1a52ffd78b7ef371bTed Kremenek const BlockDecl *getDecl() const { return BC->getDecl(); } 6228ecf59afbab1dbf184dc4c0c47e7213cbd32ba0aJordan Rose 6238ecf59afbab1dbf184dc4c0c47e7213cbd32ba0aJordan Rose QualType getLocationType() const { return BC->getLocationType(); } 624d02e83a548359df978f40cc1a52ffd78b7ef371bTed Kremenek 62581cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek class referenced_vars_iterator { 62681cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek const MemRegion * const *R; 62785d87df66a50a15a1957f7213802000b451a8ec9Ted Kremenek const MemRegion * const *OriginalR; 62881cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek public: 62985d87df66a50a15a1957f7213802000b451a8ec9Ted Kremenek explicit referenced_vars_iterator(const MemRegion * const *r, 63085d87df66a50a15a1957f7213802000b451a8ec9Ted Kremenek const MemRegion * const *originalR) 63185d87df66a50a15a1957f7213802000b451a8ec9Ted Kremenek : R(r), OriginalR(originalR) {} 63281cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek 63381cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek operator const MemRegion * const *() const { 63481cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek return R; 63581cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek } 63685d87df66a50a15a1957f7213802000b451a8ec9Ted Kremenek 63785d87df66a50a15a1957f7213802000b451a8ec9Ted Kremenek const MemRegion *getCapturedRegion() const { 63885d87df66a50a15a1957f7213802000b451a8ec9Ted Kremenek return *R; 63985d87df66a50a15a1957f7213802000b451a8ec9Ted Kremenek } 64085d87df66a50a15a1957f7213802000b451a8ec9Ted Kremenek const MemRegion *getOriginalRegion() const { 64185d87df66a50a15a1957f7213802000b451a8ec9Ted Kremenek return *OriginalR; 64285d87df66a50a15a1957f7213802000b451a8ec9Ted Kremenek } 64385d87df66a50a15a1957f7213802000b451a8ec9Ted Kremenek 64481cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek const VarRegion* operator*() const { 64581cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek return cast<VarRegion>(*R); 64681cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek } 64781cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek 64881cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek bool operator==(const referenced_vars_iterator &I) const { 64981cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek return I.R == R; 65081cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek } 65181cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek bool operator!=(const referenced_vars_iterator &I) const { 65281cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek return I.R != R; 65381cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek } 6549c378f705405d37f49795d5e915989de774fe11fTed Kremenek referenced_vars_iterator &operator++() { 65581cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek ++R; 65685d87df66a50a15a1957f7213802000b451a8ec9Ted Kremenek ++OriginalR; 65781cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek return *this; 65881cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek } 65981cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek }; 66081cef5889027d0f96b24afa7a0bb28d9023474edTed Kremenek 6614240096011a187807058f887eb81df750ffa17feTed Kremenek referenced_vars_iterator referenced_vars_begin() const; 6624240096011a187807058f887eb81df750ffa17feTed Kremenek referenced_vars_iterator referenced_vars_end() const; 6630a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek 6649c378f705405d37f49795d5e915989de774fe11fTed Kremenek virtual void dumpToStream(raw_ostream &os) const; 6650a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek 6660a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek void Profile(llvm::FoldingSetNodeID& ID) const; 6670a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek 66867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek static void ProfileRegion(llvm::FoldingSetNodeID&, const BlockTextRegion *, 66967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const LocationContext *, const MemRegion *); 6700a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek 6710a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek static bool classof(const MemRegion* R) { 6720a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek return R->getKind() == BlockDataRegionKind; 6730a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek } 6744240096011a187807058f887eb81df750ffa17feTed Kremenekprivate: 6754240096011a187807058f887eb81df750ffa17feTed Kremenek void LazyInitializeReferencedVars(); 6760a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek}; 677ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu 678026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu/// SymbolicRegion - A special, "non-concrete" region. Unlike other region 679026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu/// clases, SymbolicRegion represents a region that serves as an alias for 680026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu/// either a real region, a NULL pointer, etc. It essentially is used to 681026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu/// map the concept of symbolic values into the domain of regions. Symbolic 682026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu/// regions do not need to be typed. 683e8e86482da4c1872673bbb9c237649229d19793bTed Kremenekclass SymbolicRegion : public SubRegion { 684026c66395b88a09437319139a43b090093f7e1ddZhongxing Xuprotected: 685026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu const SymbolRef sym; 686026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu 687026c66395b88a09437319139a43b090093f7e1ddZhongxing Xupublic: 6881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump SymbolicRegion(const SymbolRef s, const MemRegion* sreg) 689e8e86482da4c1872673bbb9c237649229d19793bTed Kremenek : SubRegion(sreg, SymbolicRegionKind), sym(s) {} 6901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 691026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu SymbolRef getSymbol() const { 692026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu return sym; 693026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu } 694026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu 6959852b5bf94d4934de63da6356c651c61e81f58d9Zhongxing Xu bool isBoundable() const { return true; } 6969852b5bf94d4934de63da6356c651c61e81f58d9Zhongxing Xu 697c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek DefinedOrUnknownSVal getExtent(SValBuilder &svalBuilder) const; 69832f2656b90900ac04c4b50e87c16749d0ceb9ef2Jordy Rose 699026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu void Profile(llvm::FoldingSetNodeID& ID) const; 700026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu 701250101353b711a409b075f1bc11070dddec7100bTed Kremenek static void ProfileRegion(llvm::FoldingSetNodeID& ID, 702250101353b711a409b075f1bc11070dddec7100bTed Kremenek SymbolRef sym, 703250101353b711a409b075f1bc11070dddec7100bTed Kremenek const MemRegion* superRegion); 7041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7059c378f705405d37f49795d5e915989de774fe11fTed Kremenek void dumpToStream(raw_ostream &os) const; 7061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 707026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu static bool classof(const MemRegion* R) { 708026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu return R->getKind() == SymbolicRegionKind; 709026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu } 7101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump}; 711026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu 712e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu/// StringRegion - Region associated with a StringLiteral. 7139697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenekclass StringRegion : public TypedValueRegion { 714e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu friend class MemRegionManager; 715e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu const StringLiteral* Str; 716e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xuprotected: 717e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu 718250101353b711a409b075f1bc11070dddec7100bTed Kremenek StringRegion(const StringLiteral* str, const MemRegion* sreg) 7199697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek : TypedValueRegion(sreg, StringRegionKind), Str(str) {} 720e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu 721e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu static void ProfileRegion(llvm::FoldingSetNodeID& ID, 722e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu const StringLiteral* Str, 723e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu const MemRegion* superRegion); 724e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu 725e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xupublic: 7266613d08a19aa6ce9b6330487f3bfac841d4b8a4dZhongxing Xu 7276613d08a19aa6ce9b6330487f3bfac841d4b8a4dZhongxing Xu const StringLiteral* getStringLiteral() const { return Str; } 7281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 729018220c343c103b7dfaa117a7a474c7a7fd6d068Zhongxing Xu QualType getValueType() const { 730ff6978263439e21d795b0602fabcb38488ef8441Zhongxing Xu return Str->getType(); 731ff6978263439e21d795b0602fabcb38488ef8441Zhongxing Xu } 732e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu 733c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek DefinedOrUnknownSVal getExtent(SValBuilder &svalBuilder) const; 73432f2656b90900ac04c4b50e87c16749d0ceb9ef2Jordy Rose 7350a51f1c6cec6032bcf64ce205bc4edfdc3cb3a2fZhongxing Xu bool isBoundable() const { return false; } 7360a51f1c6cec6032bcf64ce205bc4edfdc3cb3a2fZhongxing Xu 737e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu void Profile(llvm::FoldingSetNodeID& ID) const { 738e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu ProfileRegion(ID, Str, superRegion); 739e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu } 740e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu 7419c378f705405d37f49795d5e915989de774fe11fTed Kremenek void dumpToStream(raw_ostream &os) const; 742cc128b32429494fe04ed36d7ba30c011cb4e173aZhongxing Xu 743e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu static bool classof(const MemRegion* R) { 744e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu return R->getKind() == StringRegionKind; 745e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu } 746e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu}; 7474c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek 7484c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek/// The region associated with an ObjCStringLiteral. 7494c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenekclass ObjCStringRegion : public TypedValueRegion { 7504c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek friend class MemRegionManager; 7514c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek const ObjCStringLiteral* Str; 7524c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenekprotected: 7534c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek 7544c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek ObjCStringRegion(const ObjCStringLiteral* str, const MemRegion* sreg) 7554c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek : TypedValueRegion(sreg, ObjCStringRegionKind), Str(str) {} 7564c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek 7574c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek static void ProfileRegion(llvm::FoldingSetNodeID& ID, 7584c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek const ObjCStringLiteral* Str, 7594c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek const MemRegion* superRegion); 7604c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek 7614c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenekpublic: 7624c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek 7634c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek const ObjCStringLiteral* getObjCStringLiteral() const { return Str; } 7644c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek 7654c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek QualType getValueType() const { 7664c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek return Str->getType(); 7674c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek } 7684c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek 7694c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek bool isBoundable() const { return false; } 7704c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek 7714c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek void Profile(llvm::FoldingSetNodeID& ID) const { 7724c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek ProfileRegion(ID, Str, superRegion); 7734c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek } 7744c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek 7754c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek void dumpToStream(raw_ostream &os) const; 7764c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek 7774c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek static bool classof(const MemRegion* R) { 7784c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek return R->getKind() == ObjCStringRegionKind; 7794c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek } 7804c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek}; 781e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu 782329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek/// CompoundLiteralRegion - A memory region representing a compound literal. 783329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek/// Compound literals are essentially temporaries that are stack allocated 784329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek/// or in the global constant pool. 7859697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenekclass CompoundLiteralRegion : public TypedValueRegion { 786329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenekprivate: 787329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek friend class MemRegionManager; 7889c378f705405d37f49795d5e915989de774fe11fTed Kremenek const CompoundLiteralExpr *CL; 789329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek 7909c378f705405d37f49795d5e915989de774fe11fTed Kremenek CompoundLiteralRegion(const CompoundLiteralExpr *cl, const MemRegion* sReg) 7919697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek : TypedValueRegion(sReg, CompoundLiteralRegionKind), CL(cl) {} 7921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 793329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek static void ProfileRegion(llvm::FoldingSetNodeID& ID, 7949c378f705405d37f49795d5e915989de774fe11fTed Kremenek const CompoundLiteralExpr *CL, 795329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek const MemRegion* superRegion); 796329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenekpublic: 797018220c343c103b7dfaa117a7a474c7a7fd6d068Zhongxing Xu QualType getValueType() const { 798018220c343c103b7dfaa117a7a474c7a7fd6d068Zhongxing Xu return CL->getType(); 79977cfac623178d0c16e16e2f171d20b0fea8fde30Zhongxing Xu } 8000a51f1c6cec6032bcf64ce205bc4edfdc3cb3a2fZhongxing Xu 8019a08fee80a34938b8c11c7166e009a89ced4c2b4Zhongxing Xu bool isBoundable() const { return !CL->isFileScope(); } 8029a08fee80a34938b8c11c7166e009a89ced4c2b4Zhongxing Xu 803329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek void Profile(llvm::FoldingSetNodeID& ID) const; 8041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8059c378f705405d37f49795d5e915989de774fe11fTed Kremenek void dumpToStream(raw_ostream &os) const; 806329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek 8079c378f705405d37f49795d5e915989de774fe11fTed Kremenek const CompoundLiteralExpr *getLiteralExpr() const { return CL; } 8081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 809329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek static bool classof(const MemRegion* R) { 810329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek return R->getKind() == CompoundLiteralRegionKind; 811329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek } 812329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek}; 813178927517fa09ddbb04dc8ef725b5716c18aae21Zhongxing Xu 8149697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenekclass DeclRegion : public TypedValueRegion { 8159e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekprotected: 8169c378f705405d37f49795d5e915989de774fe11fTed Kremenek const Decl *D; 8179e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek 8189c378f705405d37f49795d5e915989de774fe11fTed Kremenek DeclRegion(const Decl *d, const MemRegion* sReg, Kind k) 8199697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek : TypedValueRegion(sReg, k), D(d) {} 8209e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek 8219c378f705405d37f49795d5e915989de774fe11fTed Kremenek static void ProfileRegion(llvm::FoldingSetNodeID& ID, const Decl *D, 8229e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek const MemRegion* superRegion, Kind k); 8231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 824bfb6582ef46dfb33672d9621f879fc262339d704Zhongxing Xupublic: 8259c378f705405d37f49795d5e915989de774fe11fTed Kremenek const Decl *getDecl() const { return D; } 8269e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek void Profile(llvm::FoldingSetNodeID& ID) const; 8271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 828e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu static bool classof(const MemRegion* R) { 829e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu unsigned k = R->getKind(); 83067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek return k >= BEG_DECL_REGIONS && k <= END_DECL_REGIONS; 831e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu } 8329e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek}; 8331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8349e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekclass VarRegion : public DeclRegion { 8359e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek friend class MemRegionManager; 836d17da2b99f323fa91b01e1dd119cc32e0ee8197dTed Kremenek 837d17da2b99f323fa91b01e1dd119cc32e0ee8197dTed Kremenek // Constructors and private methods. 8389c378f705405d37f49795d5e915989de774fe11fTed Kremenek VarRegion(const VarDecl *vd, const MemRegion* sReg) 83967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek : DeclRegion(vd, sReg, VarRegionKind) {} 8409e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek 8419c378f705405d37f49795d5e915989de774fe11fTed Kremenek static void ProfileRegion(llvm::FoldingSetNodeID& ID, const VarDecl *VD, 842d17da2b99f323fa91b01e1dd119cc32e0ee8197dTed Kremenek const MemRegion *superRegion) { 8439e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek DeclRegion::ProfileRegion(ID, VD, superRegion, VarRegionKind); 8449e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek } 8451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 846d17da2b99f323fa91b01e1dd119cc32e0ee8197dTed Kremenek void Profile(llvm::FoldingSetNodeID& ID) const; 8471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stumppublic: 849d17da2b99f323fa91b01e1dd119cc32e0ee8197dTed Kremenek const VarDecl *getDecl() const { return cast<VarDecl>(D); } 8501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8515348f94abd0e9d3945da8d059b55b156967e8ff9Ted Kremenek const StackFrameContext *getStackFrame() const; 8525348f94abd0e9d3945da8d059b55b156967e8ff9Ted Kremenek 853018220c343c103b7dfaa117a7a474c7a7fd6d068Zhongxing Xu QualType getValueType() const { 8546eddeb153415049c7b62de4b45385a759a6906c6Ted Kremenek // FIXME: We can cache this if needed. 855018220c343c103b7dfaa117a7a474c7a7fd6d068Zhongxing Xu return getDecl()->getType(); 8561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 8571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8589c378f705405d37f49795d5e915989de774fe11fTed Kremenek void dumpToStream(raw_ostream &os) const; 8591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8609e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek static bool classof(const MemRegion* R) { 8619e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek return R->getKind() == VarRegionKind; 8621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 8633d7c44e01d568e5d5c0fac9c6ccb3f080157ba19Anna Zaks 864919e8a1c6698bfa6848571d366430126bced727dJordan Rose bool canPrintPretty() const; 865919e8a1c6698bfa6848571d366430126bced727dJordan Rose void printPretty(raw_ostream &os) const; 8669e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek}; 867de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek 868de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek/// CXXThisRegion - Represents the region for the implicit 'this' parameter 869de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek/// in a call to a C++ method. This region doesn't represent the object 870de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek/// referred to by 'this', but rather 'this' itself. 8719697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenekclass CXXThisRegion : public TypedValueRegion { 872de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek friend class MemRegionManager; 873de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek CXXThisRegion(const PointerType *thisPointerTy, 874de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek const MemRegion *sReg) 8759697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek : TypedValueRegion(sReg, CXXThisRegionKind), ThisPointerTy(thisPointerTy) {} 876de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek 877de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek static void ProfileRegion(llvm::FoldingSetNodeID &ID, 878de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek const PointerType *PT, 879de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek const MemRegion *sReg); 880de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek 881de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek void Profile(llvm::FoldingSetNodeID &ID) const; 882de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek 883de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenekpublic: 884018220c343c103b7dfaa117a7a474c7a7fd6d068Zhongxing Xu QualType getValueType() const { 885de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek return QualType(ThisPointerTy, 0); 886de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek } 8877caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xu 8889c378f705405d37f49795d5e915989de774fe11fTed Kremenek void dumpToStream(raw_ostream &os) const; 889de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek 890de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek static bool classof(const MemRegion* R) { 891de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek return R->getKind() == CXXThisRegionKind; 892de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek } 893de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek 894de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenekprivate: 895de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek const PointerType *ThisPointerTy; 896de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek}; 8979e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek 8989e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekclass FieldRegion : public DeclRegion { 8999e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek friend class MemRegionManager; 9009e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek 9019c378f705405d37f49795d5e915989de774fe11fTed Kremenek FieldRegion(const FieldDecl *fd, const MemRegion* sReg) 9029e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek : DeclRegion(fd, sReg, FieldRegionKind) {} 9039e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek 9044bd1eefd48c70ebef185e524d0484c00f16000cfTed Kremenekpublic: 9059c378f705405d37f49795d5e915989de774fe11fTed Kremenek const FieldDecl *getDecl() const { return cast<FieldDecl>(D); } 9061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 907018220c343c103b7dfaa117a7a474c7a7fd6d068Zhongxing Xu QualType getValueType() const { 9086eddeb153415049c7b62de4b45385a759a6906c6Ted Kremenek // FIXME: We can cache this if needed. 909018220c343c103b7dfaa117a7a474c7a7fd6d068Zhongxing Xu return getDecl()->getType(); 9101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 9114bd1eefd48c70ebef185e524d0484c00f16000cfTed Kremenek 912c8413fd03f73084a5c93028f8b4db619fc388087Ted Kremenek DefinedOrUnknownSVal getExtent(SValBuilder &svalBuilder) const; 91332f2656b90900ac04c4b50e87c16749d0ceb9ef2Jordy Rose 9149c378f705405d37f49795d5e915989de774fe11fTed Kremenek static void ProfileRegion(llvm::FoldingSetNodeID& ID, const FieldDecl *FD, 9156304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek const MemRegion* superRegion) { 9169e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek DeclRegion::ProfileRegion(ID, FD, superRegion, FieldRegionKind); 9179e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek } 9181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9199e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek static bool classof(const MemRegion* R) { 9209e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek return R->getKind() == FieldRegionKind; 9219e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek } 9223d7c44e01d568e5d5c0fac9c6ccb3f080157ba19Anna Zaks 9233d7c44e01d568e5d5c0fac9c6ccb3f080157ba19Anna Zaks void dumpToStream(raw_ostream &os) const; 924919e8a1c6698bfa6848571d366430126bced727dJordan Rose 925919e8a1c6698bfa6848571d366430126bced727dJordan Rose bool canPrintPretty() const; 926919e8a1c6698bfa6848571d366430126bced727dJordan Rose void printPretty(raw_ostream &os) const; 9279e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek}; 9281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9299e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekclass ObjCIvarRegion : public DeclRegion { 9301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9319e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek friend class MemRegionManager; 9321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 933c35fb7d67d515659ad2325b4f6ec97c9fe64fb63Benjamin Kramer ObjCIvarRegion(const ObjCIvarDecl *ivd, const MemRegion* sReg); 9349e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek 9359c378f705405d37f49795d5e915989de774fe11fTed Kremenek static void ProfileRegion(llvm::FoldingSetNodeID& ID, const ObjCIvarDecl *ivd, 936c35fb7d67d515659ad2325b4f6ec97c9fe64fb63Benjamin Kramer const MemRegion* superRegion); 9371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9389e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekpublic: 939c35fb7d67d515659ad2325b4f6ec97c9fe64fb63Benjamin Kramer const ObjCIvarDecl *getDecl() const; 940c35fb7d67d515659ad2325b4f6ec97c9fe64fb63Benjamin Kramer QualType getValueType() const; 9411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9429c378f705405d37f49795d5e915989de774fe11fTed Kremenek void dumpToStream(raw_ostream &os) const; 9431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9449e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek static bool classof(const MemRegion* R) { 9459e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek return R->getKind() == ObjCIvarRegionKind; 9469e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek } 9479e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek}; 9487caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xu//===----------------------------------------------------------------------===// 949fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner// Auxiliary data classes for use with MemRegions. 9507caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xu//===----------------------------------------------------------------------===// 9517caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xu 9527caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xuclass ElementRegion; 9537caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xu 9547caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xuclass RegionRawOffset { 9557caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xuprivate: 9567caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xu friend class ElementRegion; 9577caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xu 9587caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xu const MemRegion *Region; 9599ff2b13aee0f89d23ef4820218f9b88bb5e5c1c1Ken Dyck CharUnits Offset; 9607caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xu 9619ff2b13aee0f89d23ef4820218f9b88bb5e5c1c1Ken Dyck RegionRawOffset(const MemRegion* reg, CharUnits offset = CharUnits::Zero()) 9627caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xu : Region(reg), Offset(offset) {} 9637caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xu 9647caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xupublic: 9657caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xu // FIXME: Eventually support symbolic offsets. 9669ff2b13aee0f89d23ef4820218f9b88bb5e5c1c1Ken Dyck CharUnits getOffset() const { return Offset; } 9677caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xu const MemRegion *getRegion() const { return Region; } 9687caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xu 9699c378f705405d37f49795d5e915989de774fe11fTed Kremenek void dumpToStream(raw_ostream &os) const; 9707caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xu void dump() const; 9717caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xu}; 972511191ce8920160525611be2be754c32a0724c3eZhongxing Xu 9731437425a62dbf7bdb0a855d3ed3b05ed2019ec1eAnna Zaks/// \brief ElementRegin is used to represent both array elements and casts. 9749697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenekclass ElementRegion : public TypedValueRegion { 975511191ce8920160525611be2be754c32a0724c3eZhongxing Xu friend class MemRegionManager; 976511191ce8920160525611be2be754c32a0724c3eZhongxing Xu 977f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek QualType ElementType; 97802282acd7a42d06a3178e3102d34a585bd82dd9fTed Kremenek NonLoc Index; 979511191ce8920160525611be2be754c32a0724c3eZhongxing Xu 98002282acd7a42d06a3178e3102d34a585bd82dd9fTed Kremenek ElementRegion(QualType elementType, NonLoc Idx, const MemRegion* sReg) 9819697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek : TypedValueRegion(sReg, ElementRegionKind), 982f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek ElementType(elementType), Index(Idx) { 9833d8173c1c68f451c7492f92023d829c626845925Chris Lattner assert((!isa<nonloc::ConcreteInt>(&Idx) || 9843d8173c1c68f451c7492f92023d829c626845925Chris Lattner cast<nonloc::ConcreteInt>(&Idx)->getValue().isSigned()) && 98543b28d07019bc78447ecbbb721526de4ffd83f20Chris Lattner "The index must be signed"); 9860395b5d4987fe5baa818015e9d294c128619e4ecZhongxing Xu } 9871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 988f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek static void ProfileRegion(llvm::FoldingSetNodeID& ID, QualType elementType, 989f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek SVal Idx, const MemRegion* superRegion); 990511191ce8920160525611be2be754c32a0724c3eZhongxing Xu 991511191ce8920160525611be2be754c32a0724c3eZhongxing Xupublic: 992511191ce8920160525611be2be754c32a0724c3eZhongxing Xu 99302282acd7a42d06a3178e3102d34a585bd82dd9fTed Kremenek NonLoc getIndex() const { return Index; } 9946e78e1b22f3b16bb2ef76950b9b75f060bdba7bfZhongxing Xu 995018220c343c103b7dfaa117a7a474c7a7fd6d068Zhongxing Xu QualType getValueType() const { 996f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek return ElementType; 997f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek } 9981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 999f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek QualType getElementType() const { 1000f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek return ElementType; 1001abb042f33ea8e6107a7dc8efc51d2ace329f9f48Ted Kremenek } 10027caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xu /// Compute the offset within the array. The array might also be a subobject. 10037caf9b369cba6edaf6eac25121cbc65ee938f14dZhongxing Xu RegionRawOffset getAsArrayOffset() const; 10041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10059c378f705405d37f49795d5e915989de774fe11fTed Kremenek void dumpToStream(raw_ostream &os) const; 1006b21ff77c8126ea628b66d2ffb931fdaa7884f5d2Zhongxing Xu 1007511191ce8920160525611be2be754c32a0724c3eZhongxing Xu void Profile(llvm::FoldingSetNodeID& ID) const; 1008511191ce8920160525611be2be754c32a0724c3eZhongxing Xu 1009511191ce8920160525611be2be754c32a0724c3eZhongxing Xu static bool classof(const MemRegion* R) { 1010511191ce8920160525611be2be754c32a0724c3eZhongxing Xu return R->getKind() == ElementRegionKind; 1011511191ce8920160525611be2be754c32a0724c3eZhongxing Xu } 1012511191ce8920160525611be2be754c32a0724c3eZhongxing Xu}; 101319e1f0ba5cec738ce6cebe3fe0e1edc782206494Ted Kremenek 1014bc37b8dd9914e02580f531fa6e5e72be34d9675eZhongxing Xu// C++ temporary object associated with an expression. 10159697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenekclass CXXTempObjectRegion : public TypedValueRegion { 1016bb141217871e93767aa3f2de1b9946fa6d37066aZhongxing Xu friend class MemRegionManager; 1017bb141217871e93767aa3f2de1b9946fa6d37066aZhongxing Xu 1018bc37b8dd9914e02580f531fa6e5e72be34d9675eZhongxing Xu Expr const *Ex; 1019bb141217871e93767aa3f2de1b9946fa6d37066aZhongxing Xu 102002fe28c8a6da29d4ad88d0900c133dcf22d24a75Zhongxing Xu CXXTempObjectRegion(Expr const *E, MemRegion const *sReg) 10219697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek : TypedValueRegion(sReg, CXXTempObjectRegionKind), Ex(E) {} 1022bb141217871e93767aa3f2de1b9946fa6d37066aZhongxing Xu 1023bb141217871e93767aa3f2de1b9946fa6d37066aZhongxing Xu static void ProfileRegion(llvm::FoldingSetNodeID &ID, 1024bc37b8dd9914e02580f531fa6e5e72be34d9675eZhongxing Xu Expr const *E, const MemRegion *sReg); 1025bb141217871e93767aa3f2de1b9946fa6d37066aZhongxing Xu 1026bb141217871e93767aa3f2de1b9946fa6d37066aZhongxing Xupublic: 1027782f63ecd124f9384f988dc7e0cf4ae1540c15f6Jeffrey Yasskin const Expr *getExpr() const { return Ex; } 1028782f63ecd124f9384f988dc7e0cf4ae1540c15f6Jeffrey Yasskin 1029018220c343c103b7dfaa117a7a474c7a7fd6d068Zhongxing Xu QualType getValueType() const { 1030bc37b8dd9914e02580f531fa6e5e72be34d9675eZhongxing Xu return Ex->getType(); 1031bb141217871e93767aa3f2de1b9946fa6d37066aZhongxing Xu } 1032bb141217871e93767aa3f2de1b9946fa6d37066aZhongxing Xu 10339c378f705405d37f49795d5e915989de774fe11fTed Kremenek void dumpToStream(raw_ostream &os) const; 1034e1aeb13251a4858724d2b7ad1925d25076f23d08Zhongxing Xu 1035bb141217871e93767aa3f2de1b9946fa6d37066aZhongxing Xu void Profile(llvm::FoldingSetNodeID &ID) const; 1036bb141217871e93767aa3f2de1b9946fa6d37066aZhongxing Xu 1037bb141217871e93767aa3f2de1b9946fa6d37066aZhongxing Xu static bool classof(const MemRegion* R) { 103802fe28c8a6da29d4ad88d0900c133dcf22d24a75Zhongxing Xu return R->getKind() == CXXTempObjectRegionKind; 1039bb141217871e93767aa3f2de1b9946fa6d37066aZhongxing Xu } 1040bb141217871e93767aa3f2de1b9946fa6d37066aZhongxing Xu}; 1041bb141217871e93767aa3f2de1b9946fa6d37066aZhongxing Xu 10424fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu// CXXBaseObjectRegion represents a base object within a C++ object. It is 10434fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu// identified by the base class declaration and the region of its parent object. 10449697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenekclass CXXBaseObjectRegion : public TypedValueRegion { 10454fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu friend class MemRegionManager; 10464fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu 10474fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu const CXXRecordDecl *decl; 10484fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu 10494fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu CXXBaseObjectRegion(const CXXRecordDecl *d, const MemRegion *sReg) 10509697934650354bed2e509d8e7e44f21a1fb00f76Ted Kremenek : TypedValueRegion(sReg, CXXBaseObjectRegionKind), decl(d) {} 10514fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu 10524fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu static void ProfileRegion(llvm::FoldingSetNodeID &ID, 10534fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu const CXXRecordDecl *decl, const MemRegion *sReg); 10544fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu 10554fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xupublic: 1056d074441e027471a914cbb909a7aad1d43224950fZhongxing Xu const CXXRecordDecl *getDecl() const { return decl; } 1057d074441e027471a914cbb909a7aad1d43224950fZhongxing Xu 10584fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu QualType getValueType() const; 10594fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu 10609c378f705405d37f49795d5e915989de774fe11fTed Kremenek void dumpToStream(raw_ostream &os) const; 10614fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu 10624fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu void Profile(llvm::FoldingSetNodeID &ID) const; 10634fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu 10644fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu static bool classof(const MemRegion *region) { 10654fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu return region->getKind() == CXXBaseObjectRegionKind; 10664fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu } 10674fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu}; 10684fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu 1069ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenektemplate<typename RegionTy> 1070ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenekconst RegionTy* MemRegion::getAs() const { 1071f7a0cf426eddae76e1a71dd2295631a2cf0560afTed Kremenek if (const RegionTy* RT = dyn_cast<RegionTy>(this)) 1072f7a0cf426eddae76e1a71dd2295631a2cf0560afTed Kremenek return RT; 10731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1074f7a0cf426eddae76e1a71dd2295631a2cf0560afTed Kremenek return NULL; 1075ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek} 1076511191ce8920160525611be2be754c32a0724c3eZhongxing Xu 10779e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek//===----------------------------------------------------------------------===// 10789e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek// MemRegionManager - Factory object for creating regions. 10799e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek//===----------------------------------------------------------------------===// 10809e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek 10819e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekclass MemRegionManager { 1082a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek ASTContext &C; 10839e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek llvm::BumpPtrAllocator& A; 10849e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek llvm::FoldingSet<MemRegion> Regions; 10851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1086eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks GlobalInternalSpaceRegion *InternalGlobals; 1087eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks GlobalSystemSpaceRegion *SystemGlobals; 1088eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks GlobalImmutableSpaceRegion *ImmutableGlobals; 1089eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks 10902b87ae45e129b941d0a4d221c9d4842385a119bdTed Kremenek 1091c30470dd245e2c3b367d3d806e75bf6cc20fc18cZhongxing Xu llvm::DenseMap<const StackFrameContext *, StackLocalsSpaceRegion *> 1092c30470dd245e2c3b367d3d806e75bf6cc20fc18cZhongxing Xu StackLocalsSpaceRegions; 1093c30470dd245e2c3b367d3d806e75bf6cc20fc18cZhongxing Xu llvm::DenseMap<const StackFrameContext *, StackArgumentsSpaceRegion *> 1094c30470dd245e2c3b367d3d806e75bf6cc20fc18cZhongxing Xu StackArgumentsSpaceRegions; 1095dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek llvm::DenseMap<const CodeTextRegion *, StaticGlobalSpaceRegion *> 1096dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek StaticsGlobalSpaceRegions; 10972b87ae45e129b941d0a4d221c9d4842385a119bdTed Kremenek 109867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek HeapSpaceRegion *heap; 10992b87ae45e129b941d0a4d221c9d4842385a119bdTed Kremenek UnknownSpaceRegion *unknown; 1100d05552a21377f493c882298c59e8829040b01d34Ted Kremenek MemSpaceRegion *code; 1101dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu 11029e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekpublic: 1103a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek MemRegionManager(ASTContext &c, llvm::BumpPtrAllocator& a) 1104eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks : C(c), A(a), InternalGlobals(0), SystemGlobals(0), ImmutableGlobals(0), 1105eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks heap(0), unknown(0), code(0) {} 11061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11074240096011a187807058f887eb81df750ffa17feTed Kremenek ~MemRegionManager(); 11081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1109a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek ASTContext &getContext() { return C; } 11104240096011a187807058f887eb81df750ffa17feTed Kremenek 11114240096011a187807058f887eb81df750ffa17feTed Kremenek llvm::BumpPtrAllocator &getAllocator() { return A; } 11121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 111367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek /// getStackLocalsRegion - Retrieve the memory region associated with the 111467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek /// specified stack frame. 111567d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const StackLocalsSpaceRegion * 111667d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek getStackLocalsRegion(const StackFrameContext *STC); 1117d05552a21377f493c882298c59e8829040b01d34Ted Kremenek 1118d05552a21377f493c882298c59e8829040b01d34Ted Kremenek /// getStackArgumentsRegion - Retrieve the memory region associated with 111967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek /// function/method arguments of the specified stack frame. 112067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const StackArgumentsSpaceRegion * 112167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek getStackArgumentsRegion(const StackFrameContext *STC); 11221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11239e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek /// getGlobalsRegion - Retrieve the memory region associated with 1124dcee3ce97fc76f20ce8f5a7451071e3dec537073Ted Kremenek /// global variables. 1125eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks const GlobalsSpaceRegion *getGlobalsRegion( 1126eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks MemRegion::Kind K = MemRegion::GlobalInternalSpaceRegionKind, 1127eb31a76d1cdaaf8874c549dc6bd964ff270d3822Anna Zaks const CodeTextRegion *R = 0); 11281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11299e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek /// getHeapRegion - Retrieve the memory region associated with the 11309e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek /// generic "heap". 113167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const HeapSpaceRegion *getHeapRegion(); 1132178927517fa09ddbb04dc8ef725b5716c18aae21Zhongxing Xu 1133178927517fa09ddbb04dc8ef725b5716c18aae21Zhongxing Xu /// getUnknownRegion - Retrieve the memory region associated with unknown 1134178927517fa09ddbb04dc8ef725b5716c18aae21Zhongxing Xu /// memory space. 1135b48ad64a0e9e8d6488adebe597b6af32c1eb84f4Ted Kremenek const MemSpaceRegion *getUnknownRegion(); 1136c540b261ac553b91840146eaa3fee3f11b1013a7Zhongxing Xu 1137b48ad64a0e9e8d6488adebe597b6af32c1eb84f4Ted Kremenek const MemSpaceRegion *getCodeRegion(); 1138ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu 11397090ae1a984eb446a5fb4da7b1f2573830653799Ted Kremenek /// getAllocaRegion - Retrieve a region associated with a call to alloca(). 11409c378f705405d37f49795d5e915989de774fe11fTed Kremenek const AllocaRegion *getAllocaRegion(const Expr *Ex, unsigned Cnt, 114167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const LocationContext *LC); 11421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1143329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek /// getCompoundLiteralRegion - Retrieve the region associated with a 1144329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek /// given CompoundLiteral. 1145b48ad64a0e9e8d6488adebe597b6af32c1eb84f4Ted Kremenek const CompoundLiteralRegion* 11469c378f705405d37f49795d5e915989de774fe11fTed Kremenek getCompoundLiteralRegion(const CompoundLiteralExpr *CL, 114767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const LocationContext *LC); 1148de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek 1149fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner /// getCXXThisRegion - Retrieve the [artificial] region associated with the 1150de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek /// parameter 'this'. 1151de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek const CXXThisRegion *getCXXThisRegion(QualType thisPointerTy, 1152de0d26310191215a6d1d189dc419f87af18ce6beTed Kremenek const LocationContext *LC); 11531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1154e17fdb2d5dbf0ffefd417587003eebbe5baf5984Anna Zaks /// \brief Retrieve or create a "symbolic" memory region. 1155e17fdb2d5dbf0ffefd417587003eebbe5baf5984Anna Zaks const SymbolicRegion* getSymbolicRegion(SymbolRef Sym); 1156e17fdb2d5dbf0ffefd417587003eebbe5baf5984Anna Zaks 1157e17fdb2d5dbf0ffefd417587003eebbe5baf5984Anna Zaks /// \brief Return a unique symbolic region belonging to heap memory space. 1158e17fdb2d5dbf0ffefd417587003eebbe5baf5984Anna Zaks const SymbolicRegion *getSymbolicHeapRegion(SymbolRef sym); 1159e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu 11604c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek const StringRegion *getStringRegion(const StringLiteral* Str); 11614c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek 11624c62b557e269a27515dfca1f754ae936c8fdb824Ted Kremenek const ObjCStringRegion *getObjCStringRegion(const ObjCStringLiteral *Str); 1163e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu 11649e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek /// getVarRegion - Retrieve or create the memory region associated with 1165d17da2b99f323fa91b01e1dd119cc32e0ee8197dTed Kremenek /// a specified VarDecl and LocationContext. 1166b48ad64a0e9e8d6488adebe597b6af32c1eb84f4Ted Kremenek const VarRegion* getVarRegion(const VarDecl *D, const LocationContext *LC); 11671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 116867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek /// getVarRegion - Retrieve or create the memory region associated with 116967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek /// a specified VarDecl and super region. 117067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const VarRegion* getVarRegion(const VarDecl *D, const MemRegion *superR); 117167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek 1172f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek /// getElementRegion - Retrieve the memory region associated with the 1173f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek /// associated element type, index, and super region. 117402282acd7a42d06a3178e3102d34a585bd82dd9fTed Kremenek const ElementRegion *getElementRegion(QualType elementType, NonLoc Idx, 1175856c6bcaea56e05255e9f3997ddd56b5c18a14f0Zhongxing Xu const MemRegion *superRegion, 1176856c6bcaea56e05255e9f3997ddd56b5c18a14f0Zhongxing Xu ASTContext &Ctx); 11771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1178b48ad64a0e9e8d6488adebe597b6af32c1eb84f4Ted Kremenek const ElementRegion *getElementRegionWithSuper(const ElementRegion *ER, 1179856c6bcaea56e05255e9f3997ddd56b5c18a14f0Zhongxing Xu const MemRegion *superRegion) { 1180a5e81f1240bcc5b9b0721fc6275075ad7cadaf5eTed Kremenek return getElementRegion(ER->getElementType(), ER->getIndex(), 1181a5e81f1240bcc5b9b0721fc6275075ad7cadaf5eTed Kremenek superRegion, ER->getContext()); 1182a5e81f1240bcc5b9b0721fc6275075ad7cadaf5eTed Kremenek } 1183511191ce8920160525611be2be754c32a0724c3eZhongxing Xu 11849e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek /// getFieldRegion - Retrieve or create the memory region associated with 11859e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek /// a specified FieldDecl. 'superRegion' corresponds to the containing 11869e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek /// memory region (which typically represents the memory representing 11879e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek /// a structure or class). 11889c378f705405d37f49795d5e915989de774fe11fTed Kremenek const FieldRegion *getFieldRegion(const FieldDecl *fd, 1189b48ad64a0e9e8d6488adebe597b6af32c1eb84f4Ted Kremenek const MemRegion* superRegion); 11901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1191b48ad64a0e9e8d6488adebe597b6af32c1eb84f4Ted Kremenek const FieldRegion *getFieldRegionWithSuper(const FieldRegion *FR, 1192b48ad64a0e9e8d6488adebe597b6af32c1eb84f4Ted Kremenek const MemRegion *superRegion) { 1193a5e81f1240bcc5b9b0721fc6275075ad7cadaf5eTed Kremenek return getFieldRegion(FR->getDecl(), superRegion); 1194a5e81f1240bcc5b9b0721fc6275075ad7cadaf5eTed Kremenek } 11951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11969e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek /// getObjCIvarRegion - Retrieve or create the memory region associated with 11979e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek /// a specified Objective-c instance variable. 'superRegion' corresponds 11989e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek /// to the containing region (which typically represents the Objective-C 11999e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek /// object). 12009c378f705405d37f49795d5e915989de774fe11fTed Kremenek const ObjCIvarRegion *getObjCIvarRegion(const ObjCIvarDecl *ivd, 1201b48ad64a0e9e8d6488adebe597b6af32c1eb84f4Ted Kremenek const MemRegion* superRegion); 12021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 120302fe28c8a6da29d4ad88d0900c133dcf22d24a75Zhongxing Xu const CXXTempObjectRegion *getCXXTempObjectRegion(Expr const *Ex, 120402fe28c8a6da29d4ad88d0900c133dcf22d24a75Zhongxing Xu LocationContext const *LC); 1205bb141217871e93767aa3f2de1b9946fa6d37066aZhongxing Xu 12064fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu const CXXBaseObjectRegion *getCXXBaseObjectRegion(const CXXRecordDecl *decl, 12074fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu const MemRegion *superRegion); 12084fd56816e0925c04f2c92e75399f5c9018d5d6fbZhongxing Xu 1209d074441e027471a914cbb909a7aad1d43224950fZhongxing Xu /// Create a CXXBaseObjectRegion with the same CXXRecordDecl but a different 1210d074441e027471a914cbb909a7aad1d43224950fZhongxing Xu /// super region. 1211d074441e027471a914cbb909a7aad1d43224950fZhongxing Xu const CXXBaseObjectRegion * 1212d074441e027471a914cbb909a7aad1d43224950fZhongxing Xu getCXXBaseObjectRegionWithSuper(const CXXBaseObjectRegion *baseReg, 1213d074441e027471a914cbb909a7aad1d43224950fZhongxing Xu const MemRegion *superRegion) { 1214d074441e027471a914cbb909a7aad1d43224950fZhongxing Xu return getCXXBaseObjectRegion(baseReg->getDecl(), superRegion); 1215d074441e027471a914cbb909a7aad1d43224950fZhongxing Xu } 1216d074441e027471a914cbb909a7aad1d43224950fZhongxing Xu 1217b48ad64a0e9e8d6488adebe597b6af32c1eb84f4Ted Kremenek const FunctionTextRegion *getFunctionTextRegion(const FunctionDecl *FD); 1218b48ad64a0e9e8d6488adebe597b6af32c1eb84f4Ted Kremenek const BlockTextRegion *getBlockTextRegion(const BlockDecl *BD, 121967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek CanQualType locTy, 12201d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek AnalysisDeclContext *AC); 122167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek 122267d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek /// getBlockDataRegion - Get the memory region associated with an instance 122367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek /// of a block. Unlike many other MemRegions, the LocationContext* 122467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek /// argument is allowed to be NULL for cases where we have no known 122567d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek /// context. 1226b48ad64a0e9e8d6488adebe597b6af32c1eb84f4Ted Kremenek const BlockDataRegion *getBlockDataRegion(const BlockTextRegion *bc, 122767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const LocationContext *lc = NULL); 12281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1229bcd7f9f8cb2f1b78e8ad991677a4364044e1deb7Ted Kremenekprivate: 1230250101353b711a409b075f1bc11070dddec7100bTed Kremenek template <typename RegionTy, typename A1> 1231250101353b711a409b075f1bc11070dddec7100bTed Kremenek RegionTy* getRegion(const A1 a1); 12321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12336304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek template <typename RegionTy, typename A1> 1234eeea45611d45238c34474c183cee96d47ae79e24Ted Kremenek RegionTy* getSubRegion(const A1 a1, const MemRegion* superRegion); 12351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12367ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek template <typename RegionTy, typename A1, typename A2> 12377ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek RegionTy* getRegion(const A1 a1, const A2 a2); 1238dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu 12390a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek template <typename RegionTy, typename A1, typename A2> 12400a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek RegionTy* getSubRegion(const A1 a1, const A2 a2, 12410a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek const MemRegion* superRegion); 12420a8112a78d00b5140c5b7f16c3b34c2c0c13c1a0Ted Kremenek 124367d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek template <typename RegionTy, typename A1, typename A2, typename A3> 124467d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek RegionTy* getSubRegion(const A1 a1, const A2 a2, const A3 a3, 124567d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const MemRegion* superRegion); 124667d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek 124767d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek template <typename REG> 124867d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const REG* LazyAllocate(REG*& region); 124967d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek 125067d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek template <typename REG, typename ARG> 125167d1287035767f4f6c8ca0c2bb755990012a44caTed Kremenek const REG* LazyAllocate(REG*& region, ARG a); 1252ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek}; 12531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1254250101353b711a409b075f1bc11070dddec7100bTed Kremenek//===----------------------------------------------------------------------===// 1255a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek// Out-of-line member definitions. 1256250101353b711a409b075f1bc11070dddec7100bTed Kremenek//===----------------------------------------------------------------------===// 1257250101353b711a409b075f1bc11070dddec7100bTed Kremenek 12589c378f705405d37f49795d5e915989de774fe11fTed Kremenekinline ASTContext &MemRegion::getContext() const { 1259a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek return getMemRegionManager()->getContext(); 1260a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek} 1261eb1c7a04509f5d25c09005a6d46bd8bbb3ca88cbTed Kremenek 12625a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis} // end GR namespace 12635a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 1264be91224894e1501133e224934285ba6440bf5b59Ted Kremenek} // end clang namespace 12659e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek 1266250101353b711a409b075f1bc11070dddec7100bTed Kremenek//===----------------------------------------------------------------------===// 1267250101353b711a409b075f1bc11070dddec7100bTed Kremenek// Pretty-printing regions. 1268250101353b711a409b075f1bc11070dddec7100bTed Kremenek//===----------------------------------------------------------------------===// 1269250101353b711a409b075f1bc11070dddec7100bTed Kremenek 1270be91224894e1501133e224934285ba6440bf5b59Ted Kremeneknamespace llvm { 12719c378f705405d37f49795d5e915989de774fe11fTed Kremenekstatic inline raw_ostream &operator<<(raw_ostream &os, 12729ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremenek const clang::ento::MemRegion* R) { 12738800ad4eaa1621f6d23c8264971063b9f8da6a2eTed Kremenek R->dumpToStream(os); 12748800ad4eaa1621f6d23c8264971063b9f8da6a2eTed Kremenek return os; 1275be91224894e1501133e224934285ba6440bf5b59Ted Kremenek} 1276be91224894e1501133e224934285ba6440bf5b59Ted Kremenek} // end llvm namespace 12779e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek 12789e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek#endif 1279