MemRegion.h revision 9a08fee80a34938b8c11c7166e009a89ced4c2b4
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
169e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek#ifndef LLVM_CLANG_ANALYSIS_MEMREGION_H
179e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek#define LLVM_CLANG_ANALYSIS_MEMREGION_H
189e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
19993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek#include "clang/AST/Decl.h"
20993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek#include "clang/AST/DeclObjC.h"
21993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek#include "clang/Analysis/PathSensitive/SymbolManager.h"
2222ab7a4d900ed53285fd0b6720e7b43af84724d8Zhongxing Xu#include "clang/Analysis/PathSensitive/SVals.h"
23a693d4fa7a6dc31b23837cf38cba7aa2af8f00f3Ted Kremenek#include "clang/AST/ASTContext.h"
249e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek#include "llvm/Support/Casting.h"
259e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek#include "llvm/ADT/FoldingSet.h"
26dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu#include "llvm/ADT/ImmutableList.h"
27dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu#include "llvm/ADT/ImmutableMap.h"
289e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek#include "llvm/Support/Allocator.h"
299e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek#include <string>
309e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
319e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremeneknamespace llvm { class raw_ostream; }
329e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
339e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremeneknamespace clang {
349e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
359e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekclass MemRegionManager;
36bb7c96f290453104ec35ca17111a5165f68a4697Ted Kremenekclass MemSpaceRegion;
379e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
389e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek/// MemRegion - The root abstract class for all memory regions.
399e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekclass MemRegion : public llvm::FoldingSetNode {
409e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekpublic:
41026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu  enum Kind { MemSpaceRegionKind,
42e8e86482da4c1872673bbb9c237649229d19793bTed Kremenek              SymbolicRegionKind,
4382bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek              AllocaRegionKind,
449e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek              // Typed regions.
459e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek              BEG_TYPED_REGIONS,
46369f447eded97e6048ced02c0c2be3842f61fc1cZhongxing Xu               CodeTextRegionKind,
4777cfac623178d0c16e16e2f171d20b0fea8fde30Zhongxing Xu               CompoundLiteralRegionKind,
48329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek               StringRegionKind, ElementRegionKind,
490312c0e09c9de480d78607972ac64a88f4e94a33Ted Kremenek               TypedViewRegionKind,
50329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek               // Decl Regions.
51329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek                 BEG_DECL_REGIONS,
52329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek                  VarRegionKind, FieldRegionKind,
53329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek                  ObjCIvarRegionKind, ObjCObjectRegionKind,
54329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek                 END_DECL_REGIONS,
559e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek              END_TYPED_REGIONS };
569e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekprivate:
579e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  const Kind kind;
589e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
599e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekprotected:
609e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  MemRegion(Kind k) : kind(k) {}
619e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  virtual ~MemRegion();
62a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek  ASTContext &getContext() const;
639e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
649e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekpublic:
659e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  virtual void Profile(llvm::FoldingSetNodeID& ID) const = 0;
66a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek
67a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek  virtual MemRegionManager* getMemRegionManager() const = 0;
68a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek
699e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  std::string getString() const;
70bb7c96f290453104ec35ca17111a5165f68a4697Ted Kremenek
71bb7c96f290453104ec35ca17111a5165f68a4697Ted Kremenek  const MemSpaceRegion *getMemorySpace() const;
72ea20cd74793d257679267032419a9ff7fc89dc05Ted Kremenek
73ea20cd74793d257679267032419a9ff7fc89dc05Ted Kremenek  bool hasStackStorage() const;
74ea20cd74793d257679267032419a9ff7fc89dc05Ted Kremenek
751508636e99faddf569a57fce82c0fb3aa2124396Ted Kremenek  bool hasParametersStorage() const;
761508636e99faddf569a57fce82c0fb3aa2124396Ted Kremenek
771508636e99faddf569a57fce82c0fb3aa2124396Ted Kremenek  bool hasGlobalsStorage() const;
781508636e99faddf569a57fce82c0fb3aa2124396Ted Kremenek
791508636e99faddf569a57fce82c0fb3aa2124396Ted Kremenek  bool hasGlobalsOrParametersStorage() const;
801508636e99faddf569a57fce82c0fb3aa2124396Ted Kremenek
81ea20cd74793d257679267032419a9ff7fc89dc05Ted Kremenek  bool hasHeapStorage() const;
82bb7c96f290453104ec35ca17111a5165f68a4697Ted Kremenek
83bb7c96f290453104ec35ca17111a5165f68a4697Ted Kremenek  bool hasHeapOrStackStorage() const;
84b21ff77c8126ea628b66d2ffb931fdaa7884f5d2Zhongxing Xu
857f39d29cb69e7488f994870800d548008e50e1cbTed Kremenek  virtual void print(llvm::raw_ostream& os) const;
867f39d29cb69e7488f994870800d548008e50e1cbTed Kremenek
877f39d29cb69e7488f994870800d548008e50e1cbTed Kremenek  void printStdErr() const;
889e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
899e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  Kind getKind() const { return kind; }
9041168eac256fed59ec5406a75fce91c59cd5dd91Ted Kremenek
91ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek  template<typename RegionTy> const RegionTy* getAs() const;
92ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek
93f0f0605c87739c906861f73d4287798a4969b1e0Zhongxing Xu  virtual bool isBoundable() const { return false; }
94b21ff77c8126ea628b66d2ffb931fdaa7884f5d2Zhongxing Xu
959e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  static bool classof(const MemRegion*) { return true; }
969e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek};
979e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
989e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek/// MemSpaceRegion - A memory region that represents and "memory space";
999e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek///  for example, the set of global variables, the stack frame, etc.
1009e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekclass MemSpaceRegion : public MemRegion {
1019e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  friend class MemRegionManager;
102a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek
103a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenekprotected:
104a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek  MemRegionManager *Mgr;
105a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek
106a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek  MemSpaceRegion(MemRegionManager *mgr) : MemRegion(MemSpaceRegionKind),
107a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek                                          Mgr(mgr) {}
1089e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
109a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek  MemRegionManager* getMemRegionManager() const {
110a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek    return Mgr;
111a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek  }
112a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek
1139e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekpublic:
1149e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  void Profile(llvm::FoldingSetNodeID& ID) const;
1159e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
116a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek  bool isBoundable() const { return false; }
11741168eac256fed59ec5406a75fce91c59cd5dd91Ted Kremenek
1189e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  static bool classof(const MemRegion* R) {
1199e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek    return R->getKind() == MemSpaceRegionKind;
1209e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  }
1219e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek};
1229e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
123993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek/// SubRegion - A region that subsets another larger region.  Most regions
124993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek///  are subclasses of SubRegion.
125993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenekclass SubRegion : public MemRegion {
1269e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekprotected:
127993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek  const MemRegion* superRegion;
128993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek  SubRegion(const MemRegion* sReg, Kind k) : MemRegion(k), superRegion(sReg) {}
1299e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekpublic:
1309e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  const MemRegion* getSuperRegion() const {
1319e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek    return superRegion;
1329e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  }
133a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek
134a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek  MemRegionManager* getMemRegionManager() const;
1354193eca10ce0cc8b2dae887e935a43b26f492b5bZhongxing Xu
1367e5d6ed47dcedce35043de59ee00464b681bc786Zhongxing Xu  bool isSubRegionOf(const MemRegion* R) const;
1377e5d6ed47dcedce35043de59ee00464b681bc786Zhongxing Xu
1389e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  static bool classof(const MemRegion* R) {
139026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu    return R->getKind() > MemSpaceRegionKind;
140993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek  }
141993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek};
142ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu
14382bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek/// AllocaRegion - A region that represents an untyped blob of bytes created
14482bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek///  by a call to 'alloca'.
14582bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenekclass AllocaRegion : public SubRegion {
14682bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek  friend class MemRegionManager;
14782bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenekprotected:
14882bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek  unsigned Cnt; // Block counter.  Used to distinguish different pieces of
14982bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek                // memory allocated by alloca at the same call site.
15082bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek  const Expr* Ex;
15182bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek
1527ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek  AllocaRegion(const Expr* ex, unsigned cnt, const MemRegion *superRegion)
15382bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek    : SubRegion(superRegion, AllocaRegionKind), Cnt(cnt), Ex(ex) {}
15482bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek
15582bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenekpublic:
15682bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek
15782bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek  const Expr* getExpr() const { return Ex; }
15882bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek
15982bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek  void Profile(llvm::FoldingSetNodeID& ID) const;
16082bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek
16182bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek  static void ProfileRegion(llvm::FoldingSetNodeID& ID, const Expr* Ex,
1627ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek                            unsigned Cnt, const MemRegion *superRegion);
16382bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek
16482bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek  void print(llvm::raw_ostream& os) const;
16582bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek
16682bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek  static bool classof(const MemRegion* R) {
16782bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek    return R->getKind() == AllocaRegionKind;
16882bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek  }
16982bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek};
17082bd99f4db2454cc6e1b7bfaac6db25cb3444ddcTed Kremenek
171993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek/// TypedRegion - An abstract class representing regions that are typed.
172993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenekclass TypedRegion : public SubRegion {
173993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenekprotected:
174993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek  TypedRegion(const MemRegion* sReg, Kind k) : SubRegion(sReg, k) {}
175993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek
176993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenekpublic:
177a82d8aa5b3b3d24998b4d98b9f45a43cc84cac6fZhongxing Xu  virtual QualType getValueType(ASTContext &C) const = 0;
1786eddeb153415049c7b62de4b45385a759a6906c6Ted Kremenek
179ff6978263439e21d795b0602fabcb38488ef8441Zhongxing Xu  virtual QualType getLocationType(ASTContext& C) const {
1806eddeb153415049c7b62de4b45385a759a6906c6Ted Kremenek    // FIXME: We can possibly optimize this later to cache this value.
181a82d8aa5b3b3d24998b4d98b9f45a43cc84cac6fZhongxing Xu    return C.getPointerType(getValueType(C));
1826eddeb153415049c7b62de4b45385a759a6906c6Ted Kremenek  }
18314553abd17d303b0b310b3ab1523eb0d30d8121cTed Kremenek
184a82d8aa5b3b3d24998b4d98b9f45a43cc84cac6fZhongxing Xu  QualType getDesugaredValueType(ASTContext& C) const {
185a82d8aa5b3b3d24998b4d98b9f45a43cc84cac6fZhongxing Xu    QualType T = getValueType(C);
1861b9b883a95215e38e153d253a46a2a2fcac25896Ted Kremenek    return T.getTypePtr() ? T->getDesugaredType() : T;
18714553abd17d303b0b310b3ab1523eb0d30d8121cTed Kremenek  }
18814553abd17d303b0b310b3ab1523eb0d30d8121cTed Kremenek
189ff6978263439e21d795b0602fabcb38488ef8441Zhongxing Xu  QualType getDesugaredLocationType(ASTContext& C) const {
190ff6978263439e21d795b0602fabcb38488ef8441Zhongxing Xu    return getLocationType(C)->getDesugaredType();
19114553abd17d303b0b310b3ab1523eb0d30d8121cTed Kremenek  }
1921b9b883a95215e38e153d253a46a2a2fcac25896Ted Kremenek
193a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek  bool isBoundable() const {
194a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek    return !getValueType(getContext()).isNull();
19541168eac256fed59ec5406a75fce91c59cd5dd91Ted Kremenek  }
1966eddeb153415049c7b62de4b45385a759a6906c6Ted Kremenek
197993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek  static bool classof(const MemRegion* R) {
1989e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek    unsigned k = R->getKind();
1999e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek    return k > BEG_TYPED_REGIONS && k < END_TYPED_REGIONS;
2009e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  }
2019e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek};
2029e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
203ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu/// CodeTextRegion - A region that represents code texts of a function. It wraps
204ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu/// two kinds of code texts: real function and symbolic function. Real function
205ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu/// is a function declared in the program. Symbolic function is a function
206ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu/// pointer that we don't know which function it points to.
207ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xuclass CodeTextRegion : public TypedRegion {
208ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xupublic:
209ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu  enum CodeKind { Declared, Symbolic };
210ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu
211ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xuprivate:
212ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu  // The function pointer kind that this CodeTextRegion represents.
213ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu  CodeKind codekind;
214ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu
215ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu  // Data may be a SymbolRef or FunctionDecl*.
216ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu  const void* Data;
217ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu
218ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu  // Cached function pointer type.
219ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu  QualType LocationType;
220ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu
221ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xupublic:
222ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu
223ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu  CodeTextRegion(const FunctionDecl* fd, QualType t, const MemRegion* sreg)
224ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu    : TypedRegion(sreg, CodeTextRegionKind),
225ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu      codekind(Declared),
226ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu      Data(fd),
227ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu      LocationType(t) {}
228ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu
229ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu  CodeTextRegion(SymbolRef sym, QualType t, const MemRegion* sreg)
230ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu    : TypedRegion(sreg, CodeTextRegionKind),
231ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu      codekind(Symbolic),
232ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu      Data(sym),
233ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu      LocationType(t) {}
234ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu
235a82d8aa5b3b3d24998b4d98b9f45a43cc84cac6fZhongxing Xu  QualType getValueType(ASTContext &C) const {
236ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu    // Do not get the object type of a CodeTextRegion.
237ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu    assert(0);
238ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu    return QualType();
239ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu  }
240ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu
241ff6978263439e21d795b0602fabcb38488ef8441Zhongxing Xu  QualType getLocationType(ASTContext &C) const {
242ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu    return LocationType;
243ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu  }
244369f447eded97e6048ced02c0c2be3842f61fc1cZhongxing Xu
245369f447eded97e6048ced02c0c2be3842f61fc1cZhongxing Xu  bool isDeclared() const { return codekind == Declared; }
246264e93799c891c03d60cf0b09a032b0a9935d3b5Zhongxing Xu  bool isSymbolic() const { return codekind == Symbolic; }
247369f447eded97e6048ced02c0c2be3842f61fc1cZhongxing Xu
248369f447eded97e6048ced02c0c2be3842f61fc1cZhongxing Xu  const FunctionDecl* getDecl() const {
249369f447eded97e6048ced02c0c2be3842f61fc1cZhongxing Xu    assert(codekind == Declared);
250369f447eded97e6048ced02c0c2be3842f61fc1cZhongxing Xu    return static_cast<const FunctionDecl*>(Data);
251369f447eded97e6048ced02c0c2be3842f61fc1cZhongxing Xu  }
2528ec3d7dbff9d526fcdce4fbea683830192340c90Ted Kremenek
25372e032004b0d2c2c298e8e4f7027f23a21c0cc7dTed Kremenek  SymbolRef getSymbol() const {
25472e032004b0d2c2c298e8e4f7027f23a21c0cc7dTed Kremenek    assert(codekind == Symbolic);
25572e032004b0d2c2c298e8e4f7027f23a21c0cc7dTed Kremenek    return const_cast<SymbolRef>(static_cast<const SymbolRef>(Data));
25672e032004b0d2c2c298e8e4f7027f23a21c0cc7dTed Kremenek  }
25772e032004b0d2c2c298e8e4f7027f23a21c0cc7dTed Kremenek
258a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek  bool isBoundable() const { return false; }
25972e032004b0d2c2c298e8e4f7027f23a21c0cc7dTed Kremenek
26072e032004b0d2c2c298e8e4f7027f23a21c0cc7dTed Kremenek  virtual void print(llvm::raw_ostream& os) const;
261ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu
262ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu  void Profile(llvm::FoldingSetNodeID& ID) const;
263ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu
264ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu  static void ProfileRegion(llvm::FoldingSetNodeID& ID,
2650dea5241bca707789d706ed1fda3a29a8fedc4c0Zhongxing Xu                            const void* data, QualType t, const MemRegion*);
266ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu
267ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu  static bool classof(const MemRegion* R) {
268ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu    return R->getKind() == CodeTextRegionKind;
269ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu  }
270ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu};
271ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu
272026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu/// SymbolicRegion - A special, "non-concrete" region. Unlike other region
273026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu///  clases, SymbolicRegion represents a region that serves as an alias for
274026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu///  either a real region, a NULL pointer, etc.  It essentially is used to
275026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu///  map the concept of symbolic values into the domain of regions.  Symbolic
276026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu///  regions do not need to be typed.
277e8e86482da4c1872673bbb9c237649229d19793bTed Kremenekclass SymbolicRegion : public SubRegion {
278026c66395b88a09437319139a43b090093f7e1ddZhongxing Xuprotected:
279026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu  const SymbolRef sym;
280026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu
281026c66395b88a09437319139a43b090093f7e1ddZhongxing Xupublic:
282e0e4ebf6bfca5a71b2344d8a1b748b852509279cTed Kremenek  SymbolicRegion(const SymbolRef s, const MemRegion* sreg)
283e8e86482da4c1872673bbb9c237649229d19793bTed Kremenek    : SubRegion(sreg, SymbolicRegionKind), sym(s) {}
284026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu
285026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu  SymbolRef getSymbol() const {
286026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu    return sym;
287026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu  }
288026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu
289026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu  void Profile(llvm::FoldingSetNodeID& ID) const;
290026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu
291250101353b711a409b075f1bc11070dddec7100bTed Kremenek  static void ProfileRegion(llvm::FoldingSetNodeID& ID,
292250101353b711a409b075f1bc11070dddec7100bTed Kremenek                            SymbolRef sym,
293250101353b711a409b075f1bc11070dddec7100bTed Kremenek                            const MemRegion* superRegion);
294026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu
295026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu  void print(llvm::raw_ostream& os) const;
296026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu
297026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu  static bool classof(const MemRegion* R) {
298026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu    return R->getKind() == SymbolicRegionKind;
299026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu  }
300026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu};
301026c66395b88a09437319139a43b090093f7e1ddZhongxing Xu
302e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu/// StringRegion - Region associated with a StringLiteral.
303e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xuclass StringRegion : public TypedRegion {
304e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu  friend class MemRegionManager;
305e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu  const StringLiteral* Str;
306e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xuprotected:
307e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu
308250101353b711a409b075f1bc11070dddec7100bTed Kremenek  StringRegion(const StringLiteral* str, const MemRegion* sreg)
309e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu    : TypedRegion(sreg, StringRegionKind), Str(str) {}
310e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu
311e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu  static void ProfileRegion(llvm::FoldingSetNodeID& ID,
312e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu                            const StringLiteral* Str,
313e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu                            const MemRegion* superRegion);
314e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu
315e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xupublic:
3166613d08a19aa6ce9b6330487f3bfac841d4b8a4dZhongxing Xu
3176613d08a19aa6ce9b6330487f3bfac841d4b8a4dZhongxing Xu  const StringLiteral* getStringLiteral() const { return Str; }
3186eddeb153415049c7b62de4b45385a759a6906c6Ted Kremenek
319a82d8aa5b3b3d24998b4d98b9f45a43cc84cac6fZhongxing Xu  QualType getValueType(ASTContext& C) const {
320ff6978263439e21d795b0602fabcb38488ef8441Zhongxing Xu    return Str->getType();
321ff6978263439e21d795b0602fabcb38488ef8441Zhongxing Xu  }
322e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu
3230a51f1c6cec6032bcf64ce205bc4edfdc3cb3a2fZhongxing Xu  bool isBoundable() const { return false; }
3240a51f1c6cec6032bcf64ce205bc4edfdc3cb3a2fZhongxing Xu
325e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu  void Profile(llvm::FoldingSetNodeID& ID) const {
326e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu    ProfileRegion(ID, Str, superRegion);
327e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu  }
328e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu
329cc128b32429494fe04ed36d7ba30c011cb4e173aZhongxing Xu  void print(llvm::raw_ostream& os) const;
330cc128b32429494fe04ed36d7ba30c011cb4e173aZhongxing Xu
331e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu  static bool classof(const MemRegion* R) {
332e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu    return R->getKind() == StringRegionKind;
333e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu  }
334e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu};
335e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu
3360312c0e09c9de480d78607972ac64a88f4e94a33Ted Kremenekclass TypedViewRegion : public TypedRegion {
337dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu  friend class MemRegionManager;
338b2dea734527ae75281642a1c6ace28f9e00cab11Ted Kremenek  QualType LValueType;
339dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu
340b2dea734527ae75281642a1c6ace28f9e00cab11Ted Kremenek  TypedViewRegion(QualType lvalueType, const MemRegion* sreg)
341b2dea734527ae75281642a1c6ace28f9e00cab11Ted Kremenek    : TypedRegion(sreg, TypedViewRegionKind), LValueType(lvalueType) {}
342dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu
343dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu  static void ProfileRegion(llvm::FoldingSetNodeID& ID, QualType T,
344dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu                            const MemRegion* superRegion);
345dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu
346dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xupublic:
347dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu
348500d2ee83d407106d80920fb4325fa2e06fa61a5Ted Kremenek  void print(llvm::raw_ostream& os) const;
349500d2ee83d407106d80920fb4325fa2e06fa61a5Ted Kremenek
350ff6978263439e21d795b0602fabcb38488ef8441Zhongxing Xu  QualType getLocationType(ASTContext&) const {
351e6fbdf538bc50122876639e08a1401e2bc9555baTed Kremenek    return LValueType;
352e6fbdf538bc50122876639e08a1401e2bc9555baTed Kremenek  }
353e6fbdf538bc50122876639e08a1401e2bc9555baTed Kremenek
354a82d8aa5b3b3d24998b4d98b9f45a43cc84cac6fZhongxing Xu  QualType getValueType(ASTContext&) const {
355b2dea734527ae75281642a1c6ace28f9e00cab11Ted Kremenek    const PointerType* PTy = LValueType->getAsPointerType();
3562e3f73b963b5831d6230f69e157b0964b11eff91Zhongxing Xu    assert(PTy);
3572e3f73b963b5831d6230f69e157b0964b11eff91Zhongxing Xu    return PTy->getPointeeType();
358dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu  }
359b2dea734527ae75281642a1c6ace28f9e00cab11Ted Kremenek
360a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek  bool isBoundable() const {
361b2dea734527ae75281642a1c6ace28f9e00cab11Ted Kremenek    return isa<PointerType>(LValueType);
362b2dea734527ae75281642a1c6ace28f9e00cab11Ted Kremenek  }
363dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu
364dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu  void Profile(llvm::FoldingSetNodeID& ID) const {
365b2dea734527ae75281642a1c6ace28f9e00cab11Ted Kremenek    ProfileRegion(ID, LValueType, superRegion);
366dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu  }
367dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu
368dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu  static bool classof(const MemRegion* R) {
3690312c0e09c9de480d78607972ac64a88f4e94a33Ted Kremenek    return R->getKind() == TypedViewRegionKind;
370dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu  }
3711670e403c48f3af4fceff3f6773a0e1cfc6c4eb3Ted Kremenek
3721670e403c48f3af4fceff3f6773a0e1cfc6c4eb3Ted Kremenek  const MemRegion *removeViews() const;
373dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu};
3746eddeb153415049c7b62de4b45385a759a6906c6Ted Kremenek
375178927517fa09ddbb04dc8ef725b5716c18aae21Zhongxing Xu
376329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek/// CompoundLiteralRegion - A memory region representing a compound literal.
377329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek///   Compound literals are essentially temporaries that are stack allocated
378329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek///   or in the global constant pool.
37977cfac623178d0c16e16e2f171d20b0fea8fde30Zhongxing Xuclass CompoundLiteralRegion : public TypedRegion {
380329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenekprivate:
381329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek  friend class MemRegionManager;
382329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek  const CompoundLiteralExpr* CL;
383329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek
384329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek  CompoundLiteralRegion(const CompoundLiteralExpr* cl, const MemRegion* sReg)
38577cfac623178d0c16e16e2f171d20b0fea8fde30Zhongxing Xu    : TypedRegion(sReg, CompoundLiteralRegionKind), CL(cl) {}
386329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek
387329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek  static void ProfileRegion(llvm::FoldingSetNodeID& ID,
388329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek                            const CompoundLiteralExpr* CL,
389329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek                            const MemRegion* superRegion);
390329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenekpublic:
391a82d8aa5b3b3d24998b4d98b9f45a43cc84cac6fZhongxing Xu  QualType getValueType(ASTContext& C) const {
39277cfac623178d0c16e16e2f171d20b0fea8fde30Zhongxing Xu    return C.getCanonicalType(CL->getType());
39377cfac623178d0c16e16e2f171d20b0fea8fde30Zhongxing Xu  }
3940a51f1c6cec6032bcf64ce205bc4edfdc3cb3a2fZhongxing Xu
3959a08fee80a34938b8c11c7166e009a89ced4c2b4Zhongxing Xu  bool isBoundable() const { return !CL->isFileScope(); }
3969a08fee80a34938b8c11c7166e009a89ced4c2b4Zhongxing Xu
397329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek  void Profile(llvm::FoldingSetNodeID& ID) const;
398329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek
399329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek  void print(llvm::raw_ostream& os) const;
400329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek
40111a83dc7a9a5738cc0bc76180b508eae896eefa9Ted Kremenek  const CompoundLiteralExpr* getLiteralExpr() const { return CL; }
40211a83dc7a9a5738cc0bc76180b508eae896eefa9Ted Kremenek
403329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek  static bool classof(const MemRegion* R) {
404329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek    return R->getKind() == CompoundLiteralRegionKind;
405329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek  }
406329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek};
407178927517fa09ddbb04dc8ef725b5716c18aae21Zhongxing Xu
4089e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekclass DeclRegion : public TypedRegion {
4099e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekprotected:
4109e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  const Decl* D;
4119e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
412993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek  DeclRegion(const Decl* d, const MemRegion* sReg, Kind k)
4139e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek    : TypedRegion(sReg, k), D(d) {}
4149e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
4159e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  static void ProfileRegion(llvm::FoldingSetNodeID& ID, const Decl* D,
4169e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek                      const MemRegion* superRegion, Kind k);
4179e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
418bfb6582ef46dfb33672d9621f879fc262339d704Zhongxing Xupublic:
419bfb6582ef46dfb33672d9621f879fc262339d704Zhongxing Xu  const Decl* getDecl() const { return D; }
4209e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  void Profile(llvm::FoldingSetNodeID& ID) const;
4216eddeb153415049c7b62de4b45385a759a6906c6Ted Kremenek
422e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu  static bool classof(const MemRegion* R) {
423e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu    unsigned k = R->getKind();
424e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu    return k > BEG_DECL_REGIONS && k < END_DECL_REGIONS;
425e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu  }
4269e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek};
4279e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
4289e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekclass VarRegion : public DeclRegion {
4299e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  friend class MemRegionManager;
4309e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
431993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek  VarRegion(const VarDecl* vd, const MemRegion* sReg)
4329e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek    : DeclRegion(vd, sReg, VarRegionKind) {}
4339e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
434250101353b711a409b075f1bc11070dddec7100bTed Kremenek  static void ProfileRegion(llvm::FoldingSetNodeID& ID, const VarDecl* VD,
4356304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek                            const MemRegion* superRegion) {
4369e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek    DeclRegion::ProfileRegion(ID, VD, superRegion, VarRegionKind);
4379e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  }
4389e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
4399e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekpublic:
4406eddeb153415049c7b62de4b45385a759a6906c6Ted Kremenek  const VarDecl* getDecl() const { return cast<VarDecl>(D); }
4419e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
442a82d8aa5b3b3d24998b4d98b9f45a43cc84cac6fZhongxing Xu  QualType getValueType(ASTContext& C) const {
4436eddeb153415049c7b62de4b45385a759a6906c6Ted Kremenek    // FIXME: We can cache this if needed.
4446eddeb153415049c7b62de4b45385a759a6906c6Ted Kremenek    return C.getCanonicalType(getDecl()->getType());
4456eddeb153415049c7b62de4b45385a759a6906c6Ted Kremenek  }
4466eddeb153415049c7b62de4b45385a759a6906c6Ted Kremenek
4479e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  void print(llvm::raw_ostream& os) const;
4489e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
4499e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  static bool classof(const MemRegion* R) {
4509e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek    return R->getKind() == VarRegionKind;
4519e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  }
4529e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek};
4539e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
4549e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekclass FieldRegion : public DeclRegion {
4559e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  friend class MemRegionManager;
4569e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
457993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek  FieldRegion(const FieldDecl* fd, const MemRegion* sReg)
4589e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek    : DeclRegion(fd, sReg, FieldRegionKind) {}
4599e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
4604bd1eefd48c70ebef185e524d0484c00f16000cfTed Kremenekpublic:
4614bd1eefd48c70ebef185e524d0484c00f16000cfTed Kremenek
4624bd1eefd48c70ebef185e524d0484c00f16000cfTed Kremenek  void print(llvm::raw_ostream& os) const;
4634bd1eefd48c70ebef185e524d0484c00f16000cfTed Kremenek
4644bd1eefd48c70ebef185e524d0484c00f16000cfTed Kremenek  const FieldDecl* getDecl() const { return cast<FieldDecl>(D); }
4656eddeb153415049c7b62de4b45385a759a6906c6Ted Kremenek
466a82d8aa5b3b3d24998b4d98b9f45a43cc84cac6fZhongxing Xu  QualType getValueType(ASTContext& C) const {
4676eddeb153415049c7b62de4b45385a759a6906c6Ted Kremenek    // FIXME: We can cache this if needed.
468e70559fd25bfd1970a82086c5f99cf9ef181b1aeZhongxing Xu    return C.getCanonicalType(getDecl()->getType());
4696eddeb153415049c7b62de4b45385a759a6906c6Ted Kremenek  }
4704bd1eefd48c70ebef185e524d0484c00f16000cfTed Kremenek
4716304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek  static void ProfileRegion(llvm::FoldingSetNodeID& ID, const FieldDecl* FD,
4726304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek                            const MemRegion* superRegion) {
4739e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek    DeclRegion::ProfileRegion(ID, FD, superRegion, FieldRegionKind);
4749e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  }
4759e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
4769e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  static bool classof(const MemRegion* R) {
4779e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek    return R->getKind() == FieldRegionKind;
4789e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  }
4799e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek};
4809e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
481a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenekclass ObjCObjectRegion : public DeclRegion {
482a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek
483a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek  friend class MemRegionManager;
484a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek
485a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek  ObjCObjectRegion(const ObjCInterfaceDecl* ivd, const MemRegion* sReg)
486a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek  : DeclRegion(ivd, sReg, ObjCObjectRegionKind) {}
487a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek
4886304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek  static void ProfileRegion(llvm::FoldingSetNodeID& ID,
4896304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek                            const ObjCInterfaceDecl* ivd,
490a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek                            const MemRegion* superRegion) {
491a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek    DeclRegion::ProfileRegion(ID, ivd, superRegion, ObjCObjectRegionKind);
492a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek  }
493a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek
494a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenekpublic:
495a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek  const ObjCInterfaceDecl* getInterface() const {
496a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek    return cast<ObjCInterfaceDecl>(D);
497a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek  }
498a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek
499a82d8aa5b3b3d24998b4d98b9f45a43cc84cac6fZhongxing Xu  QualType getValueType(ASTContext& C) const {
5003b3a45858c6b2a45114e91902c3bf3c4b7f5f302Daniel Dunbar    return C.getObjCInterfaceType(getInterface());
501a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek  }
502a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek
503a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek  static bool classof(const MemRegion* R) {
504a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek    return R->getKind() == ObjCObjectRegionKind;
505a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek  }
506a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek};
507a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek
5089e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekclass ObjCIvarRegion : public DeclRegion {
5099e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
5109e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  friend class MemRegionManager;
5119e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
512993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek  ObjCIvarRegion(const ObjCIvarDecl* ivd, const MemRegion* sReg)
5139e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek    : DeclRegion(ivd, sReg, ObjCIvarRegionKind) {}
5149e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
5156304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek  static void ProfileRegion(llvm::FoldingSetNodeID& ID, const ObjCIvarDecl* ivd,
5166304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek                            const MemRegion* superRegion) {
5179e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek    DeclRegion::ProfileRegion(ID, ivd, superRegion, ObjCIvarRegionKind);
5189e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  }
5199e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
5209e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekpublic:
5219e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  const ObjCIvarDecl* getDecl() const { return cast<ObjCIvarDecl>(D); }
522a82d8aa5b3b3d24998b4d98b9f45a43cc84cac6fZhongxing Xu  QualType getValueType(ASTContext&) const { return getDecl()->getType(); }
5239e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
5249e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  static bool classof(const MemRegion* R) {
5259e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek    return R->getKind() == ObjCIvarRegionKind;
5269e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  }
5279e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek};
528511191ce8920160525611be2be754c32a0724c3eZhongxing Xu
52927b57063d83b00474d7563fb5d608544e2364862Zhongxing Xuclass ElementRegion : public TypedRegion {
530511191ce8920160525611be2be754c32a0724c3eZhongxing Xu  friend class MemRegionManager;
531511191ce8920160525611be2be754c32a0724c3eZhongxing Xu
532f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek  QualType ElementType;
533511191ce8920160525611be2be754c32a0724c3eZhongxing Xu  SVal Index;
534511191ce8920160525611be2be754c32a0724c3eZhongxing Xu
535f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek  ElementRegion(QualType elementType, SVal Idx, const MemRegion* sReg)
536f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek    : TypedRegion(sReg, ElementRegionKind),
537f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek      ElementType(elementType), Index(Idx) {
5383d8173c1c68f451c7492f92023d829c626845925Chris Lattner    assert((!isa<nonloc::ConcreteInt>(&Idx) ||
5393d8173c1c68f451c7492f92023d829c626845925Chris Lattner           cast<nonloc::ConcreteInt>(&Idx)->getValue().isSigned()) &&
54043b28d07019bc78447ecbbb721526de4ffd83f20Chris Lattner           "The index must be signed");
5410395b5d4987fe5baa818015e9d294c128619e4ecZhongxing Xu  }
542abb042f33ea8e6107a7dc8efc51d2ace329f9f48Ted Kremenek
543f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek  static void ProfileRegion(llvm::FoldingSetNodeID& ID, QualType elementType,
544f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek                            SVal Idx, const MemRegion* superRegion);
545511191ce8920160525611be2be754c32a0724c3eZhongxing Xu
546511191ce8920160525611be2be754c32a0724c3eZhongxing Xupublic:
547511191ce8920160525611be2be754c32a0724c3eZhongxing Xu
5486e78e1b22f3b16bb2ef76950b9b75f060bdba7bfZhongxing Xu  SVal getIndex() const { return Index; }
5496e78e1b22f3b16bb2ef76950b9b75f060bdba7bfZhongxing Xu
550a82d8aa5b3b3d24998b4d98b9f45a43cc84cac6fZhongxing Xu  QualType getValueType(ASTContext&) const {
551f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek    return ElementType;
552f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek  }
553f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek
554f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek  QualType getElementType() const {
555f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek    return ElementType;
556abb042f33ea8e6107a7dc8efc51d2ace329f9f48Ted Kremenek  }
557abb042f33ea8e6107a7dc8efc51d2ace329f9f48Ted Kremenek
558b21ff77c8126ea628b66d2ffb931fdaa7884f5d2Zhongxing Xu  void print(llvm::raw_ostream& os) const;
559b21ff77c8126ea628b66d2ffb931fdaa7884f5d2Zhongxing Xu
560511191ce8920160525611be2be754c32a0724c3eZhongxing Xu  void Profile(llvm::FoldingSetNodeID& ID) const;
561511191ce8920160525611be2be754c32a0724c3eZhongxing Xu
562511191ce8920160525611be2be754c32a0724c3eZhongxing Xu  static bool classof(const MemRegion* R) {
563511191ce8920160525611be2be754c32a0724c3eZhongxing Xu    return R->getKind() == ElementRegionKind;
564511191ce8920160525611be2be754c32a0724c3eZhongxing Xu  }
565511191ce8920160525611be2be754c32a0724c3eZhongxing Xu};
566ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek
567ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenektemplate<typename RegionTy>
568ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenekconst RegionTy* MemRegion::getAs() const {
569ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek  const MemRegion *R = this;
570ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek
571ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek  do {
572ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek    if (const RegionTy* RT = dyn_cast<RegionTy>(R))
573ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek      return RT;
574ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek
575ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek    if (const TypedViewRegion *TR = dyn_cast<TypedViewRegion>(R)) {
576ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek      R = TR->getSuperRegion();
577ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek      continue;
578ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek    }
579ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek
580ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek    break;
581ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek  }
582ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek  while (R);
583ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek
584ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek  return 0;
585ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek}
586511191ce8920160525611be2be754c32a0724c3eZhongxing Xu
5879e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek//===----------------------------------------------------------------------===//
5889e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek// MemRegionManager - Factory object for creating regions.
5899e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek//===----------------------------------------------------------------------===//
5909e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
5919e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekclass MemRegionManager {
592a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek  ASTContext &C;
5939e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  llvm::BumpPtrAllocator& A;
5949e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  llvm::FoldingSet<MemRegion> Regions;
5959e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
596d05552a21377f493c882298c59e8829040b01d34Ted Kremenek  MemSpaceRegion *globals;
597d05552a21377f493c882298c59e8829040b01d34Ted Kremenek  MemSpaceRegion *stack;
598d05552a21377f493c882298c59e8829040b01d34Ted Kremenek  MemSpaceRegion *stackArguments;
599d05552a21377f493c882298c59e8829040b01d34Ted Kremenek  MemSpaceRegion *heap;
600d05552a21377f493c882298c59e8829040b01d34Ted Kremenek  MemSpaceRegion *unknown;
601d05552a21377f493c882298c59e8829040b01d34Ted Kremenek  MemSpaceRegion *code;
602dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu
6039e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekpublic:
604a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek  MemRegionManager(ASTContext &c, llvm::BumpPtrAllocator& a)
605d05552a21377f493c882298c59e8829040b01d34Ted Kremenek    : C(c), A(a), globals(0), stack(0), stackArguments(0), heap(0),
606d05552a21377f493c882298c59e8829040b01d34Ted Kremenek      unknown(0), code(0) {}
6079e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
6089e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  ~MemRegionManager() {}
6099e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
610a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek  ASTContext &getContext() { return C; }
611a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek
6129e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  /// getStackRegion - Retrieve the memory region associated with the
6139e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  ///  current stack frame.
614d05552a21377f493c882298c59e8829040b01d34Ted Kremenek  MemSpaceRegion *getStackRegion();
615d05552a21377f493c882298c59e8829040b01d34Ted Kremenek
616d05552a21377f493c882298c59e8829040b01d34Ted Kremenek  /// getStackArgumentsRegion - Retrieve the memory region associated with
617d05552a21377f493c882298c59e8829040b01d34Ted Kremenek  ///  function/method arguments of the current stack frame.
618d05552a21377f493c882298c59e8829040b01d34Ted Kremenek  MemSpaceRegion *getStackArgumentsRegion();
6199e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
6209e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  /// getGlobalsRegion - Retrieve the memory region associated with
6219e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  ///  all global variables.
622d05552a21377f493c882298c59e8829040b01d34Ted Kremenek  MemSpaceRegion *getGlobalsRegion();
6239e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
6249e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  /// getHeapRegion - Retrieve the memory region associated with the
6259e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  ///  generic "heap".
626d05552a21377f493c882298c59e8829040b01d34Ted Kremenek  MemSpaceRegion *getHeapRegion();
627178927517fa09ddbb04dc8ef725b5716c18aae21Zhongxing Xu
628178927517fa09ddbb04dc8ef725b5716c18aae21Zhongxing Xu  /// getUnknownRegion - Retrieve the memory region associated with unknown
629178927517fa09ddbb04dc8ef725b5716c18aae21Zhongxing Xu  /// memory space.
630d05552a21377f493c882298c59e8829040b01d34Ted Kremenek  MemSpaceRegion *getUnknownRegion();
631c540b261ac553b91840146eaa3fee3f11b1013a7Zhongxing Xu
632d05552a21377f493c882298c59e8829040b01d34Ted Kremenek  MemSpaceRegion *getCodeRegion();
633ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu
6347090ae1a984eb446a5fb4da7b1f2573830653799Ted Kremenek  /// getAllocaRegion - Retrieve a region associated with a call to alloca().
635d05552a21377f493c882298c59e8829040b01d34Ted Kremenek  AllocaRegion *getAllocaRegion(const Expr* Ex, unsigned Cnt);
6367090ae1a984eb446a5fb4da7b1f2573830653799Ted Kremenek
637329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek  /// getCompoundLiteralRegion - Retrieve the region associated with a
638329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek  ///  given CompoundLiteral.
639329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek  CompoundLiteralRegion*
640329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek  getCompoundLiteralRegion(const CompoundLiteralExpr* CL);
641329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek
642993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek  /// getSymbolicRegion - Retrieve or create a "symbolic" memory region.
643e0e4ebf6bfca5a71b2344d8a1b748b852509279cTed Kremenek  SymbolicRegion* getSymbolicRegion(SymbolRef sym);
644e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu
645e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu  StringRegion* getStringRegion(const StringLiteral* Str);
646e9f4e5420895a75dd788e9891921e7781c1823b9Zhongxing Xu
6479e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  /// getVarRegion - Retrieve or create the memory region associated with
6489a1f03afc569abbdcc182379c99d1fe1ece67c9dTed Kremenek  ///  a specified VarDecl.
6499a1f03afc569abbdcc182379c99d1fe1ece67c9dTed Kremenek  VarRegion* getVarRegion(const VarDecl* vd);
650329d6fde79254503b14724e1231a9d70fa6b387fTed Kremenek
651f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek  /// getElementRegion - Retrieve the memory region associated with the
652f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek  ///  associated element type, index, and super region.
653f936f4568700d799e7d92eecef67b0e2b822ae7eTed Kremenek  ElementRegion* getElementRegion(QualType elementType, SVal Idx,
654143b2fc6fd3945c250b333383749010c2c8e3a4cZhongxing Xu                                  const MemRegion* superRegion,ASTContext &Ctx);
655511191ce8920160525611be2be754c32a0724c3eZhongxing Xu
6569e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  /// getFieldRegion - Retrieve or create the memory region associated with
6579e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  ///  a specified FieldDecl.  'superRegion' corresponds to the containing
6589e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  ///  memory region (which typically represents the memory representing
6599e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  ///  a structure or class).
660abb042f33ea8e6107a7dc8efc51d2ace329f9f48Ted Kremenek  FieldRegion* getFieldRegion(const FieldDecl* fd,
661abb042f33ea8e6107a7dc8efc51d2ace329f9f48Ted Kremenek                              const MemRegion* superRegion);
6629e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
663a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek  /// getObjCObjectRegion - Retrieve or create the memory region associated with
664a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek  ///  the instance of a specified Objective-C class.
665a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek  ObjCObjectRegion* getObjCObjectRegion(const ObjCInterfaceDecl* ID,
666a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek                                  const MemRegion* superRegion);
667a7f1b9e8804012ed8df25d93f5a06cb26c9bbd2bTed Kremenek
6689e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  /// getObjCIvarRegion - Retrieve or create the memory region associated with
6699e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  ///   a specified Objective-c instance variable.  'superRegion' corresponds
6709e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  ///   to the containing region (which typically represents the Objective-C
6719e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  ///   object).
6729e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  ObjCIvarRegion* getObjCIvarRegion(const ObjCIvarDecl* ivd,
673993f1c72913417be7c534ec7a634363cdfc84fa5Ted Kremenek                                    const MemRegion* superRegion);
674178927517fa09ddbb04dc8ef725b5716c18aae21Zhongxing Xu
675b2dea734527ae75281642a1c6ace28f9e00cab11Ted Kremenek  TypedViewRegion* getTypedViewRegion(QualType LValueType,
676b2dea734527ae75281642a1c6ace28f9e00cab11Ted Kremenek                                      const MemRegion* superRegion);
677dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu
678ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu  CodeTextRegion* getCodeTextRegion(SymbolRef sym, QualType t);
679ec13d9206645af07ef7c571405893b8d901de151Zhongxing Xu  CodeTextRegion* getCodeTextRegion(const FunctionDecl* fd, QualType t);
680250101353b711a409b075f1bc11070dddec7100bTed Kremenek
681250101353b711a409b075f1bc11070dddec7100bTed Kremenek  template <typename RegionTy, typename A1>
682250101353b711a409b075f1bc11070dddec7100bTed Kremenek  RegionTy* getRegion(const A1 a1);
6836304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek
6846304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek  template <typename RegionTy, typename A1>
6856304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek  RegionTy* getRegion(const A1 a1, const MemRegion* superRegion);
6867ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek
6877ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek  template <typename RegionTy, typename A1, typename A2>
6887ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek  RegionTy* getRegion(const A1 a1, const A2 a2);
689dc0a25d9bff956cdbe54ea0bfc8fbbe3ceb4eb92Zhongxing Xu
690dd198f04897df87c52fef66398035cbf67fdc33dZhongxing Xu  bool isGlobalsRegion(const MemRegion* R) {
691dd198f04897df87c52fef66398035cbf67fdc33dZhongxing Xu    assert(R);
692dd198f04897df87c52fef66398035cbf67fdc33dZhongxing Xu    return R == globals;
693dd198f04897df87c52fef66398035cbf67fdc33dZhongxing Xu  }
694dd198f04897df87c52fef66398035cbf67fdc33dZhongxing Xu
6959e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenekprivate:
6969e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek  MemSpaceRegion* LazyAllocate(MemSpaceRegion*& region);
697ed65d3d97132fbcdd124aef4d2478e348dfbd36bTed Kremenek};
698250101353b711a409b075f1bc11070dddec7100bTed Kremenek
699250101353b711a409b075f1bc11070dddec7100bTed Kremenek//===----------------------------------------------------------------------===//
700a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek// Out-of-line member definitions.
701250101353b711a409b075f1bc11070dddec7100bTed Kremenek//===----------------------------------------------------------------------===//
702250101353b711a409b075f1bc11070dddec7100bTed Kremenek
703a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenekinline ASTContext& MemRegion::getContext() const {
704a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek  return getMemRegionManager()->getContext();
705a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek}
706a43484afda4c4fb4b23a53a2dc91d985d39dc2c4Ted Kremenek
707250101353b711a409b075f1bc11070dddec7100bTed Kremenektemplate<typename RegionTy> struct MemRegionManagerTrait;
708250101353b711a409b075f1bc11070dddec7100bTed Kremenek
709250101353b711a409b075f1bc11070dddec7100bTed Kremenektemplate <typename RegionTy, typename A1>
710250101353b711a409b075f1bc11070dddec7100bTed KremenekRegionTy* MemRegionManager::getRegion(const A1 a1) {
711250101353b711a409b075f1bc11070dddec7100bTed Kremenek
712250101353b711a409b075f1bc11070dddec7100bTed Kremenek  const typename MemRegionManagerTrait<RegionTy>::SuperRegionTy *superRegion =
713250101353b711a409b075f1bc11070dddec7100bTed Kremenek    MemRegionManagerTrait<RegionTy>::getSuperRegion(*this, a1);
714250101353b711a409b075f1bc11070dddec7100bTed Kremenek
715250101353b711a409b075f1bc11070dddec7100bTed Kremenek  llvm::FoldingSetNodeID ID;
716250101353b711a409b075f1bc11070dddec7100bTed Kremenek  RegionTy::ProfileRegion(ID, a1, superRegion);
717250101353b711a409b075f1bc11070dddec7100bTed Kremenek  void* InsertPos;
718250101353b711a409b075f1bc11070dddec7100bTed Kremenek  RegionTy* R = cast_or_null<RegionTy>(Regions.FindNodeOrInsertPos(ID,
719250101353b711a409b075f1bc11070dddec7100bTed Kremenek                                                                   InsertPos));
720250101353b711a409b075f1bc11070dddec7100bTed Kremenek
721250101353b711a409b075f1bc11070dddec7100bTed Kremenek  if (!R) {
7226304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek    R = (RegionTy*) A.Allocate<RegionTy>();
7236304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek    new (R) RegionTy(a1, superRegion);
7246304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek    Regions.InsertNode(R, InsertPos);
7256304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek  }
7266304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek
7276304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek  return R;
7286304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek}
7296304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek
7306304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenektemplate <typename RegionTy, typename A1>
7316304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed KremenekRegionTy* MemRegionManager::getRegion(const A1 a1, const MemRegion *superRegion)
7326304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek{
7336304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek  llvm::FoldingSetNodeID ID;
7346304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek  RegionTy::ProfileRegion(ID, a1, superRegion);
7356304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek  void* InsertPos;
7366304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek  RegionTy* R = cast_or_null<RegionTy>(Regions.FindNodeOrInsertPos(ID,
7376304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek                                                                   InsertPos));
7386304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek
7396304b08daee27b25ae2e2bdb8bffd67dfad74b3cTed Kremenek  if (!R) {
740250101353b711a409b075f1bc11070dddec7100bTed Kremenek    R = (RegionTy*) A.Allocate<RegionTy>();
741250101353b711a409b075f1bc11070dddec7100bTed Kremenek    new (R) RegionTy(a1, superRegion);
742250101353b711a409b075f1bc11070dddec7100bTed Kremenek    Regions.InsertNode(R, InsertPos);
743250101353b711a409b075f1bc11070dddec7100bTed Kremenek  }
744250101353b711a409b075f1bc11070dddec7100bTed Kremenek
745250101353b711a409b075f1bc11070dddec7100bTed Kremenek  return R;
746250101353b711a409b075f1bc11070dddec7100bTed Kremenek}
747250101353b711a409b075f1bc11070dddec7100bTed Kremenek
7487ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenektemplate <typename RegionTy, typename A1, typename A2>
7497ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed KremenekRegionTy* MemRegionManager::getRegion(const A1 a1, const A2 a2) {
7507ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek
7517ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek  const typename MemRegionManagerTrait<RegionTy>::SuperRegionTy *superRegion =
7527ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek    MemRegionManagerTrait<RegionTy>::getSuperRegion(*this, a1, a2);
7537ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek
7547ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek  llvm::FoldingSetNodeID ID;
7557ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek  RegionTy::ProfileRegion(ID, a1, a2, superRegion);
7567ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek  void* InsertPos;
7577ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek  RegionTy* R = cast_or_null<RegionTy>(Regions.FindNodeOrInsertPos(ID,
7587ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek                                                                   InsertPos));
7597ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek
7607ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek  if (!R) {
7617ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek    R = (RegionTy*) A.Allocate<RegionTy>();
7627ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek    new (R) RegionTy(a1, a2, superRegion);
7637ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek    Regions.InsertNode(R, InsertPos);
7647ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek  }
7657ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek
7667ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek  return R;
7677ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek}
7687ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek
769250101353b711a409b075f1bc11070dddec7100bTed Kremenek//===----------------------------------------------------------------------===//
770250101353b711a409b075f1bc11070dddec7100bTed Kremenek// Traits for constructing regions.
771250101353b711a409b075f1bc11070dddec7100bTed Kremenek//===----------------------------------------------------------------------===//
772250101353b711a409b075f1bc11070dddec7100bTed Kremenek
7737ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenektemplate <> struct MemRegionManagerTrait<AllocaRegion> {
7747ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek  typedef MemRegion SuperRegionTy;
7757ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek  static const SuperRegionTy* getSuperRegion(MemRegionManager& MRMgr,
7767ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek                                             const Expr *, unsigned) {
7777ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek    return MRMgr.getStackRegion();
7787ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek  }
7797ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek};
7807ae7ad9951f032d0a33b64c964f7cdcb9cc6f59bTed Kremenek
781250101353b711a409b075f1bc11070dddec7100bTed Kremenektemplate <> struct MemRegionManagerTrait<CompoundLiteralRegion> {
782250101353b711a409b075f1bc11070dddec7100bTed Kremenek  typedef MemRegion SuperRegionTy;
783250101353b711a409b075f1bc11070dddec7100bTed Kremenek  static const SuperRegionTy* getSuperRegion(MemRegionManager& MRMgr,
784250101353b711a409b075f1bc11070dddec7100bTed Kremenek                                             const CompoundLiteralExpr *CL) {
785250101353b711a409b075f1bc11070dddec7100bTed Kremenek
786250101353b711a409b075f1bc11070dddec7100bTed Kremenek    return CL->isFileScope() ? MRMgr.getGlobalsRegion()
787250101353b711a409b075f1bc11070dddec7100bTed Kremenek                             : MRMgr.getStackRegion();
788250101353b711a409b075f1bc11070dddec7100bTed Kremenek  }
789250101353b711a409b075f1bc11070dddec7100bTed Kremenek};
790250101353b711a409b075f1bc11070dddec7100bTed Kremenek
791250101353b711a409b075f1bc11070dddec7100bTed Kremenektemplate <> struct MemRegionManagerTrait<StringRegion> {
792250101353b711a409b075f1bc11070dddec7100bTed Kremenek  typedef MemSpaceRegion SuperRegionTy;
793250101353b711a409b075f1bc11070dddec7100bTed Kremenek  static const SuperRegionTy* getSuperRegion(MemRegionManager& MRMgr,
794250101353b711a409b075f1bc11070dddec7100bTed Kremenek                                             const StringLiteral*) {
795250101353b711a409b075f1bc11070dddec7100bTed Kremenek    return MRMgr.getGlobalsRegion();
796250101353b711a409b075f1bc11070dddec7100bTed Kremenek  }
797250101353b711a409b075f1bc11070dddec7100bTed Kremenek};
798250101353b711a409b075f1bc11070dddec7100bTed Kremenek
799250101353b711a409b075f1bc11070dddec7100bTed Kremenektemplate <> struct MemRegionManagerTrait<VarRegion> {
800250101353b711a409b075f1bc11070dddec7100bTed Kremenek  typedef MemRegion SuperRegionTy;
801250101353b711a409b075f1bc11070dddec7100bTed Kremenek  static const SuperRegionTy* getSuperRegion(MemRegionManager& MRMgr,
802250101353b711a409b075f1bc11070dddec7100bTed Kremenek                                             const VarDecl *d) {
803d05552a21377f493c882298c59e8829040b01d34Ted Kremenek    if (d->hasLocalStorage()) {
804d05552a21377f493c882298c59e8829040b01d34Ted Kremenek      return isa<ParmVarDecl>(d) || isa<ImplicitParamDecl>(d)
805d05552a21377f493c882298c59e8829040b01d34Ted Kremenek             ? MRMgr.getStackArgumentsRegion() : MRMgr.getStackRegion();
806d05552a21377f493c882298c59e8829040b01d34Ted Kremenek    }
807d05552a21377f493c882298c59e8829040b01d34Ted Kremenek
808d05552a21377f493c882298c59e8829040b01d34Ted Kremenek    return MRMgr.getGlobalsRegion();
809250101353b711a409b075f1bc11070dddec7100bTed Kremenek  }
810250101353b711a409b075f1bc11070dddec7100bTed Kremenek};
811250101353b711a409b075f1bc11070dddec7100bTed Kremenek
812250101353b711a409b075f1bc11070dddec7100bTed Kremenektemplate <> struct MemRegionManagerTrait<SymbolicRegion> {
813250101353b711a409b075f1bc11070dddec7100bTed Kremenek  typedef MemRegion SuperRegionTy;
814250101353b711a409b075f1bc11070dddec7100bTed Kremenek  static const SuperRegionTy* getSuperRegion(MemRegionManager& MRMgr,
815250101353b711a409b075f1bc11070dddec7100bTed Kremenek                                             SymbolRef) {
816250101353b711a409b075f1bc11070dddec7100bTed Kremenek    return MRMgr.getUnknownRegion();
817250101353b711a409b075f1bc11070dddec7100bTed Kremenek  }
818250101353b711a409b075f1bc11070dddec7100bTed Kremenek};
8190dea5241bca707789d706ed1fda3a29a8fedc4c0Zhongxing Xu
8200dea5241bca707789d706ed1fda3a29a8fedc4c0Zhongxing Xutemplate<> struct MemRegionManagerTrait<CodeTextRegion> {
8210dea5241bca707789d706ed1fda3a29a8fedc4c0Zhongxing Xu  typedef MemSpaceRegion SuperRegionTy;
8220dea5241bca707789d706ed1fda3a29a8fedc4c0Zhongxing Xu  static const SuperRegionTy* getSuperRegion(MemRegionManager& MRMgr,
8230dea5241bca707789d706ed1fda3a29a8fedc4c0Zhongxing Xu                                             const FunctionDecl*, QualType) {
8240dea5241bca707789d706ed1fda3a29a8fedc4c0Zhongxing Xu    return MRMgr.getCodeRegion();
8250dea5241bca707789d706ed1fda3a29a8fedc4c0Zhongxing Xu  }
8260dea5241bca707789d706ed1fda3a29a8fedc4c0Zhongxing Xu  static const SuperRegionTy* getSuperRegion(MemRegionManager& MRMgr,
8270dea5241bca707789d706ed1fda3a29a8fedc4c0Zhongxing Xu                                             SymbolRef, QualType) {
8280dea5241bca707789d706ed1fda3a29a8fedc4c0Zhongxing Xu    return MRMgr.getCodeRegion();
8290dea5241bca707789d706ed1fda3a29a8fedc4c0Zhongxing Xu  }
8300dea5241bca707789d706ed1fda3a29a8fedc4c0Zhongxing Xu};
831250101353b711a409b075f1bc11070dddec7100bTed Kremenek
832be91224894e1501133e224934285ba6440bf5b59Ted Kremenek} // end clang namespace
8339e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
834250101353b711a409b075f1bc11070dddec7100bTed Kremenek//===----------------------------------------------------------------------===//
835250101353b711a409b075f1bc11070dddec7100bTed Kremenek// Pretty-printing regions.
836250101353b711a409b075f1bc11070dddec7100bTed Kremenek//===----------------------------------------------------------------------===//
837250101353b711a409b075f1bc11070dddec7100bTed Kremenek
838be91224894e1501133e224934285ba6440bf5b59Ted Kremeneknamespace llvm {
839be91224894e1501133e224934285ba6440bf5b59Ted Kremenekstatic inline raw_ostream& operator<<(raw_ostream& O,
840be91224894e1501133e224934285ba6440bf5b59Ted Kremenek                                      const clang::MemRegion* R) {
841be91224894e1501133e224934285ba6440bf5b59Ted Kremenek  R->print(O);
842be91224894e1501133e224934285ba6440bf5b59Ted Kremenek  return O;
843be91224894e1501133e224934285ba6440bf5b59Ted Kremenek}
844be91224894e1501133e224934285ba6440bf5b59Ted Kremenek} // end llvm namespace
8459e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek
8469e24049bef26b6289cce9ac9b483c5cbb096e3aeTed Kremenek#endif
847