AnalysisContext.h revision 5a1ffe98b04120846a15f7105905b5f363b08635
1326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek//=== AnalysisContext.h - Analysis context for Path Sens analysis --*- C++ -*-// 2326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek// 3326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek// The LLVM Compiler Infrastructure 4326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek// 5326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek// This file is distributed under the University of Illinois Open Source 6326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek// License. See LICENSE.TXT for details. 7326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek// 8326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek//===----------------------------------------------------------------------===// 9326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek// 10ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie// This file defines AnalysisDeclContext, a class that manages the analysis 11ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie// context data for path sensitive analysis. 12326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek// 13326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek//===----------------------------------------------------------------------===// 14326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 15326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek#ifndef LLVM_CLANG_ANALYSIS_ANALYSISCONTEXT_H 16326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek#define LLVM_CLANG_ANALYSIS_ANALYSISCONTEXT_H 17326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 18326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek#include "clang/AST/Decl.h" 19892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek#include "clang/AST/Expr.h" 20b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek#include "clang/Analysis/CFG.h" 21326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek#include "llvm/ADT/OwningPtr.h" 22bc5cb8a5fe2b88f917d47ceb58b53696a121e57eTed Kremenek#include "llvm/ADT/IntrusiveRefCntPtr.h" 23326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek#include "llvm/ADT/FoldingSet.h" 24326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek#include "llvm/ADT/PointerUnion.h" 25326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek#include "llvm/ADT/DenseMap.h" 26326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek#include "llvm/Support/Allocator.h" 27326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 28326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremeneknamespace clang { 29326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 30326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass Decl; 31326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass Stmt; 32af13d5b25b360e698cc1cf1055ad7d14e008e505Ted Kremenekclass CFGReverseBlockReachabilityAnalysis; 33283a358aecb75e30fcd486f2206f6c03c5e7f11dTed Kremenekclass CFGStmtMap; 34326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass LiveVariables; 35a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenekclass ManagedAnalysis; 36326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass ParentMap; 37db34ab70961ca4b24b600eb47053d7af304659f5Tom Careclass PseudoConstantAnalysis; 38326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass ImplicitParamDecl; 39326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass LocationContextManager; 40326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass StackFrameContext; 417fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenekclass BlockInvocationContext; 421d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenekclass AnalysisDeclContextManager; 43ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikieclass LocationContext; 44b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek 45c6238d2786cfd961b94580b3d3675a1b3ff0721cZhongxing Xunamespace idx { class TranslationUnit; } 46c6238d2786cfd961b94580b3d3675a1b3ff0721cZhongxing Xu 47a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek/// The base class of a hierarchy of objects representing analyses tied 481d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek/// to AnalysisDeclContext. 49a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenekclass ManagedAnalysis { 50a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenekprotected: 51a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek ManagedAnalysis() {} 52a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenekpublic: 53a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek virtual ~ManagedAnalysis(); 54ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 55a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek // Subclasses need to implement: 56a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek // 57a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek // static const void *getTag(); 58a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek // 59a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek // Which returns a fixed pointer address to distinguish classes of 60a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek // analysis objects. They also need to implement: 61a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek // 621d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek // static [Derived*] create(AnalysisDeclContext &Ctx); 63a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek // 641d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek // which creates the analysis object given an AnalysisDeclContext. 65a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek}; 66ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 67ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 68ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie/// AnalysisDeclContext contains the context data for the function or method 69ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie/// under analysis. 701d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenekclass AnalysisDeclContext { 71ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie /// Backpoint to the AnalysisManager object that created this 72ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie /// AnalysisDeclContext. This may be null. 731d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek AnalysisDeclContextManager *Manager; 74ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 75326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const Decl *D; 76326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 776f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<CFG> cfg, completeCFG; 786f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<CFGStmtMap> cfgStmtMap; 79b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek 80b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek CFG::BuildOptions cfgBuildOptions; 81b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek CFG::BuildOptions::ForcedBlkExprs *forcedBlkExprs; 82ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 83ad5a894df1841698c824381b414630799adc26caTed Kremenek bool builtCFG, builtCompleteCFG; 84b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek 856f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<LiveVariables> liveness; 866f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<LiveVariables> relaxedLiveness; 876f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<ParentMap> PM; 886f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<PseudoConstantAnalysis> PCA; 896f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<CFGReverseBlockReachabilityAnalysis> CFA; 90b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek 91326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek llvm::BumpPtrAllocator A; 92b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek 93b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek llvm::DenseMap<const BlockDecl*,void*> *ReferencedBlockVars; 94b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek 95a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek void *ManagedAnalyses; 96a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek 97326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 981d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek AnalysisDeclContext(AnalysisDeclContextManager *Mgr, 99d200187bd27f9ad68699693a6e57f9ee3ff260faJordy Rose const Decl *D); 100bc5cb8a5fe2b88f917d47ceb58b53696a121e57eTed Kremenek 1011d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek AnalysisDeclContext(AnalysisDeclContextManager *Mgr, 102b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek const Decl *D, 103b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek const CFG::BuildOptions &BuildOptions); 104326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 1051d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek ~AnalysisDeclContext(); 106326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 107326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ASTContext &getASTContext() { return D->getASTContext(); } 108c6238d2786cfd961b94580b3d3675a1b3ff0721cZhongxing Xu const Decl *getDecl() const { return D; } 109c6238d2786cfd961b94580b3d3675a1b3ff0721cZhongxing Xu 11074fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek /// Return the build options used to construct the CFG. 11174fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek CFG::BuildOptions &getCFGBuildOptions() { 11274fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek return cfgBuildOptions; 11374fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek } 11474fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek 11574fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek const CFG::BuildOptions &getCFGBuildOptions() const { 11674fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek return cfgBuildOptions; 11774fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek } 118ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 119326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek /// getAddEHEdges - Return true iff we are adding exceptional edges from 120326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek /// callExprs. If this is false, then try/catch statements and blocks 121326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek /// reachable from them can appear to be dead in the CFG, analysis passes must 122326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek /// cope with that. 123ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie bool getAddEHEdges() const { return cfgBuildOptions.AddEHEdges; } 124b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek bool getUseUnoptimizedCFG() const { 125bc5cb8a5fe2b88f917d47ceb58b53696a121e57eTed Kremenek return !cfgBuildOptions.PruneTriviallyFalseEdges; 126b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek } 127b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek bool getAddImplicitDtors() const { return cfgBuildOptions.AddImplicitDtors; } 128b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek bool getAddInitializers() const { return cfgBuildOptions.AddInitializers; } 1299b823e8e1ccb8a2cb49923bad22a80ca96f41f92Ted Kremenek 1300d28d360b5559abda755e50b855ba5e59727d9cdTed Kremenek void registerForcedBlockExpression(const Stmt *stmt); 1310d28d360b5559abda755e50b855ba5e59727d9cdTed Kremenek const CFGBlock *getBlockForRegisteredExpression(const Stmt *stmt); 132ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 133a2d7e6511a8767dc67381c210601b895a8ebae39Anna Zaks Stmt *getBody() const; 134326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek CFG *getCFG(); 135ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 136283a358aecb75e30fcd486f2206f6c03c5e7f11dTed Kremenek CFGStmtMap *getCFGStmtMap(); 13704eeba43040969c05cfcb563195ef5b199297b62Anders Carlsson 138af13d5b25b360e698cc1cf1055ad7d14e008e505Ted Kremenek CFGReverseBlockReachabilityAnalysis *getCFGReachablityAnalysis(); 139ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 140ad5a894df1841698c824381b414630799adc26caTed Kremenek /// Return a version of the CFG without any edges pruned. 141ad5a894df1841698c824381b414630799adc26caTed Kremenek CFG *getUnoptimizedCFG(); 142ad5a894df1841698c824381b414630799adc26caTed Kremenek 143682060c5d95f6e4f79536013781ab0870cdd3850Ted Kremenek void dumpCFG(bool ShowColors); 14404eeba43040969c05cfcb563195ef5b199297b62Anders Carlsson 1455d98994c7749312a43ce6adf45537979a98e7afdChandler Carruth /// \brief Returns true if we have built a CFG for this analysis context. 1465d98994c7749312a43ce6adf45537979a98e7afdChandler Carruth /// Note that this doesn't correspond to whether or not a valid CFG exists, it 1475d98994c7749312a43ce6adf45537979a98e7afdChandler Carruth /// corresponds to whether we *attempted* to build one. 1485d98994c7749312a43ce6adf45537979a98e7afdChandler Carruth bool isCFGBuilt() const { return builtCFG; } 1495d98994c7749312a43ce6adf45537979a98e7afdChandler Carruth 150326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ParentMap &getParentMap(); 151db34ab70961ca4b24b600eb47053d7af304659f5Tom Care PseudoConstantAnalysis *getPseudoConstantAnalysis(); 152326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 153326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek typedef const VarDecl * const * referenced_decls_iterator; 154326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 155326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek std::pair<referenced_decls_iterator, referenced_decls_iterator> 156326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek getReferencedBlockVars(const BlockDecl *BD); 157d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 158326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek /// Return the ImplicitParamDecl* associated with 'self' if this 1591d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek /// AnalysisDeclContext wraps an ObjCMethodDecl. Returns NULL otherwise. 160326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const ImplicitParamDecl *getSelfDecl() const; 161ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 162b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek const StackFrameContext *getStackFrame(LocationContext const *Parent, 163b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek const Stmt *S, 164b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek const CFGBlock *Blk, 165ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie unsigned Idx); 1667fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 1677fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const BlockInvocationContext * 1687fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek getBlockInvocationContext(const LocationContext *parent, 1697fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const BlockDecl *BD, 1707fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const void *ContextData); 171ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 172a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek /// Return the specified analysis object, lazily running the analysis if 173a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek /// necessary. Return NULL if the analysis could not run. 174a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek template <typename T> 175a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek T *getAnalysis() { 176a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek const void *tag = T::getTag(); 177a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek ManagedAnalysis *&data = getAnalysisImpl(tag); 178a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek if (!data) { 179a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek data = T::create(*this); 180a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek } 181a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek return static_cast<T*>(data); 182a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek } 183a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenekprivate: 184a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek ManagedAnalysis *&getAnalysisImpl(const void* tag); 185ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 186b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek LocationContextManager &getLocationContextManager(); 187326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek}; 188326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 189326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass LocationContext : public llvm::FoldingSetNode { 190326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 191326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek enum ContextKind { StackFrame, Scope, Block }; 192326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 193326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekprivate: 194326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ContextKind Kind; 195a02d893f15d4663bdba3bd92ade10070bf0510e4Zhongxing Xu 196ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie // AnalysisDeclContext can't be const since some methods may modify its 197ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie // member. 1981d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek AnalysisDeclContext *Ctx; 199a02d893f15d4663bdba3bd92ade10070bf0510e4Zhongxing Xu 200326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *Parent; 201326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 202326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekprotected: 2031d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek LocationContext(ContextKind k, AnalysisDeclContext *ctx, 204326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *parent) 205326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek : Kind(k), Ctx(ctx), Parent(parent) {} 206326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 207326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 208326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek virtual ~LocationContext(); 209d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 210326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ContextKind getKind() const { return Kind; } 211326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 2121d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek AnalysisDeclContext *getAnalysisDeclContext() const { return Ctx; } 213326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 214326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *getParent() const { return Parent; } 215326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 2168ddf7cead8a67342a4584a203e0bf736b7efedbeZhongxing Xu bool isParentOf(const LocationContext *LC) const; 2178ddf7cead8a67342a4584a203e0bf736b7efedbeZhongxing Xu 2181d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek const Decl *getDecl() const { return getAnalysisDeclContext()->getDecl(); } 219326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 2201d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek CFG *getCFG() const { return getAnalysisDeclContext()->getCFG(); } 221326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 222a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek template <typename T> 223a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek T *getAnalysis() const { 2241d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek return getAnalysisDeclContext()->getAnalysis<T>(); 225326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 226326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 227d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek ParentMap &getParentMap() const { 2281d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek return getAnalysisDeclContext()->getParentMap(); 229326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 230326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 231326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const ImplicitParamDecl *getSelfDecl() const { 232326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek return Ctx->getSelfDecl(); 233326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 234d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 235326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const StackFrameContext *getCurrentStackFrame() const; 236326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 237326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek virtual void Profile(llvm::FoldingSetNodeID &ID) = 0; 238326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 239326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek static bool classof(const LocationContext*) { return true; } 240326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 241326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 242326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek static void ProfileCommon(llvm::FoldingSetNodeID &ID, 243326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ContextKind ck, 2441d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek AnalysisDeclContext *ctx, 245326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *parent, 2469c378f705405d37f49795d5e915989de774fe11fTed Kremenek const void *data); 247326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek}; 248326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 249326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass StackFrameContext : public LocationContext { 25026c9cb55cb96643c0759c08d037c16c309864087Zhongxing Xu // The callsite where this stack frame is established. 251892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek const Stmt *CallSite; 252326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 253326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek // The parent block of the callsite. 254326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const CFGBlock *Block; 255326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 256326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek // The index of the callsite in the CFGBlock. 257326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek unsigned Index; 258326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 259326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek friend class LocationContextManager; 2601d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek StackFrameContext(AnalysisDeclContext *ctx, const LocationContext *parent, 261ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie const Stmt *s, const CFGBlock *blk, 262d706434b0231c76fd9acf30060646a7aa8f69aefZhongxing Xu unsigned idx) 263892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek : LocationContext(StackFrame, ctx, parent), CallSite(s), 264d706434b0231c76fd9acf30060646a7aa8f69aefZhongxing Xu Block(blk), Index(idx) {} 265326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 266326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 267326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ~StackFrameContext() {} 268326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 269892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek const Stmt *getCallSite() const { return CallSite; } 270d706434b0231c76fd9acf30060646a7aa8f69aefZhongxing Xu 271326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const CFGBlock *getCallSiteBlock() const { return Block; } 272326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 273326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek unsigned getIndex() const { return Index; } 274326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 275326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek void Profile(llvm::FoldingSetNodeID &ID); 276d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 2771d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek static void Profile(llvm::FoldingSetNodeID &ID, AnalysisDeclContext *ctx, 278d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek const LocationContext *parent, const Stmt *s, 279892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek const CFGBlock *blk, unsigned idx) { 280326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ProfileCommon(ID, StackFrame, ctx, parent, s); 281326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ID.AddPointer(blk); 282326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ID.AddInteger(idx); 283326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 284326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 2859c378f705405d37f49795d5e915989de774fe11fTed Kremenek static bool classof(const LocationContext *Ctx) { 286326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek return Ctx->getKind() == StackFrame; 287326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 288326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek}; 289326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 290326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass ScopeContext : public LocationContext { 291326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const Stmt *Enter; 292d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 293326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek friend class LocationContextManager; 2941d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek ScopeContext(AnalysisDeclContext *ctx, const LocationContext *parent, 295326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const Stmt *s) 296326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek : LocationContext(Scope, ctx, parent), Enter(s) {} 297326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 298326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 299326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ~ScopeContext() {} 300326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 301326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek void Profile(llvm::FoldingSetNodeID &ID); 302326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 3031d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek static void Profile(llvm::FoldingSetNodeID &ID, AnalysisDeclContext *ctx, 304326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *parent, const Stmt *s) { 305326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ProfileCommon(ID, Scope, ctx, parent, s); 306326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 307326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 3089c378f705405d37f49795d5e915989de774fe11fTed Kremenek static bool classof(const LocationContext *Ctx) { 309326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek return Ctx->getKind() == Scope; 310326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 311326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek}; 312326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 313326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass BlockInvocationContext : public LocationContext { 314326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const BlockDecl *BD; 3157fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 3167fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // FIXME: Come up with a more type-safe way to model context-sensitivity. 3177fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const void *ContextData; 318326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 319326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek friend class LocationContextManager; 320326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 321ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie BlockInvocationContext(AnalysisDeclContext *ctx, 322ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie const LocationContext *parent, 3237fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const BlockDecl *bd, const void *contextData) 3247fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek : LocationContext(Block, ctx, parent), BD(bd), ContextData(contextData) {} 325326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 326326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 327326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ~BlockInvocationContext() {} 328326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 329326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const BlockDecl *getBlockDecl() const { return BD; } 3307fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 3317fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const void *getContextData() const { return ContextData; } 332326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 333326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek void Profile(llvm::FoldingSetNodeID &ID); 334326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 3351d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek static void Profile(llvm::FoldingSetNodeID &ID, AnalysisDeclContext *ctx, 3367fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const LocationContext *parent, const BlockDecl *bd, 3377fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const void *contextData) { 338326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ProfileCommon(ID, Block, ctx, parent, bd); 3397fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek ID.AddPointer(contextData); 340326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 341d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 3429c378f705405d37f49795d5e915989de774fe11fTed Kremenek static bool classof(const LocationContext *Ctx) { 343326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek return Ctx->getKind() == Block; 344326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 345326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek}; 346326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 347326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass LocationContextManager { 348326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek llvm::FoldingSet<LocationContext> Contexts; 349326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 350326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ~LocationContextManager(); 351d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 3521d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek const StackFrameContext *getStackFrame(AnalysisDeclContext *ctx, 353326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *parent, 354892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek const Stmt *s, 355d706434b0231c76fd9acf30060646a7aa8f69aefZhongxing Xu const CFGBlock *blk, unsigned idx); 356326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 3571d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek const ScopeContext *getScope(AnalysisDeclContext *ctx, 358326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *parent, 359326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const Stmt *s); 3607fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 3617fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const BlockInvocationContext * 3627fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek getBlockInvocationContext(AnalysisDeclContext *ctx, 3637fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const LocationContext *parent, 3647fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const BlockDecl *BD, 3657fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const void *ContextData); 366d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 367326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek /// Discard all previously created LocationContext objects. 368326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek void clear(); 369326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekprivate: 370326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek template <typename LOC, typename DATA> 3711d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek const LOC *getLocationContext(AnalysisDeclContext *ctx, 372326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *parent, 373326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const DATA *d); 374326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek}; 375326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 3761d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenekclass AnalysisDeclContextManager { 3771d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek typedef llvm::DenseMap<const Decl*, AnalysisDeclContext*> ContextMap; 378ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 379b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek ContextMap Contexts; 380b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek LocationContextManager LocContexts; 381b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek CFG::BuildOptions cfgBuildOptions; 382ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 383b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenekpublic: 3841d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek AnalysisDeclContextManager(bool useUnoptimizedCFG = false, 3855a1ffe98b04120846a15f7105905b5f363b08635Jordan Rose bool addImplicitDtors = false, 3865a1ffe98b04120846a15f7105905b5f363b08635Jordan Rose bool addInitializers = false, 3875a1ffe98b04120846a15f7105905b5f363b08635Jordan Rose bool addTemporaryDtors = false); 388ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 3891d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek ~AnalysisDeclContextManager(); 390ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 391d200187bd27f9ad68699693a6e57f9ee3ff260faJordy Rose AnalysisDeclContext *getContext(const Decl *D); 392ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 393b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek bool getUseUnoptimizedCFG() const { 394b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek return !cfgBuildOptions.PruneTriviallyFalseEdges; 395b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek } 396ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 397b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek CFG::BuildOptions &getCFGBuildOptions() { 398b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek return cfgBuildOptions; 399b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek } 400ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 4011d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek const StackFrameContext *getStackFrame(AnalysisDeclContext *Ctx, 402b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek LocationContext const *Parent, 403b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek const Stmt *S, 404b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek const CFGBlock *Blk, 405b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek unsigned Idx) { 406b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek return LocContexts.getStackFrame(Ctx, Parent, S, Blk, Idx); 407b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek } 408ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 409b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek // Get the top level stack frame. 410d200187bd27f9ad68699693a6e57f9ee3ff260faJordy Rose const StackFrameContext *getStackFrame(const Decl *D) { 411d200187bd27f9ad68699693a6e57f9ee3ff260faJordy Rose return LocContexts.getStackFrame(getContext(D), 0, 0, 0, 0); 412b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek } 413ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 414b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek // Get a stack frame with parent. 415ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie StackFrameContext const *getStackFrame(const Decl *D, 416b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek LocationContext const *Parent, 417b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek const Stmt *S, 418b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek const CFGBlock *Blk, 419b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek unsigned Idx) { 420b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek return LocContexts.getStackFrame(getContext(D), Parent, S, Blk, Idx); 421b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek } 422b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek 4231d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek /// Discard all previously created AnalysisDeclContexts. 424b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek void clear(); 425b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek 426b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenekprivate: 4271d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek friend class AnalysisDeclContext; 428b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek 429b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek LocationContextManager &getLocationContextManager() { 430b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek return LocContexts; 431b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek } 432b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek}; 433b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek 434326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek} // end clang namespace 435326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek#endif 436