xref: /openbsd-src/gnu/llvm/clang/lib/StaticAnalyzer/Core/MemRegion.cpp (revision 12c855180aad702bbcca06e0398d774beeafb155)
1e5dd7070Spatrick //===- MemRegion.cpp - Abstract memory regions for static analysis --------===//
2e5dd7070Spatrick //
3e5dd7070Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4e5dd7070Spatrick // See https://llvm.org/LICENSE.txt for license information.
5e5dd7070Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6e5dd7070Spatrick //
7e5dd7070Spatrick //===----------------------------------------------------------------------===//
8e5dd7070Spatrick //
9e5dd7070Spatrick //  This file defines MemRegion and its subclasses.  MemRegion defines a
10e5dd7070Spatrick //  partially-typed abstraction of memory useful for path-sensitive dataflow
11e5dd7070Spatrick //  analyses.
12e5dd7070Spatrick //
13e5dd7070Spatrick //===----------------------------------------------------------------------===//
14e5dd7070Spatrick 
15e5dd7070Spatrick #include "clang/StaticAnalyzer/Core/PathSensitive/MemRegion.h"
16e5dd7070Spatrick #include "clang/AST/ASTContext.h"
17e5dd7070Spatrick #include "clang/AST/Attr.h"
18e5dd7070Spatrick #include "clang/AST/CharUnits.h"
19e5dd7070Spatrick #include "clang/AST/Decl.h"
20e5dd7070Spatrick #include "clang/AST/DeclCXX.h"
21e5dd7070Spatrick #include "clang/AST/DeclObjC.h"
22e5dd7070Spatrick #include "clang/AST/Expr.h"
23e5dd7070Spatrick #include "clang/AST/PrettyPrinter.h"
24e5dd7070Spatrick #include "clang/AST/RecordLayout.h"
25e5dd7070Spatrick #include "clang/AST/Type.h"
26e5dd7070Spatrick #include "clang/Analysis/AnalysisDeclContext.h"
27e5dd7070Spatrick #include "clang/Analysis/Support/BumpVector.h"
28e5dd7070Spatrick #include "clang/Basic/IdentifierTable.h"
29e5dd7070Spatrick #include "clang/Basic/LLVM.h"
30e5dd7070Spatrick #include "clang/Basic/SourceManager.h"
31*12c85518Srobert #include "clang/StaticAnalyzer/Core/AnalyzerOptions.h"
32a9ac8606Spatrick #include "clang/StaticAnalyzer/Core/PathSensitive/DynamicExtent.h"
33e5dd7070Spatrick #include "clang/StaticAnalyzer/Core/PathSensitive/SValBuilder.h"
34e5dd7070Spatrick #include "clang/StaticAnalyzer/Core/PathSensitive/SVals.h"
35e5dd7070Spatrick #include "clang/StaticAnalyzer/Core/PathSensitive/SymbolManager.h"
36e5dd7070Spatrick #include "llvm/ADT/APInt.h"
37e5dd7070Spatrick #include "llvm/ADT/FoldingSet.h"
38e5dd7070Spatrick #include "llvm/ADT/PointerUnion.h"
39e5dd7070Spatrick #include "llvm/ADT/SmallString.h"
40e5dd7070Spatrick #include "llvm/ADT/StringRef.h"
41e5dd7070Spatrick #include "llvm/ADT/Twine.h"
42e5dd7070Spatrick #include "llvm/Support/Allocator.h"
43e5dd7070Spatrick #include "llvm/Support/Casting.h"
44e5dd7070Spatrick #include "llvm/Support/CheckedArithmetic.h"
45e5dd7070Spatrick #include "llvm/Support/Compiler.h"
46e5dd7070Spatrick #include "llvm/Support/Debug.h"
47e5dd7070Spatrick #include "llvm/Support/ErrorHandling.h"
48e5dd7070Spatrick #include "llvm/Support/raw_ostream.h"
49e5dd7070Spatrick #include <cassert>
50e5dd7070Spatrick #include <cstdint>
51e5dd7070Spatrick #include <functional>
52e5dd7070Spatrick #include <iterator>
53*12c85518Srobert #include <optional>
54e5dd7070Spatrick #include <string>
55e5dd7070Spatrick #include <tuple>
56e5dd7070Spatrick #include <utility>
57e5dd7070Spatrick 
58e5dd7070Spatrick using namespace clang;
59e5dd7070Spatrick using namespace ento;
60e5dd7070Spatrick 
61e5dd7070Spatrick #define DEBUG_TYPE "MemRegion"
62e5dd7070Spatrick 
63e5dd7070Spatrick //===----------------------------------------------------------------------===//
64e5dd7070Spatrick // MemRegion Construction.
65e5dd7070Spatrick //===----------------------------------------------------------------------===//
66e5dd7070Spatrick 
67e5dd7070Spatrick template <typename RegionTy, typename SuperTy, typename Arg1Ty>
getSubRegion(const Arg1Ty arg1,const SuperTy * superRegion)68e5dd7070Spatrick RegionTy* MemRegionManager::getSubRegion(const Arg1Ty arg1,
69e5dd7070Spatrick                                          const SuperTy *superRegion) {
70e5dd7070Spatrick   llvm::FoldingSetNodeID ID;
71e5dd7070Spatrick   RegionTy::ProfileRegion(ID, arg1, superRegion);
72e5dd7070Spatrick   void *InsertPos;
73e5dd7070Spatrick   auto *R = cast_or_null<RegionTy>(Regions.FindNodeOrInsertPos(ID, InsertPos));
74e5dd7070Spatrick 
75e5dd7070Spatrick   if (!R) {
76e5dd7070Spatrick     R = A.Allocate<RegionTy>();
77e5dd7070Spatrick     new (R) RegionTy(arg1, superRegion);
78e5dd7070Spatrick     Regions.InsertNode(R, InsertPos);
79e5dd7070Spatrick   }
80e5dd7070Spatrick 
81e5dd7070Spatrick   return R;
82e5dd7070Spatrick }
83e5dd7070Spatrick 
84e5dd7070Spatrick template <typename RegionTy, typename SuperTy, typename Arg1Ty, typename Arg2Ty>
getSubRegion(const Arg1Ty arg1,const Arg2Ty arg2,const SuperTy * superRegion)85e5dd7070Spatrick RegionTy* MemRegionManager::getSubRegion(const Arg1Ty arg1, const Arg2Ty arg2,
86e5dd7070Spatrick                                          const SuperTy *superRegion) {
87e5dd7070Spatrick   llvm::FoldingSetNodeID ID;
88e5dd7070Spatrick   RegionTy::ProfileRegion(ID, arg1, arg2, superRegion);
89e5dd7070Spatrick   void *InsertPos;
90e5dd7070Spatrick   auto *R = cast_or_null<RegionTy>(Regions.FindNodeOrInsertPos(ID, InsertPos));
91e5dd7070Spatrick 
92e5dd7070Spatrick   if (!R) {
93e5dd7070Spatrick     R = A.Allocate<RegionTy>();
94e5dd7070Spatrick     new (R) RegionTy(arg1, arg2, superRegion);
95e5dd7070Spatrick     Regions.InsertNode(R, InsertPos);
96e5dd7070Spatrick   }
97e5dd7070Spatrick 
98e5dd7070Spatrick   return R;
99e5dd7070Spatrick }
100e5dd7070Spatrick 
101e5dd7070Spatrick template <typename RegionTy, typename SuperTy,
102e5dd7070Spatrick           typename Arg1Ty, typename Arg2Ty, typename Arg3Ty>
getSubRegion(const Arg1Ty arg1,const Arg2Ty arg2,const Arg3Ty arg3,const SuperTy * superRegion)103e5dd7070Spatrick RegionTy* MemRegionManager::getSubRegion(const Arg1Ty arg1, const Arg2Ty arg2,
104e5dd7070Spatrick                                          const Arg3Ty arg3,
105e5dd7070Spatrick                                          const SuperTy *superRegion) {
106e5dd7070Spatrick   llvm::FoldingSetNodeID ID;
107e5dd7070Spatrick   RegionTy::ProfileRegion(ID, arg1, arg2, arg3, superRegion);
108e5dd7070Spatrick   void *InsertPos;
109e5dd7070Spatrick   auto *R = cast_or_null<RegionTy>(Regions.FindNodeOrInsertPos(ID, InsertPos));
110e5dd7070Spatrick 
111e5dd7070Spatrick   if (!R) {
112e5dd7070Spatrick     R = A.Allocate<RegionTy>();
113e5dd7070Spatrick     new (R) RegionTy(arg1, arg2, arg3, superRegion);
114e5dd7070Spatrick     Regions.InsertNode(R, InsertPos);
115e5dd7070Spatrick   }
116e5dd7070Spatrick 
117e5dd7070Spatrick   return R;
118e5dd7070Spatrick }
119e5dd7070Spatrick 
120e5dd7070Spatrick //===----------------------------------------------------------------------===//
121e5dd7070Spatrick // Object destruction.
122e5dd7070Spatrick //===----------------------------------------------------------------------===//
123e5dd7070Spatrick 
124e5dd7070Spatrick MemRegion::~MemRegion() = default;
125e5dd7070Spatrick 
126e5dd7070Spatrick // All regions and their data are BumpPtrAllocated.  No need to call their
127e5dd7070Spatrick // destructors.
128e5dd7070Spatrick MemRegionManager::~MemRegionManager() = default;
129e5dd7070Spatrick 
130e5dd7070Spatrick //===----------------------------------------------------------------------===//
131e5dd7070Spatrick // Basic methods.
132e5dd7070Spatrick //===----------------------------------------------------------------------===//
133e5dd7070Spatrick 
isSubRegionOf(const MemRegion * R) const134e5dd7070Spatrick bool SubRegion::isSubRegionOf(const MemRegion* R) const {
135e5dd7070Spatrick   const MemRegion* r = this;
136e5dd7070Spatrick   do {
137e5dd7070Spatrick     if (r == R)
138e5dd7070Spatrick       return true;
139e5dd7070Spatrick     if (const auto *sr = dyn_cast<SubRegion>(r))
140e5dd7070Spatrick       r = sr->getSuperRegion();
141e5dd7070Spatrick     else
142e5dd7070Spatrick       break;
143e5dd7070Spatrick   } while (r != nullptr);
144e5dd7070Spatrick   return false;
145e5dd7070Spatrick }
146e5dd7070Spatrick 
getMemRegionManager() const147ec727ea7Spatrick MemRegionManager &SubRegion::getMemRegionManager() const {
148e5dd7070Spatrick   const SubRegion* r = this;
149e5dd7070Spatrick   do {
150e5dd7070Spatrick     const MemRegion *superRegion = r->getSuperRegion();
151e5dd7070Spatrick     if (const auto *sr = dyn_cast<SubRegion>(superRegion)) {
152e5dd7070Spatrick       r = sr;
153e5dd7070Spatrick       continue;
154e5dd7070Spatrick     }
155e5dd7070Spatrick     return superRegion->getMemRegionManager();
156e5dd7070Spatrick   } while (true);
157e5dd7070Spatrick }
158e5dd7070Spatrick 
getStackFrame() const159e5dd7070Spatrick const StackFrameContext *VarRegion::getStackFrame() const {
160e5dd7070Spatrick   const auto *SSR = dyn_cast<StackSpaceRegion>(getMemorySpace());
161e5dd7070Spatrick   return SSR ? SSR->getStackFrame() : nullptr;
162e5dd7070Spatrick }
163e5dd7070Spatrick 
ObjCIvarRegion(const ObjCIvarDecl * ivd,const SubRegion * sReg)164e5dd7070Spatrick ObjCIvarRegion::ObjCIvarRegion(const ObjCIvarDecl *ivd, const SubRegion *sReg)
165*12c85518Srobert     : DeclRegion(sReg, ObjCIvarRegionKind), IVD(ivd) {
166*12c85518Srobert   assert(IVD);
167*12c85518Srobert }
168e5dd7070Spatrick 
getDecl() const169ec727ea7Spatrick const ObjCIvarDecl *ObjCIvarRegion::getDecl() const { return IVD; }
170e5dd7070Spatrick 
getValueType() const171e5dd7070Spatrick QualType ObjCIvarRegion::getValueType() const {
172e5dd7070Spatrick   return getDecl()->getType();
173e5dd7070Spatrick }
174e5dd7070Spatrick 
getValueType() const175e5dd7070Spatrick QualType CXXBaseObjectRegion::getValueType() const {
176e5dd7070Spatrick   return QualType(getDecl()->getTypeForDecl(), 0);
177e5dd7070Spatrick }
178e5dd7070Spatrick 
getValueType() const179e5dd7070Spatrick QualType CXXDerivedObjectRegion::getValueType() const {
180e5dd7070Spatrick   return QualType(getDecl()->getTypeForDecl(), 0);
181e5dd7070Spatrick }
182e5dd7070Spatrick 
getValueType() const183ec727ea7Spatrick QualType ParamVarRegion::getValueType() const {
184ec727ea7Spatrick   assert(getDecl() &&
185ec727ea7Spatrick          "`ParamVarRegion` support functions without `Decl` not implemented"
186ec727ea7Spatrick          " yet.");
187ec727ea7Spatrick   return getDecl()->getType();
188ec727ea7Spatrick }
189ec727ea7Spatrick 
getDecl() const190ec727ea7Spatrick const ParmVarDecl *ParamVarRegion::getDecl() const {
191ec727ea7Spatrick   const Decl *D = getStackFrame()->getDecl();
192ec727ea7Spatrick 
193ec727ea7Spatrick   if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
194ec727ea7Spatrick     assert(Index < FD->param_size());
195ec727ea7Spatrick     return FD->parameters()[Index];
196ec727ea7Spatrick   } else if (const auto *BD = dyn_cast<BlockDecl>(D)) {
197ec727ea7Spatrick     assert(Index < BD->param_size());
198ec727ea7Spatrick     return BD->parameters()[Index];
199ec727ea7Spatrick   } else if (const auto *MD = dyn_cast<ObjCMethodDecl>(D)) {
200ec727ea7Spatrick     assert(Index < MD->param_size());
201ec727ea7Spatrick     return MD->parameters()[Index];
202ec727ea7Spatrick   } else if (const auto *CD = dyn_cast<CXXConstructorDecl>(D)) {
203ec727ea7Spatrick     assert(Index < CD->param_size());
204ec727ea7Spatrick     return CD->parameters()[Index];
205ec727ea7Spatrick   } else {
206ec727ea7Spatrick     llvm_unreachable("Unexpected Decl kind!");
207ec727ea7Spatrick   }
208ec727ea7Spatrick }
209ec727ea7Spatrick 
210e5dd7070Spatrick //===----------------------------------------------------------------------===//
211e5dd7070Spatrick // FoldingSet profiling.
212e5dd7070Spatrick //===----------------------------------------------------------------------===//
213e5dd7070Spatrick 
Profile(llvm::FoldingSetNodeID & ID) const214e5dd7070Spatrick void MemSpaceRegion::Profile(llvm::FoldingSetNodeID &ID) const {
215e5dd7070Spatrick   ID.AddInteger(static_cast<unsigned>(getKind()));
216e5dd7070Spatrick }
217e5dd7070Spatrick 
Profile(llvm::FoldingSetNodeID & ID) const218e5dd7070Spatrick void StackSpaceRegion::Profile(llvm::FoldingSetNodeID &ID) const {
219e5dd7070Spatrick   ID.AddInteger(static_cast<unsigned>(getKind()));
220e5dd7070Spatrick   ID.AddPointer(getStackFrame());
221e5dd7070Spatrick }
222e5dd7070Spatrick 
Profile(llvm::FoldingSetNodeID & ID) const223e5dd7070Spatrick void StaticGlobalSpaceRegion::Profile(llvm::FoldingSetNodeID &ID) const {
224e5dd7070Spatrick   ID.AddInteger(static_cast<unsigned>(getKind()));
225e5dd7070Spatrick   ID.AddPointer(getCodeRegion());
226e5dd7070Spatrick }
227e5dd7070Spatrick 
ProfileRegion(llvm::FoldingSetNodeID & ID,const StringLiteral * Str,const MemRegion * superRegion)228e5dd7070Spatrick void StringRegion::ProfileRegion(llvm::FoldingSetNodeID &ID,
229e5dd7070Spatrick                                  const StringLiteral *Str,
230e5dd7070Spatrick                                  const MemRegion *superRegion) {
231e5dd7070Spatrick   ID.AddInteger(static_cast<unsigned>(StringRegionKind));
232e5dd7070Spatrick   ID.AddPointer(Str);
233e5dd7070Spatrick   ID.AddPointer(superRegion);
234e5dd7070Spatrick }
235e5dd7070Spatrick 
ProfileRegion(llvm::FoldingSetNodeID & ID,const ObjCStringLiteral * Str,const MemRegion * superRegion)236e5dd7070Spatrick void ObjCStringRegion::ProfileRegion(llvm::FoldingSetNodeID &ID,
237e5dd7070Spatrick                                      const ObjCStringLiteral *Str,
238e5dd7070Spatrick                                      const MemRegion *superRegion) {
239e5dd7070Spatrick   ID.AddInteger(static_cast<unsigned>(ObjCStringRegionKind));
240e5dd7070Spatrick   ID.AddPointer(Str);
241e5dd7070Spatrick   ID.AddPointer(superRegion);
242e5dd7070Spatrick }
243e5dd7070Spatrick 
ProfileRegion(llvm::FoldingSetNodeID & ID,const Expr * Ex,unsigned cnt,const MemRegion * superRegion)244e5dd7070Spatrick void AllocaRegion::ProfileRegion(llvm::FoldingSetNodeID& ID,
245e5dd7070Spatrick                                  const Expr *Ex, unsigned cnt,
246e5dd7070Spatrick                                  const MemRegion *superRegion) {
247e5dd7070Spatrick   ID.AddInteger(static_cast<unsigned>(AllocaRegionKind));
248e5dd7070Spatrick   ID.AddPointer(Ex);
249e5dd7070Spatrick   ID.AddInteger(cnt);
250e5dd7070Spatrick   ID.AddPointer(superRegion);
251e5dd7070Spatrick }
252e5dd7070Spatrick 
Profile(llvm::FoldingSetNodeID & ID) const253e5dd7070Spatrick void AllocaRegion::Profile(llvm::FoldingSetNodeID& ID) const {
254e5dd7070Spatrick   ProfileRegion(ID, Ex, Cnt, superRegion);
255e5dd7070Spatrick }
256e5dd7070Spatrick 
Profile(llvm::FoldingSetNodeID & ID) const257e5dd7070Spatrick void CompoundLiteralRegion::Profile(llvm::FoldingSetNodeID& ID) const {
258e5dd7070Spatrick   CompoundLiteralRegion::ProfileRegion(ID, CL, superRegion);
259e5dd7070Spatrick }
260e5dd7070Spatrick 
ProfileRegion(llvm::FoldingSetNodeID & ID,const CompoundLiteralExpr * CL,const MemRegion * superRegion)261e5dd7070Spatrick void CompoundLiteralRegion::ProfileRegion(llvm::FoldingSetNodeID& ID,
262e5dd7070Spatrick                                           const CompoundLiteralExpr *CL,
263e5dd7070Spatrick                                           const MemRegion* superRegion) {
264e5dd7070Spatrick   ID.AddInteger(static_cast<unsigned>(CompoundLiteralRegionKind));
265e5dd7070Spatrick   ID.AddPointer(CL);
266e5dd7070Spatrick   ID.AddPointer(superRegion);
267e5dd7070Spatrick }
268e5dd7070Spatrick 
ProfileRegion(llvm::FoldingSetNodeID & ID,const PointerType * PT,const MemRegion * sRegion)269e5dd7070Spatrick void CXXThisRegion::ProfileRegion(llvm::FoldingSetNodeID &ID,
270e5dd7070Spatrick                                   const PointerType *PT,
271e5dd7070Spatrick                                   const MemRegion *sRegion) {
272e5dd7070Spatrick   ID.AddInteger(static_cast<unsigned>(CXXThisRegionKind));
273e5dd7070Spatrick   ID.AddPointer(PT);
274e5dd7070Spatrick   ID.AddPointer(sRegion);
275e5dd7070Spatrick }
276e5dd7070Spatrick 
Profile(llvm::FoldingSetNodeID & ID) const277e5dd7070Spatrick void CXXThisRegion::Profile(llvm::FoldingSetNodeID &ID) const {
278e5dd7070Spatrick   CXXThisRegion::ProfileRegion(ID, ThisPointerTy, superRegion);
279e5dd7070Spatrick }
280e5dd7070Spatrick 
Profile(llvm::FoldingSetNodeID & ID) const281ec727ea7Spatrick void FieldRegion::Profile(llvm::FoldingSetNodeID &ID) const {
282ec727ea7Spatrick   ProfileRegion(ID, getDecl(), superRegion);
283ec727ea7Spatrick }
284ec727ea7Spatrick 
ProfileRegion(llvm::FoldingSetNodeID & ID,const ObjCIvarDecl * ivd,const MemRegion * superRegion)285e5dd7070Spatrick void ObjCIvarRegion::ProfileRegion(llvm::FoldingSetNodeID& ID,
286e5dd7070Spatrick                                    const ObjCIvarDecl *ivd,
287e5dd7070Spatrick                                    const MemRegion* superRegion) {
288ec727ea7Spatrick   ID.AddInteger(static_cast<unsigned>(ObjCIvarRegionKind));
289ec727ea7Spatrick   ID.AddPointer(ivd);
290e5dd7070Spatrick   ID.AddPointer(superRegion);
291e5dd7070Spatrick }
292e5dd7070Spatrick 
Profile(llvm::FoldingSetNodeID & ID) const293ec727ea7Spatrick void ObjCIvarRegion::Profile(llvm::FoldingSetNodeID &ID) const {
294ec727ea7Spatrick   ProfileRegion(ID, getDecl(), superRegion);
295e5dd7070Spatrick }
296e5dd7070Spatrick 
ProfileRegion(llvm::FoldingSetNodeID & ID,const VarDecl * VD,const MemRegion * superRegion)297ec727ea7Spatrick void NonParamVarRegion::ProfileRegion(llvm::FoldingSetNodeID &ID,
298ec727ea7Spatrick                                       const VarDecl *VD,
299ec727ea7Spatrick                                       const MemRegion *superRegion) {
300ec727ea7Spatrick   ID.AddInteger(static_cast<unsigned>(NonParamVarRegionKind));
301ec727ea7Spatrick   ID.AddPointer(VD);
302ec727ea7Spatrick   ID.AddPointer(superRegion);
303ec727ea7Spatrick }
304ec727ea7Spatrick 
Profile(llvm::FoldingSetNodeID & ID) const305ec727ea7Spatrick void NonParamVarRegion::Profile(llvm::FoldingSetNodeID &ID) const {
306ec727ea7Spatrick   ProfileRegion(ID, getDecl(), superRegion);
307ec727ea7Spatrick }
308ec727ea7Spatrick 
ProfileRegion(llvm::FoldingSetNodeID & ID,const Expr * OE,unsigned Idx,const MemRegion * SReg)309ec727ea7Spatrick void ParamVarRegion::ProfileRegion(llvm::FoldingSetNodeID &ID, const Expr *OE,
310ec727ea7Spatrick                                    unsigned Idx, const MemRegion *SReg) {
311ec727ea7Spatrick   ID.AddInteger(static_cast<unsigned>(ParamVarRegionKind));
312ec727ea7Spatrick   ID.AddPointer(OE);
313ec727ea7Spatrick   ID.AddInteger(Idx);
314ec727ea7Spatrick   ID.AddPointer(SReg);
315ec727ea7Spatrick }
316ec727ea7Spatrick 
Profile(llvm::FoldingSetNodeID & ID) const317ec727ea7Spatrick void ParamVarRegion::Profile(llvm::FoldingSetNodeID &ID) const {
318ec727ea7Spatrick   ProfileRegion(ID, getOriginExpr(), getIndex(), superRegion);
319e5dd7070Spatrick }
320e5dd7070Spatrick 
ProfileRegion(llvm::FoldingSetNodeID & ID,SymbolRef sym,const MemRegion * sreg)321e5dd7070Spatrick void SymbolicRegion::ProfileRegion(llvm::FoldingSetNodeID& ID, SymbolRef sym,
322e5dd7070Spatrick                                    const MemRegion *sreg) {
323e5dd7070Spatrick   ID.AddInteger(static_cast<unsigned>(MemRegion::SymbolicRegionKind));
324e5dd7070Spatrick   ID.Add(sym);
325e5dd7070Spatrick   ID.AddPointer(sreg);
326e5dd7070Spatrick }
327e5dd7070Spatrick 
Profile(llvm::FoldingSetNodeID & ID) const328e5dd7070Spatrick void SymbolicRegion::Profile(llvm::FoldingSetNodeID& ID) const {
329e5dd7070Spatrick   SymbolicRegion::ProfileRegion(ID, sym, getSuperRegion());
330e5dd7070Spatrick }
331e5dd7070Spatrick 
ProfileRegion(llvm::FoldingSetNodeID & ID,QualType ElementType,SVal Idx,const MemRegion * superRegion)332e5dd7070Spatrick void ElementRegion::ProfileRegion(llvm::FoldingSetNodeID& ID,
333e5dd7070Spatrick                                   QualType ElementType, SVal Idx,
334e5dd7070Spatrick                                   const MemRegion* superRegion) {
335e5dd7070Spatrick   ID.AddInteger(MemRegion::ElementRegionKind);
336e5dd7070Spatrick   ID.Add(ElementType);
337e5dd7070Spatrick   ID.AddPointer(superRegion);
338e5dd7070Spatrick   Idx.Profile(ID);
339e5dd7070Spatrick }
340e5dd7070Spatrick 
Profile(llvm::FoldingSetNodeID & ID) const341e5dd7070Spatrick void ElementRegion::Profile(llvm::FoldingSetNodeID& ID) const {
342e5dd7070Spatrick   ElementRegion::ProfileRegion(ID, ElementType, Index, superRegion);
343e5dd7070Spatrick }
344e5dd7070Spatrick 
ProfileRegion(llvm::FoldingSetNodeID & ID,const NamedDecl * FD,const MemRegion *)345e5dd7070Spatrick void FunctionCodeRegion::ProfileRegion(llvm::FoldingSetNodeID& ID,
346e5dd7070Spatrick                                        const NamedDecl *FD,
347e5dd7070Spatrick                                        const MemRegion*) {
348e5dd7070Spatrick   ID.AddInteger(MemRegion::FunctionCodeRegionKind);
349e5dd7070Spatrick   ID.AddPointer(FD);
350e5dd7070Spatrick }
351e5dd7070Spatrick 
Profile(llvm::FoldingSetNodeID & ID) const352e5dd7070Spatrick void FunctionCodeRegion::Profile(llvm::FoldingSetNodeID& ID) const {
353e5dd7070Spatrick   FunctionCodeRegion::ProfileRegion(ID, FD, superRegion);
354e5dd7070Spatrick }
355e5dd7070Spatrick 
ProfileRegion(llvm::FoldingSetNodeID & ID,const BlockDecl * BD,CanQualType,const AnalysisDeclContext * AC,const MemRegion *)356e5dd7070Spatrick void BlockCodeRegion::ProfileRegion(llvm::FoldingSetNodeID& ID,
357e5dd7070Spatrick                                     const BlockDecl *BD, CanQualType,
358e5dd7070Spatrick                                     const AnalysisDeclContext *AC,
359e5dd7070Spatrick                                     const MemRegion*) {
360e5dd7070Spatrick   ID.AddInteger(MemRegion::BlockCodeRegionKind);
361e5dd7070Spatrick   ID.AddPointer(BD);
362e5dd7070Spatrick }
363e5dd7070Spatrick 
Profile(llvm::FoldingSetNodeID & ID) const364e5dd7070Spatrick void BlockCodeRegion::Profile(llvm::FoldingSetNodeID& ID) const {
365e5dd7070Spatrick   BlockCodeRegion::ProfileRegion(ID, BD, locTy, AC, superRegion);
366e5dd7070Spatrick }
367e5dd7070Spatrick 
ProfileRegion(llvm::FoldingSetNodeID & ID,const BlockCodeRegion * BC,const LocationContext * LC,unsigned BlkCount,const MemRegion * sReg)368e5dd7070Spatrick void BlockDataRegion::ProfileRegion(llvm::FoldingSetNodeID& ID,
369e5dd7070Spatrick                                     const BlockCodeRegion *BC,
370e5dd7070Spatrick                                     const LocationContext *LC,
371e5dd7070Spatrick                                     unsigned BlkCount,
372e5dd7070Spatrick                                     const MemRegion *sReg) {
373e5dd7070Spatrick   ID.AddInteger(MemRegion::BlockDataRegionKind);
374e5dd7070Spatrick   ID.AddPointer(BC);
375e5dd7070Spatrick   ID.AddPointer(LC);
376e5dd7070Spatrick   ID.AddInteger(BlkCount);
377e5dd7070Spatrick   ID.AddPointer(sReg);
378e5dd7070Spatrick }
379e5dd7070Spatrick 
Profile(llvm::FoldingSetNodeID & ID) const380e5dd7070Spatrick void BlockDataRegion::Profile(llvm::FoldingSetNodeID& ID) const {
381e5dd7070Spatrick   BlockDataRegion::ProfileRegion(ID, BC, LC, BlockCount, getSuperRegion());
382e5dd7070Spatrick }
383e5dd7070Spatrick 
ProfileRegion(llvm::FoldingSetNodeID & ID,Expr const * Ex,const MemRegion * sReg)384e5dd7070Spatrick void CXXTempObjectRegion::ProfileRegion(llvm::FoldingSetNodeID &ID,
385e5dd7070Spatrick                                         Expr const *Ex,
386e5dd7070Spatrick                                         const MemRegion *sReg) {
387e5dd7070Spatrick   ID.AddPointer(Ex);
388e5dd7070Spatrick   ID.AddPointer(sReg);
389e5dd7070Spatrick }
390e5dd7070Spatrick 
Profile(llvm::FoldingSetNodeID & ID) const391e5dd7070Spatrick void CXXTempObjectRegion::Profile(llvm::FoldingSetNodeID &ID) const {
392e5dd7070Spatrick   ProfileRegion(ID, Ex, getSuperRegion());
393e5dd7070Spatrick }
394e5dd7070Spatrick 
ProfileRegion(llvm::FoldingSetNodeID & ID,const CXXRecordDecl * RD,bool IsVirtual,const MemRegion * SReg)395e5dd7070Spatrick void CXXBaseObjectRegion::ProfileRegion(llvm::FoldingSetNodeID &ID,
396e5dd7070Spatrick                                         const CXXRecordDecl *RD,
397e5dd7070Spatrick                                         bool IsVirtual,
398e5dd7070Spatrick                                         const MemRegion *SReg) {
399e5dd7070Spatrick   ID.AddPointer(RD);
400e5dd7070Spatrick   ID.AddBoolean(IsVirtual);
401e5dd7070Spatrick   ID.AddPointer(SReg);
402e5dd7070Spatrick }
403e5dd7070Spatrick 
Profile(llvm::FoldingSetNodeID & ID) const404e5dd7070Spatrick void CXXBaseObjectRegion::Profile(llvm::FoldingSetNodeID &ID) const {
405e5dd7070Spatrick   ProfileRegion(ID, getDecl(), isVirtual(), superRegion);
406e5dd7070Spatrick }
407e5dd7070Spatrick 
ProfileRegion(llvm::FoldingSetNodeID & ID,const CXXRecordDecl * RD,const MemRegion * SReg)408e5dd7070Spatrick void CXXDerivedObjectRegion::ProfileRegion(llvm::FoldingSetNodeID &ID,
409e5dd7070Spatrick                                            const CXXRecordDecl *RD,
410e5dd7070Spatrick                                            const MemRegion *SReg) {
411e5dd7070Spatrick   ID.AddPointer(RD);
412e5dd7070Spatrick   ID.AddPointer(SReg);
413e5dd7070Spatrick }
414e5dd7070Spatrick 
Profile(llvm::FoldingSetNodeID & ID) const415e5dd7070Spatrick void CXXDerivedObjectRegion::Profile(llvm::FoldingSetNodeID &ID) const {
416e5dd7070Spatrick   ProfileRegion(ID, getDecl(), superRegion);
417e5dd7070Spatrick }
418e5dd7070Spatrick 
419e5dd7070Spatrick //===----------------------------------------------------------------------===//
420e5dd7070Spatrick // Region anchors.
421e5dd7070Spatrick //===----------------------------------------------------------------------===//
422e5dd7070Spatrick 
anchor()423e5dd7070Spatrick void GlobalsSpaceRegion::anchor() {}
424e5dd7070Spatrick 
anchor()425e5dd7070Spatrick void NonStaticGlobalSpaceRegion::anchor() {}
426e5dd7070Spatrick 
anchor()427e5dd7070Spatrick void StackSpaceRegion::anchor() {}
428e5dd7070Spatrick 
anchor()429e5dd7070Spatrick void TypedRegion::anchor() {}
430e5dd7070Spatrick 
anchor()431e5dd7070Spatrick void TypedValueRegion::anchor() {}
432e5dd7070Spatrick 
anchor()433e5dd7070Spatrick void CodeTextRegion::anchor() {}
434e5dd7070Spatrick 
anchor()435e5dd7070Spatrick void SubRegion::anchor() {}
436e5dd7070Spatrick 
437e5dd7070Spatrick //===----------------------------------------------------------------------===//
438e5dd7070Spatrick // Region pretty-printing.
439e5dd7070Spatrick //===----------------------------------------------------------------------===//
440e5dd7070Spatrick 
dump() const441e5dd7070Spatrick LLVM_DUMP_METHOD void MemRegion::dump() const {
442e5dd7070Spatrick   dumpToStream(llvm::errs());
443e5dd7070Spatrick }
444e5dd7070Spatrick 
getString() const445e5dd7070Spatrick std::string MemRegion::getString() const {
446e5dd7070Spatrick   std::string s;
447e5dd7070Spatrick   llvm::raw_string_ostream os(s);
448e5dd7070Spatrick   dumpToStream(os);
449*12c85518Srobert   return s;
450e5dd7070Spatrick }
451e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const452e5dd7070Spatrick void MemRegion::dumpToStream(raw_ostream &os) const {
453e5dd7070Spatrick   os << "<Unknown Region>";
454e5dd7070Spatrick }
455e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const456e5dd7070Spatrick void AllocaRegion::dumpToStream(raw_ostream &os) const {
457e5dd7070Spatrick   os << "alloca{S" << Ex->getID(getContext()) << ',' << Cnt << '}';
458e5dd7070Spatrick }
459e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const460e5dd7070Spatrick void FunctionCodeRegion::dumpToStream(raw_ostream &os) const {
461e5dd7070Spatrick   os << "code{" << getDecl()->getDeclName().getAsString() << '}';
462e5dd7070Spatrick }
463e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const464e5dd7070Spatrick void BlockCodeRegion::dumpToStream(raw_ostream &os) const {
465e5dd7070Spatrick   os << "block_code{" << static_cast<const void *>(this) << '}';
466e5dd7070Spatrick }
467e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const468e5dd7070Spatrick void BlockDataRegion::dumpToStream(raw_ostream &os) const {
469e5dd7070Spatrick   os << "block_data{" << BC;
470e5dd7070Spatrick   os << "; ";
471e5dd7070Spatrick   for (BlockDataRegion::referenced_vars_iterator
472e5dd7070Spatrick          I = referenced_vars_begin(),
473e5dd7070Spatrick          E = referenced_vars_end(); I != E; ++I)
474e5dd7070Spatrick     os << "(" << I.getCapturedRegion() << "<-" <<
475e5dd7070Spatrick                  I.getOriginalRegion() << ") ";
476e5dd7070Spatrick   os << '}';
477e5dd7070Spatrick }
478e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const479e5dd7070Spatrick void CompoundLiteralRegion::dumpToStream(raw_ostream &os) const {
480e5dd7070Spatrick   // FIXME: More elaborate pretty-printing.
481e5dd7070Spatrick   os << "{ S" << CL->getID(getContext()) <<  " }";
482e5dd7070Spatrick }
483e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const484e5dd7070Spatrick void CXXTempObjectRegion::dumpToStream(raw_ostream &os) const {
485*12c85518Srobert   os << "temp_object{" << getValueType() << ", "
486e5dd7070Spatrick      << "S" << Ex->getID(getContext()) << '}';
487e5dd7070Spatrick }
488e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const489e5dd7070Spatrick void CXXBaseObjectRegion::dumpToStream(raw_ostream &os) const {
490e5dd7070Spatrick   os << "Base{" << superRegion << ',' << getDecl()->getName() << '}';
491e5dd7070Spatrick }
492e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const493e5dd7070Spatrick void CXXDerivedObjectRegion::dumpToStream(raw_ostream &os) const {
494e5dd7070Spatrick   os << "Derived{" << superRegion << ',' << getDecl()->getName() << '}';
495e5dd7070Spatrick }
496e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const497e5dd7070Spatrick void CXXThisRegion::dumpToStream(raw_ostream &os) const {
498e5dd7070Spatrick   os << "this";
499e5dd7070Spatrick }
500e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const501e5dd7070Spatrick void ElementRegion::dumpToStream(raw_ostream &os) const {
502*12c85518Srobert   os << "Element{" << superRegion << ',' << Index << ',' << getElementType()
503*12c85518Srobert      << '}';
504e5dd7070Spatrick }
505e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const506e5dd7070Spatrick void FieldRegion::dumpToStream(raw_ostream &os) const {
507e5dd7070Spatrick   os << superRegion << "." << *getDecl();
508e5dd7070Spatrick }
509e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const510e5dd7070Spatrick void ObjCIvarRegion::dumpToStream(raw_ostream &os) const {
511e5dd7070Spatrick   os << "Ivar{" << superRegion << ',' << *getDecl() << '}';
512e5dd7070Spatrick }
513e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const514e5dd7070Spatrick void StringRegion::dumpToStream(raw_ostream &os) const {
515e5dd7070Spatrick   assert(Str != nullptr && "Expecting non-null StringLiteral");
516e5dd7070Spatrick   Str->printPretty(os, nullptr, PrintingPolicy(getContext().getLangOpts()));
517e5dd7070Spatrick }
518e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const519e5dd7070Spatrick void ObjCStringRegion::dumpToStream(raw_ostream &os) const {
520e5dd7070Spatrick   assert(Str != nullptr && "Expecting non-null ObjCStringLiteral");
521e5dd7070Spatrick   Str->printPretty(os, nullptr, PrintingPolicy(getContext().getLangOpts()));
522e5dd7070Spatrick }
523e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const524e5dd7070Spatrick void SymbolicRegion::dumpToStream(raw_ostream &os) const {
525e5dd7070Spatrick   if (isa<HeapSpaceRegion>(getSuperRegion()))
526e5dd7070Spatrick     os << "Heap";
527e5dd7070Spatrick   os << "SymRegion{" << sym << '}';
528e5dd7070Spatrick }
529e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const530ec727ea7Spatrick void NonParamVarRegion::dumpToStream(raw_ostream &os) const {
531e5dd7070Spatrick   if (const IdentifierInfo *ID = VD->getIdentifier())
532e5dd7070Spatrick     os << ID->getName();
533e5dd7070Spatrick   else
534ec727ea7Spatrick     os << "NonParamVarRegion{D" << VD->getID() << '}';
535e5dd7070Spatrick }
536e5dd7070Spatrick 
dump() const537e5dd7070Spatrick LLVM_DUMP_METHOD void RegionRawOffset::dump() const {
538e5dd7070Spatrick   dumpToStream(llvm::errs());
539e5dd7070Spatrick }
540e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const541e5dd7070Spatrick void RegionRawOffset::dumpToStream(raw_ostream &os) const {
542e5dd7070Spatrick   os << "raw_offset{" << getRegion() << ',' << getOffset().getQuantity() << '}';
543e5dd7070Spatrick }
544e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const545e5dd7070Spatrick void CodeSpaceRegion::dumpToStream(raw_ostream &os) const {
546e5dd7070Spatrick   os << "CodeSpaceRegion";
547e5dd7070Spatrick }
548e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const549e5dd7070Spatrick void StaticGlobalSpaceRegion::dumpToStream(raw_ostream &os) const {
550e5dd7070Spatrick   os << "StaticGlobalsMemSpace{" << CR << '}';
551e5dd7070Spatrick }
552e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const553e5dd7070Spatrick void GlobalInternalSpaceRegion::dumpToStream(raw_ostream &os) const {
554e5dd7070Spatrick   os << "GlobalInternalSpaceRegion";
555e5dd7070Spatrick }
556e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const557e5dd7070Spatrick void GlobalSystemSpaceRegion::dumpToStream(raw_ostream &os) const {
558e5dd7070Spatrick   os << "GlobalSystemSpaceRegion";
559e5dd7070Spatrick }
560e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const561e5dd7070Spatrick void GlobalImmutableSpaceRegion::dumpToStream(raw_ostream &os) const {
562e5dd7070Spatrick   os << "GlobalImmutableSpaceRegion";
563e5dd7070Spatrick }
564e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const565e5dd7070Spatrick void HeapSpaceRegion::dumpToStream(raw_ostream &os) const {
566e5dd7070Spatrick   os << "HeapSpaceRegion";
567e5dd7070Spatrick }
568e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const569e5dd7070Spatrick void UnknownSpaceRegion::dumpToStream(raw_ostream &os) const {
570e5dd7070Spatrick   os << "UnknownSpaceRegion";
571e5dd7070Spatrick }
572e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const573e5dd7070Spatrick void StackArgumentsSpaceRegion::dumpToStream(raw_ostream &os) const {
574e5dd7070Spatrick   os << "StackArgumentsSpaceRegion";
575e5dd7070Spatrick }
576e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const577e5dd7070Spatrick void StackLocalsSpaceRegion::dumpToStream(raw_ostream &os) const {
578e5dd7070Spatrick   os << "StackLocalsSpaceRegion";
579e5dd7070Spatrick }
580e5dd7070Spatrick 
dumpToStream(raw_ostream & os) const581ec727ea7Spatrick void ParamVarRegion::dumpToStream(raw_ostream &os) const {
582ec727ea7Spatrick   const ParmVarDecl *PVD = getDecl();
583ec727ea7Spatrick   assert(PVD &&
584ec727ea7Spatrick          "`ParamVarRegion` support functions without `Decl` not implemented"
585ec727ea7Spatrick          " yet.");
586ec727ea7Spatrick   if (const IdentifierInfo *ID = PVD->getIdentifier()) {
587ec727ea7Spatrick     os << ID->getName();
588ec727ea7Spatrick   } else {
589ec727ea7Spatrick     os << "ParamVarRegion{P" << PVD->getID() << '}';
590ec727ea7Spatrick   }
591ec727ea7Spatrick }
592ec727ea7Spatrick 
canPrintPretty() const593e5dd7070Spatrick bool MemRegion::canPrintPretty() const {
594e5dd7070Spatrick   return canPrintPrettyAsExpr();
595e5dd7070Spatrick }
596e5dd7070Spatrick 
canPrintPrettyAsExpr() const597e5dd7070Spatrick bool MemRegion::canPrintPrettyAsExpr() const {
598e5dd7070Spatrick   return false;
599e5dd7070Spatrick }
600e5dd7070Spatrick 
printPretty(raw_ostream & os) const601e5dd7070Spatrick void MemRegion::printPretty(raw_ostream &os) const {
602e5dd7070Spatrick   assert(canPrintPretty() && "This region cannot be printed pretty.");
603e5dd7070Spatrick   os << "'";
604e5dd7070Spatrick   printPrettyAsExpr(os);
605e5dd7070Spatrick   os << "'";
606e5dd7070Spatrick }
607e5dd7070Spatrick 
printPrettyAsExpr(raw_ostream &) const608e5dd7070Spatrick void MemRegion::printPrettyAsExpr(raw_ostream &) const {
609e5dd7070Spatrick   llvm_unreachable("This region cannot be printed pretty.");
610e5dd7070Spatrick }
611e5dd7070Spatrick 
canPrintPrettyAsExpr() const612ec727ea7Spatrick bool NonParamVarRegion::canPrintPrettyAsExpr() const { return true; }
613ec727ea7Spatrick 
printPrettyAsExpr(raw_ostream & os) const614ec727ea7Spatrick void NonParamVarRegion::printPrettyAsExpr(raw_ostream &os) const {
615ec727ea7Spatrick   os << getDecl()->getName();
616e5dd7070Spatrick }
617e5dd7070Spatrick 
canPrintPrettyAsExpr() const618ec727ea7Spatrick bool ParamVarRegion::canPrintPrettyAsExpr() const { return true; }
619ec727ea7Spatrick 
printPrettyAsExpr(raw_ostream & os) const620ec727ea7Spatrick void ParamVarRegion::printPrettyAsExpr(raw_ostream &os) const {
621ec727ea7Spatrick   assert(getDecl() &&
622ec727ea7Spatrick          "`ParamVarRegion` support functions without `Decl` not implemented"
623ec727ea7Spatrick          " yet.");
624e5dd7070Spatrick   os << getDecl()->getName();
625e5dd7070Spatrick }
626e5dd7070Spatrick 
canPrintPrettyAsExpr() const627e5dd7070Spatrick bool ObjCIvarRegion::canPrintPrettyAsExpr() const {
628e5dd7070Spatrick   return true;
629e5dd7070Spatrick }
630e5dd7070Spatrick 
printPrettyAsExpr(raw_ostream & os) const631e5dd7070Spatrick void ObjCIvarRegion::printPrettyAsExpr(raw_ostream &os) const {
632e5dd7070Spatrick   os << getDecl()->getName();
633e5dd7070Spatrick }
634e5dd7070Spatrick 
canPrintPretty() const635e5dd7070Spatrick bool FieldRegion::canPrintPretty() const {
636e5dd7070Spatrick   return true;
637e5dd7070Spatrick }
638e5dd7070Spatrick 
canPrintPrettyAsExpr() const639e5dd7070Spatrick bool FieldRegion::canPrintPrettyAsExpr() const {
640e5dd7070Spatrick   return superRegion->canPrintPrettyAsExpr();
641e5dd7070Spatrick }
642e5dd7070Spatrick 
printPrettyAsExpr(raw_ostream & os) const643e5dd7070Spatrick void FieldRegion::printPrettyAsExpr(raw_ostream &os) const {
644e5dd7070Spatrick   assert(canPrintPrettyAsExpr());
645e5dd7070Spatrick   superRegion->printPrettyAsExpr(os);
646e5dd7070Spatrick   os << "." << getDecl()->getName();
647e5dd7070Spatrick }
648e5dd7070Spatrick 
printPretty(raw_ostream & os) const649e5dd7070Spatrick void FieldRegion::printPretty(raw_ostream &os) const {
650e5dd7070Spatrick   if (canPrintPrettyAsExpr()) {
651e5dd7070Spatrick     os << "\'";
652e5dd7070Spatrick     printPrettyAsExpr(os);
653e5dd7070Spatrick     os << "'";
654e5dd7070Spatrick   } else {
655e5dd7070Spatrick     os << "field " << "\'" << getDecl()->getName() << "'";
656e5dd7070Spatrick   }
657e5dd7070Spatrick }
658e5dd7070Spatrick 
canPrintPrettyAsExpr() const659e5dd7070Spatrick bool CXXBaseObjectRegion::canPrintPrettyAsExpr() const {
660e5dd7070Spatrick   return superRegion->canPrintPrettyAsExpr();
661e5dd7070Spatrick }
662e5dd7070Spatrick 
printPrettyAsExpr(raw_ostream & os) const663e5dd7070Spatrick void CXXBaseObjectRegion::printPrettyAsExpr(raw_ostream &os) const {
664e5dd7070Spatrick   superRegion->printPrettyAsExpr(os);
665e5dd7070Spatrick }
666e5dd7070Spatrick 
canPrintPrettyAsExpr() const667e5dd7070Spatrick bool CXXDerivedObjectRegion::canPrintPrettyAsExpr() const {
668e5dd7070Spatrick   return superRegion->canPrintPrettyAsExpr();
669e5dd7070Spatrick }
670e5dd7070Spatrick 
printPrettyAsExpr(raw_ostream & os) const671e5dd7070Spatrick void CXXDerivedObjectRegion::printPrettyAsExpr(raw_ostream &os) const {
672e5dd7070Spatrick   superRegion->printPrettyAsExpr(os);
673e5dd7070Spatrick }
674e5dd7070Spatrick 
getDescriptiveName(bool UseQuotes) const675e5dd7070Spatrick std::string MemRegion::getDescriptiveName(bool UseQuotes) const {
676e5dd7070Spatrick   std::string VariableName;
677e5dd7070Spatrick   std::string ArrayIndices;
678e5dd7070Spatrick   const MemRegion *R = this;
679e5dd7070Spatrick   SmallString<50> buf;
680e5dd7070Spatrick   llvm::raw_svector_ostream os(buf);
681e5dd7070Spatrick 
682e5dd7070Spatrick   // Obtain array indices to add them to the variable name.
683e5dd7070Spatrick   const ElementRegion *ER = nullptr;
684e5dd7070Spatrick   while ((ER = R->getAs<ElementRegion>())) {
685e5dd7070Spatrick     // Index is a ConcreteInt.
686e5dd7070Spatrick     if (auto CI = ER->getIndex().getAs<nonloc::ConcreteInt>()) {
687e5dd7070Spatrick       llvm::SmallString<2> Idx;
688e5dd7070Spatrick       CI->getValue().toString(Idx);
689e5dd7070Spatrick       ArrayIndices = (llvm::Twine("[") + Idx.str() + "]" + ArrayIndices).str();
690e5dd7070Spatrick     }
691e5dd7070Spatrick     // If not a ConcreteInt, try to obtain the variable
692e5dd7070Spatrick     // name by calling 'getDescriptiveName' recursively.
693e5dd7070Spatrick     else {
694e5dd7070Spatrick       std::string Idx = ER->getDescriptiveName(false);
695e5dd7070Spatrick       if (!Idx.empty()) {
696e5dd7070Spatrick         ArrayIndices = (llvm::Twine("[") + Idx + "]" + ArrayIndices).str();
697e5dd7070Spatrick       }
698e5dd7070Spatrick     }
699e5dd7070Spatrick     R = ER->getSuperRegion();
700e5dd7070Spatrick   }
701e5dd7070Spatrick 
702e5dd7070Spatrick   // Get variable name.
703e5dd7070Spatrick   if (R && R->canPrintPrettyAsExpr()) {
704e5dd7070Spatrick     R->printPrettyAsExpr(os);
705e5dd7070Spatrick     if (UseQuotes)
706e5dd7070Spatrick       return (llvm::Twine("'") + os.str() + ArrayIndices + "'").str();
707e5dd7070Spatrick     else
708e5dd7070Spatrick       return (llvm::Twine(os.str()) + ArrayIndices).str();
709e5dd7070Spatrick   }
710e5dd7070Spatrick 
711e5dd7070Spatrick   return VariableName;
712e5dd7070Spatrick }
713e5dd7070Spatrick 
sourceRange() const714e5dd7070Spatrick SourceRange MemRegion::sourceRange() const {
715e5dd7070Spatrick   const auto *const VR = dyn_cast<VarRegion>(this->getBaseRegion());
716e5dd7070Spatrick   const auto *const FR = dyn_cast<FieldRegion>(this);
717e5dd7070Spatrick 
718e5dd7070Spatrick   // Check for more specific regions first.
719e5dd7070Spatrick   // FieldRegion
720e5dd7070Spatrick   if (FR) {
721e5dd7070Spatrick     return FR->getDecl()->getSourceRange();
722e5dd7070Spatrick   }
723e5dd7070Spatrick   // VarRegion
724e5dd7070Spatrick   else if (VR) {
725e5dd7070Spatrick     return VR->getDecl()->getSourceRange();
726e5dd7070Spatrick   }
727e5dd7070Spatrick   // Return invalid source range (can be checked by client).
728e5dd7070Spatrick   else
729e5dd7070Spatrick     return {};
730e5dd7070Spatrick }
731e5dd7070Spatrick 
732e5dd7070Spatrick //===----------------------------------------------------------------------===//
733e5dd7070Spatrick // MemRegionManager methods.
734e5dd7070Spatrick //===----------------------------------------------------------------------===//
735e5dd7070Spatrick 
getStaticSize(const MemRegion * MR,SValBuilder & SVB) const736ec727ea7Spatrick DefinedOrUnknownSVal MemRegionManager::getStaticSize(const MemRegion *MR,
737ec727ea7Spatrick                                                      SValBuilder &SVB) const {
738ec727ea7Spatrick   const auto *SR = cast<SubRegion>(MR);
739ec727ea7Spatrick   SymbolManager &SymMgr = SVB.getSymbolManager();
740ec727ea7Spatrick 
741ec727ea7Spatrick   switch (SR->getKind()) {
742ec727ea7Spatrick   case MemRegion::AllocaRegionKind:
743ec727ea7Spatrick   case MemRegion::SymbolicRegionKind:
744ec727ea7Spatrick     return nonloc::SymbolVal(SymMgr.getExtentSymbol(SR));
745ec727ea7Spatrick   case MemRegion::StringRegionKind:
746ec727ea7Spatrick     return SVB.makeIntVal(
747ec727ea7Spatrick         cast<StringRegion>(SR)->getStringLiteral()->getByteLength() + 1,
748ec727ea7Spatrick         SVB.getArrayIndexType());
749ec727ea7Spatrick   case MemRegion::CompoundLiteralRegionKind:
750ec727ea7Spatrick   case MemRegion::CXXBaseObjectRegionKind:
751ec727ea7Spatrick   case MemRegion::CXXDerivedObjectRegionKind:
752ec727ea7Spatrick   case MemRegion::CXXTempObjectRegionKind:
753ec727ea7Spatrick   case MemRegion::CXXThisRegionKind:
754ec727ea7Spatrick   case MemRegion::ObjCIvarRegionKind:
755ec727ea7Spatrick   case MemRegion::NonParamVarRegionKind:
756ec727ea7Spatrick   case MemRegion::ParamVarRegionKind:
757ec727ea7Spatrick   case MemRegion::ElementRegionKind:
758ec727ea7Spatrick   case MemRegion::ObjCStringRegionKind: {
759ec727ea7Spatrick     QualType Ty = cast<TypedValueRegion>(SR)->getDesugaredValueType(Ctx);
760ec727ea7Spatrick     if (isa<VariableArrayType>(Ty))
761ec727ea7Spatrick       return nonloc::SymbolVal(SymMgr.getExtentSymbol(SR));
762ec727ea7Spatrick 
763ec727ea7Spatrick     if (Ty->isIncompleteType())
764ec727ea7Spatrick       return UnknownVal();
765ec727ea7Spatrick 
766a9ac8606Spatrick     return getElementExtent(Ty, SVB);
767ec727ea7Spatrick   }
768ec727ea7Spatrick   case MemRegion::FieldRegionKind: {
769ec727ea7Spatrick     // Force callers to deal with bitfields explicitly.
770ec727ea7Spatrick     if (cast<FieldRegion>(SR)->getDecl()->isBitField())
771ec727ea7Spatrick       return UnknownVal();
772ec727ea7Spatrick 
773ec727ea7Spatrick     QualType Ty = cast<TypedValueRegion>(SR)->getDesugaredValueType(Ctx);
774*12c85518Srobert     const DefinedOrUnknownSVal Size = getElementExtent(Ty, SVB);
775ec727ea7Spatrick 
776*12c85518Srobert     // We currently don't model flexible array members (FAMs), which are:
777*12c85518Srobert     //  - int array[]; of IncompleteArrayType
778*12c85518Srobert     //  - int array[0]; of ConstantArrayType with size 0
779*12c85518Srobert     //  - int array[1]; of ConstantArrayType with size 1 (*)
780*12c85518Srobert     // (*): Consider single element array object members as FAM candidates only
781*12c85518Srobert     //      if the consider-single-element-arrays-as-flexible-array-members
782*12c85518Srobert     //      analyzer option is true.
783*12c85518Srobert     // https://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html
784*12c85518Srobert     const auto isFlexibleArrayMemberCandidate = [this,
785*12c85518Srobert                                                  &SVB](QualType Ty) -> bool {
786*12c85518Srobert       const ArrayType *AT = Ctx.getAsArrayType(Ty);
787*12c85518Srobert       if (!AT)
788*12c85518Srobert         return false;
789*12c85518Srobert       if (isa<IncompleteArrayType>(AT))
790*12c85518Srobert         return true;
791*12c85518Srobert 
792*12c85518Srobert       if (const auto *CAT = dyn_cast<ConstantArrayType>(AT)) {
793*12c85518Srobert         using FAMKind = LangOptions::StrictFlexArraysLevelKind;
794*12c85518Srobert         const FAMKind StrictFlexArraysLevel =
795*12c85518Srobert           Ctx.getLangOpts().getStrictFlexArraysLevel();
796*12c85518Srobert         const AnalyzerOptions &Opts = SVB.getAnalyzerOptions();
797*12c85518Srobert         const llvm::APInt &Size = CAT->getSize();
798*12c85518Srobert 
799*12c85518Srobert         if (StrictFlexArraysLevel <= FAMKind::ZeroOrIncomplete && Size.isZero())
800*12c85518Srobert           return true;
801*12c85518Srobert 
802*12c85518Srobert         // The "-fstrict-flex-arrays" should have precedence over
803*12c85518Srobert         // consider-single-element-arrays-as-flexible-array-members
804*12c85518Srobert         // analyzer-config when checking single element arrays.
805*12c85518Srobert         if (StrictFlexArraysLevel == FAMKind::Default) {
806*12c85518Srobert           // FIXME: After clang-17 released, we should remove this branch.
807*12c85518Srobert           if (Opts.ShouldConsiderSingleElementArraysAsFlexibleArrayMembers &&
808*12c85518Srobert               Size.isOne())
809*12c85518Srobert             return true;
810*12c85518Srobert         } else {
811*12c85518Srobert           // -fstrict-flex-arrays was specified, since it's not the default, so
812*12c85518Srobert           // ignore analyzer-config.
813*12c85518Srobert           if (StrictFlexArraysLevel <= FAMKind::OneZeroOrIncomplete &&
814*12c85518Srobert               Size.isOne())
815*12c85518Srobert             return true;
816ec727ea7Spatrick         }
817*12c85518Srobert       }
818*12c85518Srobert       return false;
819*12c85518Srobert     };
820*12c85518Srobert 
821*12c85518Srobert     if (isFlexibleArrayMemberCandidate(Ty))
822*12c85518Srobert       return UnknownVal();
823ec727ea7Spatrick 
824ec727ea7Spatrick     return Size;
825ec727ea7Spatrick   }
826ec727ea7Spatrick     // FIXME: The following are being used in 'SimpleSValBuilder' and in
827ec727ea7Spatrick     // 'ArrayBoundChecker::checkLocation' because there is no symbol to
828ec727ea7Spatrick     // represent the regions more appropriately.
829ec727ea7Spatrick   case MemRegion::BlockDataRegionKind:
830ec727ea7Spatrick   case MemRegion::BlockCodeRegionKind:
831ec727ea7Spatrick   case MemRegion::FunctionCodeRegionKind:
832ec727ea7Spatrick     return nonloc::SymbolVal(SymMgr.getExtentSymbol(SR));
833ec727ea7Spatrick   default:
834ec727ea7Spatrick     llvm_unreachable("Unhandled region");
835ec727ea7Spatrick   }
836ec727ea7Spatrick }
837ec727ea7Spatrick 
838e5dd7070Spatrick template <typename REG>
LazyAllocate(REG * & region)839e5dd7070Spatrick const REG *MemRegionManager::LazyAllocate(REG*& region) {
840e5dd7070Spatrick   if (!region) {
841e5dd7070Spatrick     region = A.Allocate<REG>();
842ec727ea7Spatrick     new (region) REG(*this);
843e5dd7070Spatrick   }
844e5dd7070Spatrick 
845e5dd7070Spatrick   return region;
846e5dd7070Spatrick }
847e5dd7070Spatrick 
848e5dd7070Spatrick template <typename REG, typename ARG>
LazyAllocate(REG * & region,ARG a)849e5dd7070Spatrick const REG *MemRegionManager::LazyAllocate(REG*& region, ARG a) {
850e5dd7070Spatrick   if (!region) {
851e5dd7070Spatrick     region = A.Allocate<REG>();
852e5dd7070Spatrick     new (region) REG(this, a);
853e5dd7070Spatrick   }
854e5dd7070Spatrick 
855e5dd7070Spatrick   return region;
856e5dd7070Spatrick }
857e5dd7070Spatrick 
858e5dd7070Spatrick const StackLocalsSpaceRegion*
getStackLocalsRegion(const StackFrameContext * STC)859e5dd7070Spatrick MemRegionManager::getStackLocalsRegion(const StackFrameContext *STC) {
860e5dd7070Spatrick   assert(STC);
861e5dd7070Spatrick   StackLocalsSpaceRegion *&R = StackLocalsSpaceRegions[STC];
862e5dd7070Spatrick 
863e5dd7070Spatrick   if (R)
864e5dd7070Spatrick     return R;
865e5dd7070Spatrick 
866e5dd7070Spatrick   R = A.Allocate<StackLocalsSpaceRegion>();
867ec727ea7Spatrick   new (R) StackLocalsSpaceRegion(*this, STC);
868e5dd7070Spatrick   return R;
869e5dd7070Spatrick }
870e5dd7070Spatrick 
871e5dd7070Spatrick const StackArgumentsSpaceRegion *
getStackArgumentsRegion(const StackFrameContext * STC)872e5dd7070Spatrick MemRegionManager::getStackArgumentsRegion(const StackFrameContext *STC) {
873e5dd7070Spatrick   assert(STC);
874e5dd7070Spatrick   StackArgumentsSpaceRegion *&R = StackArgumentsSpaceRegions[STC];
875e5dd7070Spatrick 
876e5dd7070Spatrick   if (R)
877e5dd7070Spatrick     return R;
878e5dd7070Spatrick 
879e5dd7070Spatrick   R = A.Allocate<StackArgumentsSpaceRegion>();
880ec727ea7Spatrick   new (R) StackArgumentsSpaceRegion(*this, STC);
881e5dd7070Spatrick   return R;
882e5dd7070Spatrick }
883e5dd7070Spatrick 
884e5dd7070Spatrick const GlobalsSpaceRegion
getGlobalsRegion(MemRegion::Kind K,const CodeTextRegion * CR)885e5dd7070Spatrick *MemRegionManager::getGlobalsRegion(MemRegion::Kind K,
886e5dd7070Spatrick                                     const CodeTextRegion *CR) {
887e5dd7070Spatrick   if (!CR) {
888e5dd7070Spatrick     if (K == MemRegion::GlobalSystemSpaceRegionKind)
889e5dd7070Spatrick       return LazyAllocate(SystemGlobals);
890e5dd7070Spatrick     if (K == MemRegion::GlobalImmutableSpaceRegionKind)
891e5dd7070Spatrick       return LazyAllocate(ImmutableGlobals);
892e5dd7070Spatrick     assert(K == MemRegion::GlobalInternalSpaceRegionKind);
893e5dd7070Spatrick     return LazyAllocate(InternalGlobals);
894e5dd7070Spatrick   }
895e5dd7070Spatrick 
896e5dd7070Spatrick   assert(K == MemRegion::StaticGlobalSpaceRegionKind);
897e5dd7070Spatrick   StaticGlobalSpaceRegion *&R = StaticsGlobalSpaceRegions[CR];
898e5dd7070Spatrick   if (R)
899e5dd7070Spatrick     return R;
900e5dd7070Spatrick 
901e5dd7070Spatrick   R = A.Allocate<StaticGlobalSpaceRegion>();
902ec727ea7Spatrick   new (R) StaticGlobalSpaceRegion(*this, CR);
903e5dd7070Spatrick   return R;
904e5dd7070Spatrick }
905e5dd7070Spatrick 
getHeapRegion()906e5dd7070Spatrick const HeapSpaceRegion *MemRegionManager::getHeapRegion() {
907e5dd7070Spatrick   return LazyAllocate(heap);
908e5dd7070Spatrick }
909e5dd7070Spatrick 
getUnknownRegion()910e5dd7070Spatrick const UnknownSpaceRegion *MemRegionManager::getUnknownRegion() {
911e5dd7070Spatrick   return LazyAllocate(unknown);
912e5dd7070Spatrick }
913e5dd7070Spatrick 
getCodeRegion()914e5dd7070Spatrick const CodeSpaceRegion *MemRegionManager::getCodeRegion() {
915e5dd7070Spatrick   return LazyAllocate(code);
916e5dd7070Spatrick }
917e5dd7070Spatrick 
918e5dd7070Spatrick //===----------------------------------------------------------------------===//
919e5dd7070Spatrick // Constructing regions.
920e5dd7070Spatrick //===----------------------------------------------------------------------===//
921e5dd7070Spatrick 
getStringRegion(const StringLiteral * Str)922e5dd7070Spatrick const StringRegion *MemRegionManager::getStringRegion(const StringLiteral *Str){
923e5dd7070Spatrick   return getSubRegion<StringRegion>(
924e5dd7070Spatrick       Str, cast<GlobalInternalSpaceRegion>(getGlobalsRegion()));
925e5dd7070Spatrick }
926e5dd7070Spatrick 
927e5dd7070Spatrick const ObjCStringRegion *
getObjCStringRegion(const ObjCStringLiteral * Str)928e5dd7070Spatrick MemRegionManager::getObjCStringRegion(const ObjCStringLiteral *Str){
929e5dd7070Spatrick   return getSubRegion<ObjCStringRegion>(
930e5dd7070Spatrick       Str, cast<GlobalInternalSpaceRegion>(getGlobalsRegion()));
931e5dd7070Spatrick }
932e5dd7070Spatrick 
933e5dd7070Spatrick /// Look through a chain of LocationContexts to either find the
934e5dd7070Spatrick /// StackFrameContext that matches a DeclContext, or find a VarRegion
935e5dd7070Spatrick /// for a variable captured by a block.
936e5dd7070Spatrick static llvm::PointerUnion<const StackFrameContext *, const VarRegion *>
getStackOrCaptureRegionForDeclContext(const LocationContext * LC,const DeclContext * DC,const VarDecl * VD)937e5dd7070Spatrick getStackOrCaptureRegionForDeclContext(const LocationContext *LC,
938e5dd7070Spatrick                                       const DeclContext *DC,
939e5dd7070Spatrick                                       const VarDecl *VD) {
940e5dd7070Spatrick   while (LC) {
941e5dd7070Spatrick     if (const auto *SFC = dyn_cast<StackFrameContext>(LC)) {
942e5dd7070Spatrick       if (cast<DeclContext>(SFC->getDecl()) == DC)
943e5dd7070Spatrick         return SFC;
944e5dd7070Spatrick     }
945e5dd7070Spatrick     if (const auto *BC = dyn_cast<BlockInvocationContext>(LC)) {
946ec727ea7Spatrick       const auto *BR = static_cast<const BlockDataRegion *>(BC->getData());
947e5dd7070Spatrick       // FIXME: This can be made more efficient.
948e5dd7070Spatrick       for (BlockDataRegion::referenced_vars_iterator
949e5dd7070Spatrick            I = BR->referenced_vars_begin(),
950e5dd7070Spatrick            E = BR->referenced_vars_end(); I != E; ++I) {
951ec727ea7Spatrick         const TypedValueRegion *OrigR = I.getOriginalRegion();
952ec727ea7Spatrick         if (const auto *VR = dyn_cast<VarRegion>(OrigR)) {
953e5dd7070Spatrick           if (VR->getDecl() == VD)
954e5dd7070Spatrick             return cast<VarRegion>(I.getCapturedRegion());
955e5dd7070Spatrick         }
956e5dd7070Spatrick       }
957ec727ea7Spatrick     }
958e5dd7070Spatrick 
959e5dd7070Spatrick     LC = LC->getParent();
960e5dd7070Spatrick   }
961e5dd7070Spatrick   return (const StackFrameContext *)nullptr;
962e5dd7070Spatrick }
963e5dd7070Spatrick 
getVarRegion(const VarDecl * D,const LocationContext * LC)964e5dd7070Spatrick const VarRegion *MemRegionManager::getVarRegion(const VarDecl *D,
965e5dd7070Spatrick                                                 const LocationContext *LC) {
966ec727ea7Spatrick   const auto *PVD = dyn_cast<ParmVarDecl>(D);
967ec727ea7Spatrick   if (PVD) {
968ec727ea7Spatrick     unsigned Index = PVD->getFunctionScopeIndex();
969ec727ea7Spatrick     const StackFrameContext *SFC = LC->getStackFrame();
970ec727ea7Spatrick     const Stmt *CallSite = SFC->getCallSite();
971ec727ea7Spatrick     if (CallSite) {
972ec727ea7Spatrick       const Decl *D = SFC->getDecl();
973ec727ea7Spatrick       if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
974ec727ea7Spatrick         if (Index < FD->param_size() && FD->parameters()[Index] == PVD)
975ec727ea7Spatrick           return getSubRegion<ParamVarRegion>(cast<Expr>(CallSite), Index,
976ec727ea7Spatrick                                               getStackArgumentsRegion(SFC));
977ec727ea7Spatrick       } else if (const auto *BD = dyn_cast<BlockDecl>(D)) {
978ec727ea7Spatrick         if (Index < BD->param_size() && BD->parameters()[Index] == PVD)
979ec727ea7Spatrick           return getSubRegion<ParamVarRegion>(cast<Expr>(CallSite), Index,
980ec727ea7Spatrick                                               getStackArgumentsRegion(SFC));
981ec727ea7Spatrick       } else {
982ec727ea7Spatrick         return getSubRegion<ParamVarRegion>(cast<Expr>(CallSite), Index,
983ec727ea7Spatrick                                             getStackArgumentsRegion(SFC));
984ec727ea7Spatrick       }
985ec727ea7Spatrick     }
986ec727ea7Spatrick   }
987ec727ea7Spatrick 
988e5dd7070Spatrick   D = D->getCanonicalDecl();
989e5dd7070Spatrick   const MemRegion *sReg = nullptr;
990e5dd7070Spatrick 
991e5dd7070Spatrick   if (D->hasGlobalStorage() && !D->isStaticLocal()) {
992*12c85518Srobert     QualType Ty = D->getType();
993*12c85518Srobert     assert(!Ty.isNull());
994*12c85518Srobert     if (Ty.isConstQualified()) {
995*12c85518Srobert       sReg = getGlobalsRegion(MemRegion::GlobalImmutableSpaceRegionKind);
996*12c85518Srobert     } else if (Ctx.getSourceManager().isInSystemHeader(D->getLocation())) {
997e5dd7070Spatrick       sReg = getGlobalsRegion(MemRegion::GlobalSystemSpaceRegionKind);
998e5dd7070Spatrick     } else {
999*12c85518Srobert       sReg = getGlobalsRegion(MemRegion::GlobalInternalSpaceRegionKind);
1000e5dd7070Spatrick     }
1001e5dd7070Spatrick 
1002e5dd7070Spatrick   // Finally handle static locals.
1003e5dd7070Spatrick   } else {
1004e5dd7070Spatrick     // FIXME: Once we implement scope handling, we will need to properly lookup
1005e5dd7070Spatrick     // 'D' to the proper LocationContext.
1006e5dd7070Spatrick     const DeclContext *DC = D->getDeclContext();
1007e5dd7070Spatrick     llvm::PointerUnion<const StackFrameContext *, const VarRegion *> V =
1008e5dd7070Spatrick       getStackOrCaptureRegionForDeclContext(LC, DC, D);
1009e5dd7070Spatrick 
1010e5dd7070Spatrick     if (V.is<const VarRegion*>())
1011e5dd7070Spatrick       return V.get<const VarRegion*>();
1012e5dd7070Spatrick 
1013e5dd7070Spatrick     const auto *STC = V.get<const StackFrameContext *>();
1014e5dd7070Spatrick 
1015e5dd7070Spatrick     if (!STC) {
1016e5dd7070Spatrick       // FIXME: Assign a more sensible memory space to static locals
1017e5dd7070Spatrick       // we see from within blocks that we analyze as top-level declarations.
1018e5dd7070Spatrick       sReg = getUnknownRegion();
1019e5dd7070Spatrick     } else {
1020e5dd7070Spatrick       if (D->hasLocalStorage()) {
1021*12c85518Srobert         sReg =
1022*12c85518Srobert             isa<ParmVarDecl, ImplicitParamDecl>(D)
1023e5dd7070Spatrick                 ? static_cast<const MemRegion *>(getStackArgumentsRegion(STC))
1024e5dd7070Spatrick                 : static_cast<const MemRegion *>(getStackLocalsRegion(STC));
1025e5dd7070Spatrick       }
1026e5dd7070Spatrick       else {
1027e5dd7070Spatrick         assert(D->isStaticLocal());
1028e5dd7070Spatrick         const Decl *STCD = STC->getDecl();
1029*12c85518Srobert         if (isa<FunctionDecl, ObjCMethodDecl>(STCD))
1030e5dd7070Spatrick           sReg = getGlobalsRegion(MemRegion::StaticGlobalSpaceRegionKind,
1031e5dd7070Spatrick                                   getFunctionCodeRegion(cast<NamedDecl>(STCD)));
1032e5dd7070Spatrick         else if (const auto *BD = dyn_cast<BlockDecl>(STCD)) {
1033e5dd7070Spatrick           // FIXME: The fallback type here is totally bogus -- though it should
1034e5dd7070Spatrick           // never be queried, it will prevent uniquing with the real
1035e5dd7070Spatrick           // BlockCodeRegion. Ideally we'd fix the AST so that we always had a
1036e5dd7070Spatrick           // signature.
1037e5dd7070Spatrick           QualType T;
1038e5dd7070Spatrick           if (const TypeSourceInfo *TSI = BD->getSignatureAsWritten())
1039e5dd7070Spatrick             T = TSI->getType();
1040e5dd7070Spatrick           if (T.isNull())
1041e5dd7070Spatrick             T = getContext().VoidTy;
1042*12c85518Srobert           if (!T->getAs<FunctionType>()) {
1043*12c85518Srobert             FunctionProtoType::ExtProtoInfo Ext;
1044*12c85518Srobert             T = getContext().getFunctionType(T, std::nullopt, Ext);
1045*12c85518Srobert           }
1046e5dd7070Spatrick           T = getContext().getBlockPointerType(T);
1047e5dd7070Spatrick 
1048e5dd7070Spatrick           const BlockCodeRegion *BTR =
1049ec727ea7Spatrick             getBlockCodeRegion(BD, Ctx.getCanonicalType(T),
1050e5dd7070Spatrick                                STC->getAnalysisDeclContext());
1051e5dd7070Spatrick           sReg = getGlobalsRegion(MemRegion::StaticGlobalSpaceRegionKind,
1052e5dd7070Spatrick                                   BTR);
1053e5dd7070Spatrick         }
1054e5dd7070Spatrick         else {
1055e5dd7070Spatrick           sReg = getGlobalsRegion();
1056e5dd7070Spatrick         }
1057e5dd7070Spatrick       }
1058e5dd7070Spatrick     }
1059e5dd7070Spatrick   }
1060e5dd7070Spatrick 
1061ec727ea7Spatrick   return getSubRegion<NonParamVarRegion>(D, sReg);
1062e5dd7070Spatrick }
1063e5dd7070Spatrick 
1064ec727ea7Spatrick const NonParamVarRegion *
getNonParamVarRegion(const VarDecl * D,const MemRegion * superR)1065ec727ea7Spatrick MemRegionManager::getNonParamVarRegion(const VarDecl *D,
1066e5dd7070Spatrick                                        const MemRegion *superR) {
1067e5dd7070Spatrick   D = D->getCanonicalDecl();
1068ec727ea7Spatrick   return getSubRegion<NonParamVarRegion>(D, superR);
1069ec727ea7Spatrick }
1070ec727ea7Spatrick 
1071ec727ea7Spatrick const ParamVarRegion *
getParamVarRegion(const Expr * OriginExpr,unsigned Index,const LocationContext * LC)1072ec727ea7Spatrick MemRegionManager::getParamVarRegion(const Expr *OriginExpr, unsigned Index,
1073ec727ea7Spatrick                                     const LocationContext *LC) {
1074ec727ea7Spatrick   const StackFrameContext *SFC = LC->getStackFrame();
1075ec727ea7Spatrick   assert(SFC);
1076ec727ea7Spatrick   return getSubRegion<ParamVarRegion>(OriginExpr, Index,
1077ec727ea7Spatrick                                       getStackArgumentsRegion(SFC));
1078e5dd7070Spatrick }
1079e5dd7070Spatrick 
1080e5dd7070Spatrick const BlockDataRegion *
getBlockDataRegion(const BlockCodeRegion * BC,const LocationContext * LC,unsigned blockCount)1081e5dd7070Spatrick MemRegionManager::getBlockDataRegion(const BlockCodeRegion *BC,
1082e5dd7070Spatrick                                      const LocationContext *LC,
1083e5dd7070Spatrick                                      unsigned blockCount) {
1084e5dd7070Spatrick   const MemSpaceRegion *sReg = nullptr;
1085e5dd7070Spatrick   const BlockDecl *BD = BC->getDecl();
1086e5dd7070Spatrick   if (!BD->hasCaptures()) {
1087e5dd7070Spatrick     // This handles 'static' blocks.
1088e5dd7070Spatrick     sReg = getGlobalsRegion(MemRegion::GlobalImmutableSpaceRegionKind);
1089e5dd7070Spatrick   }
1090e5dd7070Spatrick   else {
1091*12c85518Srobert     bool IsArcManagedBlock = Ctx.getLangOpts().ObjCAutoRefCount;
1092*12c85518Srobert 
1093*12c85518Srobert     // ARC managed blocks can be initialized on stack or directly in heap
1094*12c85518Srobert     // depending on the implementations.  So we initialize them with
1095*12c85518Srobert     // UnknownRegion.
1096*12c85518Srobert     if (!IsArcManagedBlock && LC) {
1097e5dd7070Spatrick       // FIXME: Once we implement scope handling, we want the parent region
1098e5dd7070Spatrick       // to be the scope.
1099e5dd7070Spatrick       const StackFrameContext *STC = LC->getStackFrame();
1100e5dd7070Spatrick       assert(STC);
1101e5dd7070Spatrick       sReg = getStackLocalsRegion(STC);
1102*12c85518Srobert     } else {
1103e5dd7070Spatrick       // We allow 'LC' to be NULL for cases where want BlockDataRegions
1104e5dd7070Spatrick       // without context-sensitivity.
1105e5dd7070Spatrick       sReg = getUnknownRegion();
1106e5dd7070Spatrick     }
1107e5dd7070Spatrick   }
1108e5dd7070Spatrick 
1109e5dd7070Spatrick   return getSubRegion<BlockDataRegion>(BC, LC, blockCount, sReg);
1110e5dd7070Spatrick }
1111e5dd7070Spatrick 
1112e5dd7070Spatrick const CXXTempObjectRegion *
getCXXStaticTempObjectRegion(const Expr * Ex)1113e5dd7070Spatrick MemRegionManager::getCXXStaticTempObjectRegion(const Expr *Ex) {
1114e5dd7070Spatrick   return getSubRegion<CXXTempObjectRegion>(
1115e5dd7070Spatrick       Ex, getGlobalsRegion(MemRegion::GlobalInternalSpaceRegionKind, nullptr));
1116e5dd7070Spatrick }
1117e5dd7070Spatrick 
1118e5dd7070Spatrick const CompoundLiteralRegion*
getCompoundLiteralRegion(const CompoundLiteralExpr * CL,const LocationContext * LC)1119e5dd7070Spatrick MemRegionManager::getCompoundLiteralRegion(const CompoundLiteralExpr *CL,
1120e5dd7070Spatrick                                            const LocationContext *LC) {
1121e5dd7070Spatrick   const MemSpaceRegion *sReg = nullptr;
1122e5dd7070Spatrick 
1123e5dd7070Spatrick   if (CL->isFileScope())
1124e5dd7070Spatrick     sReg = getGlobalsRegion();
1125e5dd7070Spatrick   else {
1126e5dd7070Spatrick     const StackFrameContext *STC = LC->getStackFrame();
1127e5dd7070Spatrick     assert(STC);
1128e5dd7070Spatrick     sReg = getStackLocalsRegion(STC);
1129e5dd7070Spatrick   }
1130e5dd7070Spatrick 
1131e5dd7070Spatrick   return getSubRegion<CompoundLiteralRegion>(CL, sReg);
1132e5dd7070Spatrick }
1133e5dd7070Spatrick 
1134e5dd7070Spatrick const ElementRegion*
getElementRegion(QualType elementType,NonLoc Idx,const SubRegion * superRegion,ASTContext & Ctx)1135e5dd7070Spatrick MemRegionManager::getElementRegion(QualType elementType, NonLoc Idx,
1136e5dd7070Spatrick                                    const SubRegion* superRegion,
1137e5dd7070Spatrick                                    ASTContext &Ctx){
1138e5dd7070Spatrick   QualType T = Ctx.getCanonicalType(elementType).getUnqualifiedType();
1139e5dd7070Spatrick 
1140e5dd7070Spatrick   llvm::FoldingSetNodeID ID;
1141e5dd7070Spatrick   ElementRegion::ProfileRegion(ID, T, Idx, superRegion);
1142e5dd7070Spatrick 
1143e5dd7070Spatrick   void *InsertPos;
1144e5dd7070Spatrick   MemRegion* data = Regions.FindNodeOrInsertPos(ID, InsertPos);
1145e5dd7070Spatrick   auto *R = cast_or_null<ElementRegion>(data);
1146e5dd7070Spatrick 
1147e5dd7070Spatrick   if (!R) {
1148e5dd7070Spatrick     R = A.Allocate<ElementRegion>();
1149e5dd7070Spatrick     new (R) ElementRegion(T, Idx, superRegion);
1150e5dd7070Spatrick     Regions.InsertNode(R, InsertPos);
1151e5dd7070Spatrick   }
1152e5dd7070Spatrick 
1153e5dd7070Spatrick   return R;
1154e5dd7070Spatrick }
1155e5dd7070Spatrick 
1156e5dd7070Spatrick const FunctionCodeRegion *
getFunctionCodeRegion(const NamedDecl * FD)1157e5dd7070Spatrick MemRegionManager::getFunctionCodeRegion(const NamedDecl *FD) {
1158e5dd7070Spatrick   // To think: should we canonicalize the declaration here?
1159e5dd7070Spatrick   return getSubRegion<FunctionCodeRegion>(FD, getCodeRegion());
1160e5dd7070Spatrick }
1161e5dd7070Spatrick 
1162e5dd7070Spatrick const BlockCodeRegion *
getBlockCodeRegion(const BlockDecl * BD,CanQualType locTy,AnalysisDeclContext * AC)1163e5dd7070Spatrick MemRegionManager::getBlockCodeRegion(const BlockDecl *BD, CanQualType locTy,
1164e5dd7070Spatrick                                      AnalysisDeclContext *AC) {
1165e5dd7070Spatrick   return getSubRegion<BlockCodeRegion>(BD, locTy, AC, getCodeRegion());
1166e5dd7070Spatrick }
1167e5dd7070Spatrick 
1168*12c85518Srobert const SymbolicRegion *
getSymbolicRegion(SymbolRef sym,const MemSpaceRegion * MemSpace)1169*12c85518Srobert MemRegionManager::getSymbolicRegion(SymbolRef sym,
1170*12c85518Srobert                                     const MemSpaceRegion *MemSpace) {
1171*12c85518Srobert   if (MemSpace == nullptr)
1172*12c85518Srobert     MemSpace = getUnknownRegion();
1173*12c85518Srobert   return getSubRegion<SymbolicRegion>(sym, MemSpace);
1174e5dd7070Spatrick }
1175e5dd7070Spatrick 
getSymbolicHeapRegion(SymbolRef Sym)1176e5dd7070Spatrick const SymbolicRegion *MemRegionManager::getSymbolicHeapRegion(SymbolRef Sym) {
1177e5dd7070Spatrick   return getSubRegion<SymbolicRegion>(Sym, getHeapRegion());
1178e5dd7070Spatrick }
1179e5dd7070Spatrick 
1180e5dd7070Spatrick const FieldRegion*
getFieldRegion(const FieldDecl * d,const SubRegion * superRegion)1181e5dd7070Spatrick MemRegionManager::getFieldRegion(const FieldDecl *d,
1182e5dd7070Spatrick                                  const SubRegion* superRegion){
1183e5dd7070Spatrick   return getSubRegion<FieldRegion>(d, superRegion);
1184e5dd7070Spatrick }
1185e5dd7070Spatrick 
1186e5dd7070Spatrick const ObjCIvarRegion*
getObjCIvarRegion(const ObjCIvarDecl * d,const SubRegion * superRegion)1187e5dd7070Spatrick MemRegionManager::getObjCIvarRegion(const ObjCIvarDecl *d,
1188e5dd7070Spatrick                                     const SubRegion* superRegion) {
1189e5dd7070Spatrick   return getSubRegion<ObjCIvarRegion>(d, superRegion);
1190e5dd7070Spatrick }
1191e5dd7070Spatrick 
1192e5dd7070Spatrick const CXXTempObjectRegion*
getCXXTempObjectRegion(Expr const * E,LocationContext const * LC)1193e5dd7070Spatrick MemRegionManager::getCXXTempObjectRegion(Expr const *E,
1194e5dd7070Spatrick                                          LocationContext const *LC) {
1195e5dd7070Spatrick   const StackFrameContext *SFC = LC->getStackFrame();
1196e5dd7070Spatrick   assert(SFC);
1197e5dd7070Spatrick   return getSubRegion<CXXTempObjectRegion>(E, getStackLocalsRegion(SFC));
1198e5dd7070Spatrick }
1199e5dd7070Spatrick 
1200e5dd7070Spatrick /// Checks whether \p BaseClass is a valid virtual or direct non-virtual base
1201e5dd7070Spatrick /// class of the type of \p Super.
isValidBaseClass(const CXXRecordDecl * BaseClass,const TypedValueRegion * Super,bool IsVirtual)1202e5dd7070Spatrick static bool isValidBaseClass(const CXXRecordDecl *BaseClass,
1203e5dd7070Spatrick                              const TypedValueRegion *Super,
1204e5dd7070Spatrick                              bool IsVirtual) {
1205e5dd7070Spatrick   BaseClass = BaseClass->getCanonicalDecl();
1206e5dd7070Spatrick 
1207e5dd7070Spatrick   const CXXRecordDecl *Class = Super->getValueType()->getAsCXXRecordDecl();
1208e5dd7070Spatrick   if (!Class)
1209e5dd7070Spatrick     return true;
1210e5dd7070Spatrick 
1211e5dd7070Spatrick   if (IsVirtual)
1212e5dd7070Spatrick     return Class->isVirtuallyDerivedFrom(BaseClass);
1213e5dd7070Spatrick 
1214e5dd7070Spatrick   for (const auto &I : Class->bases()) {
1215e5dd7070Spatrick     if (I.getType()->getAsCXXRecordDecl()->getCanonicalDecl() == BaseClass)
1216e5dd7070Spatrick       return true;
1217e5dd7070Spatrick   }
1218e5dd7070Spatrick 
1219e5dd7070Spatrick   return false;
1220e5dd7070Spatrick }
1221e5dd7070Spatrick 
1222e5dd7070Spatrick const CXXBaseObjectRegion *
getCXXBaseObjectRegion(const CXXRecordDecl * RD,const SubRegion * Super,bool IsVirtual)1223e5dd7070Spatrick MemRegionManager::getCXXBaseObjectRegion(const CXXRecordDecl *RD,
1224e5dd7070Spatrick                                          const SubRegion *Super,
1225e5dd7070Spatrick                                          bool IsVirtual) {
1226e5dd7070Spatrick   if (isa<TypedValueRegion>(Super)) {
1227e5dd7070Spatrick     assert(isValidBaseClass(RD, cast<TypedValueRegion>(Super), IsVirtual));
1228e5dd7070Spatrick     (void)&isValidBaseClass;
1229e5dd7070Spatrick 
1230e5dd7070Spatrick     if (IsVirtual) {
1231e5dd7070Spatrick       // Virtual base regions should not be layered, since the layout rules
1232e5dd7070Spatrick       // are different.
1233e5dd7070Spatrick       while (const auto *Base = dyn_cast<CXXBaseObjectRegion>(Super))
1234e5dd7070Spatrick         Super = cast<SubRegion>(Base->getSuperRegion());
1235e5dd7070Spatrick       assert(Super && !isa<MemSpaceRegion>(Super));
1236e5dd7070Spatrick     }
1237e5dd7070Spatrick   }
1238e5dd7070Spatrick 
1239e5dd7070Spatrick   return getSubRegion<CXXBaseObjectRegion>(RD, IsVirtual, Super);
1240e5dd7070Spatrick }
1241e5dd7070Spatrick 
1242e5dd7070Spatrick const CXXDerivedObjectRegion *
getCXXDerivedObjectRegion(const CXXRecordDecl * RD,const SubRegion * Super)1243e5dd7070Spatrick MemRegionManager::getCXXDerivedObjectRegion(const CXXRecordDecl *RD,
1244e5dd7070Spatrick                                             const SubRegion *Super) {
1245e5dd7070Spatrick   return getSubRegion<CXXDerivedObjectRegion>(RD, Super);
1246e5dd7070Spatrick }
1247e5dd7070Spatrick 
1248e5dd7070Spatrick const CXXThisRegion*
getCXXThisRegion(QualType thisPointerTy,const LocationContext * LC)1249e5dd7070Spatrick MemRegionManager::getCXXThisRegion(QualType thisPointerTy,
1250e5dd7070Spatrick                                    const LocationContext *LC) {
1251e5dd7070Spatrick   const auto *PT = thisPointerTy->getAs<PointerType>();
1252e5dd7070Spatrick   assert(PT);
1253e5dd7070Spatrick   // Inside the body of the operator() of a lambda a this expr might refer to an
1254e5dd7070Spatrick   // object in one of the parent location contexts.
1255e5dd7070Spatrick   const auto *D = dyn_cast<CXXMethodDecl>(LC->getDecl());
1256e5dd7070Spatrick   // FIXME: when operator() of lambda is analyzed as a top level function and
1257e5dd7070Spatrick   // 'this' refers to a this to the enclosing scope, there is no right region to
1258e5dd7070Spatrick   // return.
1259e5dd7070Spatrick   while (!LC->inTopFrame() && (!D || D->isStatic() ||
1260e5dd7070Spatrick                                PT != D->getThisType()->getAs<PointerType>())) {
1261e5dd7070Spatrick     LC = LC->getParent();
1262e5dd7070Spatrick     D = dyn_cast<CXXMethodDecl>(LC->getDecl());
1263e5dd7070Spatrick   }
1264e5dd7070Spatrick   const StackFrameContext *STC = LC->getStackFrame();
1265e5dd7070Spatrick   assert(STC);
1266e5dd7070Spatrick   return getSubRegion<CXXThisRegion>(PT, getStackArgumentsRegion(STC));
1267e5dd7070Spatrick }
1268e5dd7070Spatrick 
1269e5dd7070Spatrick const AllocaRegion*
getAllocaRegion(const Expr * E,unsigned cnt,const LocationContext * LC)1270e5dd7070Spatrick MemRegionManager::getAllocaRegion(const Expr *E, unsigned cnt,
1271e5dd7070Spatrick                                   const LocationContext *LC) {
1272e5dd7070Spatrick   const StackFrameContext *STC = LC->getStackFrame();
1273e5dd7070Spatrick   assert(STC);
1274e5dd7070Spatrick   return getSubRegion<AllocaRegion>(E, cnt, getStackLocalsRegion(STC));
1275e5dd7070Spatrick }
1276e5dd7070Spatrick 
getMemorySpace() const1277e5dd7070Spatrick const MemSpaceRegion *MemRegion::getMemorySpace() const {
1278e5dd7070Spatrick   const MemRegion *R = this;
1279e5dd7070Spatrick   const auto *SR = dyn_cast<SubRegion>(this);
1280e5dd7070Spatrick 
1281e5dd7070Spatrick   while (SR) {
1282e5dd7070Spatrick     R = SR->getSuperRegion();
1283e5dd7070Spatrick     SR = dyn_cast<SubRegion>(R);
1284e5dd7070Spatrick   }
1285e5dd7070Spatrick 
1286e5dd7070Spatrick   return dyn_cast<MemSpaceRegion>(R);
1287e5dd7070Spatrick }
1288e5dd7070Spatrick 
hasStackStorage() const1289e5dd7070Spatrick bool MemRegion::hasStackStorage() const {
1290e5dd7070Spatrick   return isa<StackSpaceRegion>(getMemorySpace());
1291e5dd7070Spatrick }
1292e5dd7070Spatrick 
hasStackNonParametersStorage() const1293e5dd7070Spatrick bool MemRegion::hasStackNonParametersStorage() const {
1294e5dd7070Spatrick   return isa<StackLocalsSpaceRegion>(getMemorySpace());
1295e5dd7070Spatrick }
1296e5dd7070Spatrick 
hasStackParametersStorage() const1297e5dd7070Spatrick bool MemRegion::hasStackParametersStorage() const {
1298e5dd7070Spatrick   return isa<StackArgumentsSpaceRegion>(getMemorySpace());
1299e5dd7070Spatrick }
1300e5dd7070Spatrick 
hasGlobalsOrParametersStorage() const1301e5dd7070Spatrick bool MemRegion::hasGlobalsOrParametersStorage() const {
1302*12c85518Srobert   return isa<StackArgumentsSpaceRegion, GlobalsSpaceRegion>(getMemorySpace());
1303e5dd7070Spatrick }
1304e5dd7070Spatrick 
1305*12c85518Srobert // Strips away all elements and fields.
1306*12c85518Srobert // Returns the base region of them.
getBaseRegion() const1307e5dd7070Spatrick const MemRegion *MemRegion::getBaseRegion() const {
1308e5dd7070Spatrick   const MemRegion *R = this;
1309e5dd7070Spatrick   while (true) {
1310e5dd7070Spatrick     switch (R->getKind()) {
1311e5dd7070Spatrick       case MemRegion::ElementRegionKind:
1312e5dd7070Spatrick       case MemRegion::FieldRegionKind:
1313e5dd7070Spatrick       case MemRegion::ObjCIvarRegionKind:
1314e5dd7070Spatrick       case MemRegion::CXXBaseObjectRegionKind:
1315e5dd7070Spatrick       case MemRegion::CXXDerivedObjectRegionKind:
1316e5dd7070Spatrick         R = cast<SubRegion>(R)->getSuperRegion();
1317e5dd7070Spatrick         continue;
1318e5dd7070Spatrick       default:
1319e5dd7070Spatrick         break;
1320e5dd7070Spatrick     }
1321e5dd7070Spatrick     break;
1322e5dd7070Spatrick   }
1323e5dd7070Spatrick   return R;
1324e5dd7070Spatrick }
1325e5dd7070Spatrick 
1326*12c85518Srobert // Returns the region of the root class of a C++ class hierarchy.
getMostDerivedObjectRegion() const1327e5dd7070Spatrick const MemRegion *MemRegion::getMostDerivedObjectRegion() const {
1328e5dd7070Spatrick   const MemRegion *R = this;
1329e5dd7070Spatrick   while (const auto *BR = dyn_cast<CXXBaseObjectRegion>(R))
1330e5dd7070Spatrick     R = BR->getSuperRegion();
1331e5dd7070Spatrick   return R;
1332e5dd7070Spatrick }
1333e5dd7070Spatrick 
isSubRegionOf(const MemRegion *) const1334e5dd7070Spatrick bool MemRegion::isSubRegionOf(const MemRegion *) const {
1335e5dd7070Spatrick   return false;
1336e5dd7070Spatrick }
1337e5dd7070Spatrick 
1338e5dd7070Spatrick //===----------------------------------------------------------------------===//
1339e5dd7070Spatrick // View handling.
1340e5dd7070Spatrick //===----------------------------------------------------------------------===//
1341e5dd7070Spatrick 
StripCasts(bool StripBaseAndDerivedCasts) const1342e5dd7070Spatrick const MemRegion *MemRegion::StripCasts(bool StripBaseAndDerivedCasts) const {
1343e5dd7070Spatrick   const MemRegion *R = this;
1344e5dd7070Spatrick   while (true) {
1345e5dd7070Spatrick     switch (R->getKind()) {
1346e5dd7070Spatrick     case ElementRegionKind: {
1347e5dd7070Spatrick       const auto *ER = cast<ElementRegion>(R);
1348e5dd7070Spatrick       if (!ER->getIndex().isZeroConstant())
1349e5dd7070Spatrick         return R;
1350e5dd7070Spatrick       R = ER->getSuperRegion();
1351e5dd7070Spatrick       break;
1352e5dd7070Spatrick     }
1353e5dd7070Spatrick     case CXXBaseObjectRegionKind:
1354e5dd7070Spatrick     case CXXDerivedObjectRegionKind:
1355e5dd7070Spatrick       if (!StripBaseAndDerivedCasts)
1356e5dd7070Spatrick         return R;
1357e5dd7070Spatrick       R = cast<TypedValueRegion>(R)->getSuperRegion();
1358e5dd7070Spatrick       break;
1359e5dd7070Spatrick     default:
1360e5dd7070Spatrick       return R;
1361e5dd7070Spatrick     }
1362e5dd7070Spatrick   }
1363e5dd7070Spatrick }
1364e5dd7070Spatrick 
getSymbolicBase() const1365e5dd7070Spatrick const SymbolicRegion *MemRegion::getSymbolicBase() const {
1366e5dd7070Spatrick   const auto *SubR = dyn_cast<SubRegion>(this);
1367e5dd7070Spatrick 
1368e5dd7070Spatrick   while (SubR) {
1369e5dd7070Spatrick     if (const auto *SymR = dyn_cast<SymbolicRegion>(SubR))
1370e5dd7070Spatrick       return SymR;
1371e5dd7070Spatrick     SubR = dyn_cast<SubRegion>(SubR->getSuperRegion());
1372e5dd7070Spatrick   }
1373e5dd7070Spatrick   return nullptr;
1374e5dd7070Spatrick }
1375e5dd7070Spatrick 
getAsArrayOffset() const1376e5dd7070Spatrick RegionRawOffset ElementRegion::getAsArrayOffset() const {
1377e5dd7070Spatrick   int64_t offset = 0;
1378e5dd7070Spatrick   const ElementRegion *ER = this;
1379e5dd7070Spatrick   const MemRegion *superR = nullptr;
1380e5dd7070Spatrick   ASTContext &C = getContext();
1381e5dd7070Spatrick 
1382e5dd7070Spatrick   // FIXME: Handle multi-dimensional arrays.
1383e5dd7070Spatrick 
1384e5dd7070Spatrick   while (ER) {
1385e5dd7070Spatrick     superR = ER->getSuperRegion();
1386e5dd7070Spatrick 
1387e5dd7070Spatrick     // FIXME: generalize to symbolic offsets.
1388e5dd7070Spatrick     SVal index = ER->getIndex();
1389e5dd7070Spatrick     if (auto CI = index.getAs<nonloc::ConcreteInt>()) {
1390e5dd7070Spatrick       // Update the offset.
1391e5dd7070Spatrick       int64_t i = CI->getValue().getSExtValue();
1392e5dd7070Spatrick 
1393e5dd7070Spatrick       if (i != 0) {
1394e5dd7070Spatrick         QualType elemType = ER->getElementType();
1395e5dd7070Spatrick 
1396e5dd7070Spatrick         // If we are pointing to an incomplete type, go no further.
1397e5dd7070Spatrick         if (elemType->isIncompleteType()) {
1398e5dd7070Spatrick           superR = ER;
1399e5dd7070Spatrick           break;
1400e5dd7070Spatrick         }
1401e5dd7070Spatrick 
1402e5dd7070Spatrick         int64_t size = C.getTypeSizeInChars(elemType).getQuantity();
1403e5dd7070Spatrick         if (auto NewOffset = llvm::checkedMulAdd(i, size, offset)) {
1404e5dd7070Spatrick           offset = *NewOffset;
1405e5dd7070Spatrick         } else {
1406e5dd7070Spatrick           LLVM_DEBUG(llvm::dbgs() << "MemRegion::getAsArrayOffset: "
1407e5dd7070Spatrick                                   << "offset overflowing, returning unknown\n");
1408e5dd7070Spatrick 
1409e5dd7070Spatrick           return nullptr;
1410e5dd7070Spatrick         }
1411e5dd7070Spatrick       }
1412e5dd7070Spatrick 
1413e5dd7070Spatrick       // Go to the next ElementRegion (if any).
1414e5dd7070Spatrick       ER = dyn_cast<ElementRegion>(superR);
1415e5dd7070Spatrick       continue;
1416e5dd7070Spatrick     }
1417e5dd7070Spatrick 
1418e5dd7070Spatrick     return nullptr;
1419e5dd7070Spatrick   }
1420e5dd7070Spatrick 
1421e5dd7070Spatrick   assert(superR && "super region cannot be NULL");
1422e5dd7070Spatrick   return RegionRawOffset(superR, CharUnits::fromQuantity(offset));
1423e5dd7070Spatrick }
1424e5dd7070Spatrick 
1425e5dd7070Spatrick /// Returns true if \p Base is an immediate base class of \p Child
isImmediateBase(const CXXRecordDecl * Child,const CXXRecordDecl * Base)1426e5dd7070Spatrick static bool isImmediateBase(const CXXRecordDecl *Child,
1427e5dd7070Spatrick                             const CXXRecordDecl *Base) {
1428e5dd7070Spatrick   assert(Child && "Child must not be null");
1429e5dd7070Spatrick   // Note that we do NOT canonicalize the base class here, because
1430e5dd7070Spatrick   // ASTRecordLayout doesn't either. If that leads us down the wrong path,
1431e5dd7070Spatrick   // so be it; at least we won't crash.
1432e5dd7070Spatrick   for (const auto &I : Child->bases()) {
1433e5dd7070Spatrick     if (I.getType()->getAsCXXRecordDecl() == Base)
1434e5dd7070Spatrick       return true;
1435e5dd7070Spatrick   }
1436e5dd7070Spatrick 
1437e5dd7070Spatrick   return false;
1438e5dd7070Spatrick }
1439e5dd7070Spatrick 
calculateOffset(const MemRegion * R)1440e5dd7070Spatrick static RegionOffset calculateOffset(const MemRegion *R) {
1441e5dd7070Spatrick   const MemRegion *SymbolicOffsetBase = nullptr;
1442e5dd7070Spatrick   int64_t Offset = 0;
1443e5dd7070Spatrick 
1444e5dd7070Spatrick   while (true) {
1445e5dd7070Spatrick     switch (R->getKind()) {
1446e5dd7070Spatrick     case MemRegion::CodeSpaceRegionKind:
1447e5dd7070Spatrick     case MemRegion::StackLocalsSpaceRegionKind:
1448e5dd7070Spatrick     case MemRegion::StackArgumentsSpaceRegionKind:
1449e5dd7070Spatrick     case MemRegion::HeapSpaceRegionKind:
1450e5dd7070Spatrick     case MemRegion::UnknownSpaceRegionKind:
1451e5dd7070Spatrick     case MemRegion::StaticGlobalSpaceRegionKind:
1452e5dd7070Spatrick     case MemRegion::GlobalInternalSpaceRegionKind:
1453e5dd7070Spatrick     case MemRegion::GlobalSystemSpaceRegionKind:
1454e5dd7070Spatrick     case MemRegion::GlobalImmutableSpaceRegionKind:
1455e5dd7070Spatrick       // Stores can bind directly to a region space to set a default value.
1456e5dd7070Spatrick       assert(Offset == 0 && !SymbolicOffsetBase);
1457e5dd7070Spatrick       goto Finish;
1458e5dd7070Spatrick 
1459e5dd7070Spatrick     case MemRegion::FunctionCodeRegionKind:
1460e5dd7070Spatrick     case MemRegion::BlockCodeRegionKind:
1461e5dd7070Spatrick     case MemRegion::BlockDataRegionKind:
1462e5dd7070Spatrick       // These will never have bindings, but may end up having values requested
1463e5dd7070Spatrick       // if the user does some strange casting.
1464e5dd7070Spatrick       if (Offset != 0)
1465e5dd7070Spatrick         SymbolicOffsetBase = R;
1466e5dd7070Spatrick       goto Finish;
1467e5dd7070Spatrick 
1468e5dd7070Spatrick     case MemRegion::SymbolicRegionKind:
1469e5dd7070Spatrick     case MemRegion::AllocaRegionKind:
1470e5dd7070Spatrick     case MemRegion::CompoundLiteralRegionKind:
1471e5dd7070Spatrick     case MemRegion::CXXThisRegionKind:
1472e5dd7070Spatrick     case MemRegion::StringRegionKind:
1473e5dd7070Spatrick     case MemRegion::ObjCStringRegionKind:
1474ec727ea7Spatrick     case MemRegion::NonParamVarRegionKind:
1475ec727ea7Spatrick     case MemRegion::ParamVarRegionKind:
1476e5dd7070Spatrick     case MemRegion::CXXTempObjectRegionKind:
1477e5dd7070Spatrick       // Usual base regions.
1478e5dd7070Spatrick       goto Finish;
1479e5dd7070Spatrick 
1480e5dd7070Spatrick     case MemRegion::ObjCIvarRegionKind:
1481e5dd7070Spatrick       // This is a little strange, but it's a compromise between
1482e5dd7070Spatrick       // ObjCIvarRegions having unknown compile-time offsets (when using the
1483e5dd7070Spatrick       // non-fragile runtime) and yet still being distinct, non-overlapping
1484e5dd7070Spatrick       // regions. Thus we treat them as "like" base regions for the purposes
1485e5dd7070Spatrick       // of computing offsets.
1486e5dd7070Spatrick       goto Finish;
1487e5dd7070Spatrick 
1488e5dd7070Spatrick     case MemRegion::CXXBaseObjectRegionKind: {
1489e5dd7070Spatrick       const auto *BOR = cast<CXXBaseObjectRegion>(R);
1490e5dd7070Spatrick       R = BOR->getSuperRegion();
1491e5dd7070Spatrick 
1492e5dd7070Spatrick       QualType Ty;
1493e5dd7070Spatrick       bool RootIsSymbolic = false;
1494e5dd7070Spatrick       if (const auto *TVR = dyn_cast<TypedValueRegion>(R)) {
1495e5dd7070Spatrick         Ty = TVR->getDesugaredValueType(R->getContext());
1496e5dd7070Spatrick       } else if (const auto *SR = dyn_cast<SymbolicRegion>(R)) {
1497e5dd7070Spatrick         // If our base region is symbolic, we don't know what type it really is.
1498e5dd7070Spatrick         // Pretend the type of the symbol is the true dynamic type.
1499e5dd7070Spatrick         // (This will at least be self-consistent for the life of the symbol.)
1500*12c85518Srobert         Ty = SR->getPointeeStaticType();
1501e5dd7070Spatrick         RootIsSymbolic = true;
1502e5dd7070Spatrick       }
1503e5dd7070Spatrick 
1504e5dd7070Spatrick       const CXXRecordDecl *Child = Ty->getAsCXXRecordDecl();
1505e5dd7070Spatrick       if (!Child) {
1506e5dd7070Spatrick         // We cannot compute the offset of the base class.
1507e5dd7070Spatrick         SymbolicOffsetBase = R;
1508e5dd7070Spatrick       } else {
1509e5dd7070Spatrick         if (RootIsSymbolic) {
1510e5dd7070Spatrick           // Base layers on symbolic regions may not be type-correct.
1511e5dd7070Spatrick           // Double-check the inheritance here, and revert to a symbolic offset
1512e5dd7070Spatrick           // if it's invalid (e.g. due to a reinterpret_cast).
1513e5dd7070Spatrick           if (BOR->isVirtual()) {
1514e5dd7070Spatrick             if (!Child->isVirtuallyDerivedFrom(BOR->getDecl()))
1515e5dd7070Spatrick               SymbolicOffsetBase = R;
1516e5dd7070Spatrick           } else {
1517e5dd7070Spatrick             if (!isImmediateBase(Child, BOR->getDecl()))
1518e5dd7070Spatrick               SymbolicOffsetBase = R;
1519e5dd7070Spatrick           }
1520e5dd7070Spatrick         }
1521e5dd7070Spatrick       }
1522e5dd7070Spatrick 
1523e5dd7070Spatrick       // Don't bother calculating precise offsets if we already have a
1524e5dd7070Spatrick       // symbolic offset somewhere in the chain.
1525e5dd7070Spatrick       if (SymbolicOffsetBase)
1526e5dd7070Spatrick         continue;
1527e5dd7070Spatrick 
1528e5dd7070Spatrick       CharUnits BaseOffset;
1529e5dd7070Spatrick       const ASTRecordLayout &Layout = R->getContext().getASTRecordLayout(Child);
1530e5dd7070Spatrick       if (BOR->isVirtual())
1531e5dd7070Spatrick         BaseOffset = Layout.getVBaseClassOffset(BOR->getDecl());
1532e5dd7070Spatrick       else
1533e5dd7070Spatrick         BaseOffset = Layout.getBaseClassOffset(BOR->getDecl());
1534e5dd7070Spatrick 
1535e5dd7070Spatrick       // The base offset is in chars, not in bits.
1536e5dd7070Spatrick       Offset += BaseOffset.getQuantity() * R->getContext().getCharWidth();
1537e5dd7070Spatrick       break;
1538e5dd7070Spatrick     }
1539e5dd7070Spatrick 
1540e5dd7070Spatrick     case MemRegion::CXXDerivedObjectRegionKind: {
1541e5dd7070Spatrick       // TODO: Store the base type in the CXXDerivedObjectRegion and use it.
1542e5dd7070Spatrick       goto Finish;
1543e5dd7070Spatrick     }
1544e5dd7070Spatrick 
1545e5dd7070Spatrick     case MemRegion::ElementRegionKind: {
1546e5dd7070Spatrick       const auto *ER = cast<ElementRegion>(R);
1547e5dd7070Spatrick       R = ER->getSuperRegion();
1548e5dd7070Spatrick 
1549e5dd7070Spatrick       QualType EleTy = ER->getValueType();
1550e5dd7070Spatrick       if (EleTy->isIncompleteType()) {
1551e5dd7070Spatrick         // We cannot compute the offset of the base class.
1552e5dd7070Spatrick         SymbolicOffsetBase = R;
1553e5dd7070Spatrick         continue;
1554e5dd7070Spatrick       }
1555e5dd7070Spatrick 
1556e5dd7070Spatrick       SVal Index = ER->getIndex();
1557*12c85518Srobert       if (std::optional<nonloc::ConcreteInt> CI =
1558e5dd7070Spatrick               Index.getAs<nonloc::ConcreteInt>()) {
1559e5dd7070Spatrick         // Don't bother calculating precise offsets if we already have a
1560e5dd7070Spatrick         // symbolic offset somewhere in the chain.
1561e5dd7070Spatrick         if (SymbolicOffsetBase)
1562e5dd7070Spatrick           continue;
1563e5dd7070Spatrick 
1564e5dd7070Spatrick         int64_t i = CI->getValue().getSExtValue();
1565e5dd7070Spatrick         // This type size is in bits.
1566e5dd7070Spatrick         Offset += i * R->getContext().getTypeSize(EleTy);
1567e5dd7070Spatrick       } else {
1568e5dd7070Spatrick         // We cannot compute offset for non-concrete index.
1569e5dd7070Spatrick         SymbolicOffsetBase = R;
1570e5dd7070Spatrick       }
1571e5dd7070Spatrick       break;
1572e5dd7070Spatrick     }
1573e5dd7070Spatrick     case MemRegion::FieldRegionKind: {
1574e5dd7070Spatrick       const auto *FR = cast<FieldRegion>(R);
1575e5dd7070Spatrick       R = FR->getSuperRegion();
1576e5dd7070Spatrick       assert(R);
1577e5dd7070Spatrick 
1578e5dd7070Spatrick       const RecordDecl *RD = FR->getDecl()->getParent();
1579e5dd7070Spatrick       if (RD->isUnion() || !RD->isCompleteDefinition()) {
1580e5dd7070Spatrick         // We cannot compute offset for incomplete type.
1581e5dd7070Spatrick         // For unions, we could treat everything as offset 0, but we'd rather
1582e5dd7070Spatrick         // treat each field as a symbolic offset so they aren't stored on top
1583e5dd7070Spatrick         // of each other, since we depend on things in typed regions actually
1584e5dd7070Spatrick         // matching their types.
1585e5dd7070Spatrick         SymbolicOffsetBase = R;
1586e5dd7070Spatrick       }
1587e5dd7070Spatrick 
1588e5dd7070Spatrick       // Don't bother calculating precise offsets if we already have a
1589e5dd7070Spatrick       // symbolic offset somewhere in the chain.
1590e5dd7070Spatrick       if (SymbolicOffsetBase)
1591e5dd7070Spatrick         continue;
1592e5dd7070Spatrick 
1593e5dd7070Spatrick       // Get the field number.
1594e5dd7070Spatrick       unsigned idx = 0;
1595e5dd7070Spatrick       for (RecordDecl::field_iterator FI = RD->field_begin(),
1596e5dd7070Spatrick              FE = RD->field_end(); FI != FE; ++FI, ++idx) {
1597e5dd7070Spatrick         if (FR->getDecl() == *FI)
1598e5dd7070Spatrick           break;
1599e5dd7070Spatrick       }
1600e5dd7070Spatrick       const ASTRecordLayout &Layout = R->getContext().getASTRecordLayout(RD);
1601e5dd7070Spatrick       // This is offset in bits.
1602e5dd7070Spatrick       Offset += Layout.getFieldOffset(idx);
1603e5dd7070Spatrick       break;
1604e5dd7070Spatrick     }
1605e5dd7070Spatrick     }
1606e5dd7070Spatrick   }
1607e5dd7070Spatrick 
1608e5dd7070Spatrick  Finish:
1609e5dd7070Spatrick   if (SymbolicOffsetBase)
1610e5dd7070Spatrick     return RegionOffset(SymbolicOffsetBase, RegionOffset::Symbolic);
1611e5dd7070Spatrick   return RegionOffset(R, Offset);
1612e5dd7070Spatrick }
1613e5dd7070Spatrick 
getAsOffset() const1614e5dd7070Spatrick RegionOffset MemRegion::getAsOffset() const {
1615e5dd7070Spatrick   if (!cachedOffset)
1616e5dd7070Spatrick     cachedOffset = calculateOffset(this);
1617e5dd7070Spatrick   return *cachedOffset;
1618e5dd7070Spatrick }
1619e5dd7070Spatrick 
1620e5dd7070Spatrick //===----------------------------------------------------------------------===//
1621e5dd7070Spatrick // BlockDataRegion
1622e5dd7070Spatrick //===----------------------------------------------------------------------===//
1623e5dd7070Spatrick 
1624e5dd7070Spatrick std::pair<const VarRegion *, const VarRegion *>
getCaptureRegions(const VarDecl * VD)1625e5dd7070Spatrick BlockDataRegion::getCaptureRegions(const VarDecl *VD) {
1626ec727ea7Spatrick   MemRegionManager &MemMgr = getMemRegionManager();
1627e5dd7070Spatrick   const VarRegion *VR = nullptr;
1628e5dd7070Spatrick   const VarRegion *OriginalVR = nullptr;
1629e5dd7070Spatrick 
1630e5dd7070Spatrick   if (!VD->hasAttr<BlocksAttr>() && VD->hasLocalStorage()) {
1631ec727ea7Spatrick     VR = MemMgr.getNonParamVarRegion(VD, this);
1632e5dd7070Spatrick     OriginalVR = MemMgr.getVarRegion(VD, LC);
1633e5dd7070Spatrick   }
1634e5dd7070Spatrick   else {
1635e5dd7070Spatrick     if (LC) {
1636e5dd7070Spatrick       VR = MemMgr.getVarRegion(VD, LC);
1637e5dd7070Spatrick       OriginalVR = VR;
1638e5dd7070Spatrick     }
1639e5dd7070Spatrick     else {
1640ec727ea7Spatrick       VR = MemMgr.getNonParamVarRegion(VD, MemMgr.getUnknownRegion());
1641e5dd7070Spatrick       OriginalVR = MemMgr.getVarRegion(VD, LC);
1642e5dd7070Spatrick     }
1643e5dd7070Spatrick   }
1644e5dd7070Spatrick   return std::make_pair(VR, OriginalVR);
1645e5dd7070Spatrick }
1646e5dd7070Spatrick 
LazyInitializeReferencedVars()1647e5dd7070Spatrick void BlockDataRegion::LazyInitializeReferencedVars() {
1648e5dd7070Spatrick   if (ReferencedVars)
1649e5dd7070Spatrick     return;
1650e5dd7070Spatrick 
1651e5dd7070Spatrick   AnalysisDeclContext *AC = getCodeRegion()->getAnalysisDeclContext();
1652e5dd7070Spatrick   const auto &ReferencedBlockVars = AC->getReferencedBlockVars(BC->getDecl());
1653e5dd7070Spatrick   auto NumBlockVars =
1654e5dd7070Spatrick       std::distance(ReferencedBlockVars.begin(), ReferencedBlockVars.end());
1655e5dd7070Spatrick 
1656e5dd7070Spatrick   if (NumBlockVars == 0) {
1657e5dd7070Spatrick     ReferencedVars = (void*) 0x1;
1658e5dd7070Spatrick     return;
1659e5dd7070Spatrick   }
1660e5dd7070Spatrick 
1661ec727ea7Spatrick   MemRegionManager &MemMgr = getMemRegionManager();
1662e5dd7070Spatrick   llvm::BumpPtrAllocator &A = MemMgr.getAllocator();
1663e5dd7070Spatrick   BumpVectorContext BC(A);
1664e5dd7070Spatrick 
1665e5dd7070Spatrick   using VarVec = BumpVector<const MemRegion *>;
1666e5dd7070Spatrick 
1667e5dd7070Spatrick   auto *BV = A.Allocate<VarVec>();
1668e5dd7070Spatrick   new (BV) VarVec(BC, NumBlockVars);
1669e5dd7070Spatrick   auto *BVOriginal = A.Allocate<VarVec>();
1670e5dd7070Spatrick   new (BVOriginal) VarVec(BC, NumBlockVars);
1671e5dd7070Spatrick 
1672e5dd7070Spatrick   for (const auto *VD : ReferencedBlockVars) {
1673e5dd7070Spatrick     const VarRegion *VR = nullptr;
1674e5dd7070Spatrick     const VarRegion *OriginalVR = nullptr;
1675e5dd7070Spatrick     std::tie(VR, OriginalVR) = getCaptureRegions(VD);
1676e5dd7070Spatrick     assert(VR);
1677e5dd7070Spatrick     assert(OriginalVR);
1678e5dd7070Spatrick     BV->push_back(VR, BC);
1679e5dd7070Spatrick     BVOriginal->push_back(OriginalVR, BC);
1680e5dd7070Spatrick   }
1681e5dd7070Spatrick 
1682e5dd7070Spatrick   ReferencedVars = BV;
1683e5dd7070Spatrick   OriginalVars = BVOriginal;
1684e5dd7070Spatrick }
1685e5dd7070Spatrick 
1686e5dd7070Spatrick BlockDataRegion::referenced_vars_iterator
referenced_vars_begin() const1687e5dd7070Spatrick BlockDataRegion::referenced_vars_begin() const {
1688e5dd7070Spatrick   const_cast<BlockDataRegion*>(this)->LazyInitializeReferencedVars();
1689e5dd7070Spatrick 
1690e5dd7070Spatrick   auto *Vec = static_cast<BumpVector<const MemRegion *> *>(ReferencedVars);
1691e5dd7070Spatrick 
1692e5dd7070Spatrick   if (Vec == (void*) 0x1)
1693e5dd7070Spatrick     return BlockDataRegion::referenced_vars_iterator(nullptr, nullptr);
1694e5dd7070Spatrick 
1695e5dd7070Spatrick   auto *VecOriginal =
1696e5dd7070Spatrick       static_cast<BumpVector<const MemRegion *> *>(OriginalVars);
1697e5dd7070Spatrick 
1698e5dd7070Spatrick   return BlockDataRegion::referenced_vars_iterator(Vec->begin(),
1699e5dd7070Spatrick                                                    VecOriginal->begin());
1700e5dd7070Spatrick }
1701e5dd7070Spatrick 
1702e5dd7070Spatrick BlockDataRegion::referenced_vars_iterator
referenced_vars_end() const1703e5dd7070Spatrick BlockDataRegion::referenced_vars_end() const {
1704e5dd7070Spatrick   const_cast<BlockDataRegion*>(this)->LazyInitializeReferencedVars();
1705e5dd7070Spatrick 
1706e5dd7070Spatrick   auto *Vec = static_cast<BumpVector<const MemRegion *> *>(ReferencedVars);
1707e5dd7070Spatrick 
1708e5dd7070Spatrick   if (Vec == (void*) 0x1)
1709e5dd7070Spatrick     return BlockDataRegion::referenced_vars_iterator(nullptr, nullptr);
1710e5dd7070Spatrick 
1711e5dd7070Spatrick   auto *VecOriginal =
1712e5dd7070Spatrick       static_cast<BumpVector<const MemRegion *> *>(OriginalVars);
1713e5dd7070Spatrick 
1714e5dd7070Spatrick   return BlockDataRegion::referenced_vars_iterator(Vec->end(),
1715e5dd7070Spatrick                                                    VecOriginal->end());
1716e5dd7070Spatrick }
1717e5dd7070Spatrick 
getOriginalRegion(const VarRegion * R) const1718e5dd7070Spatrick const VarRegion *BlockDataRegion::getOriginalRegion(const VarRegion *R) const {
1719e5dd7070Spatrick   for (referenced_vars_iterator I = referenced_vars_begin(),
1720e5dd7070Spatrick                                 E = referenced_vars_end();
1721e5dd7070Spatrick        I != E; ++I) {
1722e5dd7070Spatrick     if (I.getCapturedRegion() == R)
1723e5dd7070Spatrick       return I.getOriginalRegion();
1724e5dd7070Spatrick   }
1725e5dd7070Spatrick   return nullptr;
1726e5dd7070Spatrick }
1727e5dd7070Spatrick 
1728e5dd7070Spatrick //===----------------------------------------------------------------------===//
1729e5dd7070Spatrick // RegionAndSymbolInvalidationTraits
1730e5dd7070Spatrick //===----------------------------------------------------------------------===//
1731e5dd7070Spatrick 
setTrait(SymbolRef Sym,InvalidationKinds IK)1732e5dd7070Spatrick void RegionAndSymbolInvalidationTraits::setTrait(SymbolRef Sym,
1733e5dd7070Spatrick                                                  InvalidationKinds IK) {
1734e5dd7070Spatrick   SymTraitsMap[Sym] |= IK;
1735e5dd7070Spatrick }
1736e5dd7070Spatrick 
setTrait(const MemRegion * MR,InvalidationKinds IK)1737e5dd7070Spatrick void RegionAndSymbolInvalidationTraits::setTrait(const MemRegion *MR,
1738e5dd7070Spatrick                                                  InvalidationKinds IK) {
1739e5dd7070Spatrick   assert(MR);
1740e5dd7070Spatrick   if (const auto *SR = dyn_cast<SymbolicRegion>(MR))
1741e5dd7070Spatrick     setTrait(SR->getSymbol(), IK);
1742e5dd7070Spatrick   else
1743e5dd7070Spatrick     MRTraitsMap[MR] |= IK;
1744e5dd7070Spatrick }
1745e5dd7070Spatrick 
hasTrait(SymbolRef Sym,InvalidationKinds IK) const1746e5dd7070Spatrick bool RegionAndSymbolInvalidationTraits::hasTrait(SymbolRef Sym,
1747e5dd7070Spatrick                                                  InvalidationKinds IK) const {
1748e5dd7070Spatrick   const_symbol_iterator I = SymTraitsMap.find(Sym);
1749e5dd7070Spatrick   if (I != SymTraitsMap.end())
1750e5dd7070Spatrick     return I->second & IK;
1751e5dd7070Spatrick 
1752e5dd7070Spatrick   return false;
1753e5dd7070Spatrick }
1754e5dd7070Spatrick 
hasTrait(const MemRegion * MR,InvalidationKinds IK) const1755e5dd7070Spatrick bool RegionAndSymbolInvalidationTraits::hasTrait(const MemRegion *MR,
1756e5dd7070Spatrick                                                  InvalidationKinds IK) const {
1757e5dd7070Spatrick   if (!MR)
1758e5dd7070Spatrick     return false;
1759e5dd7070Spatrick 
1760e5dd7070Spatrick   if (const auto *SR = dyn_cast<SymbolicRegion>(MR))
1761e5dd7070Spatrick     return hasTrait(SR->getSymbol(), IK);
1762e5dd7070Spatrick 
1763e5dd7070Spatrick   const_region_iterator I = MRTraitsMap.find(MR);
1764e5dd7070Spatrick   if (I != MRTraitsMap.end())
1765e5dd7070Spatrick     return I->second & IK;
1766e5dd7070Spatrick 
1767e5dd7070Spatrick   return false;
1768e5dd7070Spatrick }
1769