AnalysisContext.h revision cca300a91966df70c9c320e477a3c26ba622673d
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 75cca300a91966df70c9c320e477a3c26ba622673dTed Kremenek const Decl * const 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; 846f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<ParentMap> PM; 856f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<PseudoConstantAnalysis> PCA; 866f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<CFGReverseBlockReachabilityAnalysis> CFA; 87b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek 88326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek llvm::BumpPtrAllocator A; 89b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek 90b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek llvm::DenseMap<const BlockDecl*,void*> *ReferencedBlockVars; 91b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek 92a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek void *ManagedAnalyses; 93a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek 94326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 951d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek AnalysisDeclContext(AnalysisDeclContextManager *Mgr, 96d200187bd27f9ad68699693a6e57f9ee3ff260faJordy Rose const Decl *D); 97bc5cb8a5fe2b88f917d47ceb58b53696a121e57eTed Kremenek 981d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek AnalysisDeclContext(AnalysisDeclContextManager *Mgr, 99b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek const Decl *D, 100b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek const CFG::BuildOptions &BuildOptions); 101326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 1021d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek ~AnalysisDeclContext(); 103326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 104326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ASTContext &getASTContext() { return D->getASTContext(); } 105c6238d2786cfd961b94580b3d3675a1b3ff0721cZhongxing Xu const Decl *getDecl() const { return D; } 106c6238d2786cfd961b94580b3d3675a1b3ff0721cZhongxing Xu 10774fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek /// Return the build options used to construct the CFG. 10874fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek CFG::BuildOptions &getCFGBuildOptions() { 10974fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek return cfgBuildOptions; 11074fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek } 11174fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek 11274fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek const CFG::BuildOptions &getCFGBuildOptions() const { 11374fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek return cfgBuildOptions; 11474fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek } 115ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 116326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek /// getAddEHEdges - Return true iff we are adding exceptional edges from 117326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek /// callExprs. If this is false, then try/catch statements and blocks 118326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek /// reachable from them can appear to be dead in the CFG, analysis passes must 119326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek /// cope with that. 120ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie bool getAddEHEdges() const { return cfgBuildOptions.AddEHEdges; } 121b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek bool getUseUnoptimizedCFG() const { 122bc5cb8a5fe2b88f917d47ceb58b53696a121e57eTed Kremenek return !cfgBuildOptions.PruneTriviallyFalseEdges; 123b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek } 124b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek bool getAddImplicitDtors() const { return cfgBuildOptions.AddImplicitDtors; } 125b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek bool getAddInitializers() const { return cfgBuildOptions.AddInitializers; } 1269b823e8e1ccb8a2cb49923bad22a80ca96f41f92Ted Kremenek 1270d28d360b5559abda755e50b855ba5e59727d9cdTed Kremenek void registerForcedBlockExpression(const Stmt *stmt); 1280d28d360b5559abda755e50b855ba5e59727d9cdTed Kremenek const CFGBlock *getBlockForRegisteredExpression(const Stmt *stmt); 129ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 130a2d7e6511a8767dc67381c210601b895a8ebae39Anna Zaks Stmt *getBody() const; 131326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek CFG *getCFG(); 132ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 133283a358aecb75e30fcd486f2206f6c03c5e7f11dTed Kremenek CFGStmtMap *getCFGStmtMap(); 13404eeba43040969c05cfcb563195ef5b199297b62Anders Carlsson 135af13d5b25b360e698cc1cf1055ad7d14e008e505Ted Kremenek CFGReverseBlockReachabilityAnalysis *getCFGReachablityAnalysis(); 136ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 137ad5a894df1841698c824381b414630799adc26caTed Kremenek /// Return a version of the CFG without any edges pruned. 138ad5a894df1841698c824381b414630799adc26caTed Kremenek CFG *getUnoptimizedCFG(); 139ad5a894df1841698c824381b414630799adc26caTed Kremenek 140682060c5d95f6e4f79536013781ab0870cdd3850Ted Kremenek void dumpCFG(bool ShowColors); 14104eeba43040969c05cfcb563195ef5b199297b62Anders Carlsson 1425d98994c7749312a43ce6adf45537979a98e7afdChandler Carruth /// \brief Returns true if we have built a CFG for this analysis context. 1435d98994c7749312a43ce6adf45537979a98e7afdChandler Carruth /// Note that this doesn't correspond to whether or not a valid CFG exists, it 1445d98994c7749312a43ce6adf45537979a98e7afdChandler Carruth /// corresponds to whether we *attempted* to build one. 1455d98994c7749312a43ce6adf45537979a98e7afdChandler Carruth bool isCFGBuilt() const { return builtCFG; } 1465d98994c7749312a43ce6adf45537979a98e7afdChandler Carruth 147326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ParentMap &getParentMap(); 148db34ab70961ca4b24b600eb47053d7af304659f5Tom Care PseudoConstantAnalysis *getPseudoConstantAnalysis(); 149326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 150326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek typedef const VarDecl * const * referenced_decls_iterator; 151326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 152326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek std::pair<referenced_decls_iterator, referenced_decls_iterator> 153326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek getReferencedBlockVars(const BlockDecl *BD); 154d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 155326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek /// Return the ImplicitParamDecl* associated with 'self' if this 1561d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek /// AnalysisDeclContext wraps an ObjCMethodDecl. Returns NULL otherwise. 157326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const ImplicitParamDecl *getSelfDecl() const; 158ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 159b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek const StackFrameContext *getStackFrame(LocationContext const *Parent, 160b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek const Stmt *S, 161b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek const CFGBlock *Blk, 162ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie unsigned Idx); 1637fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 1647fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const BlockInvocationContext * 1657fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek getBlockInvocationContext(const LocationContext *parent, 1667fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const BlockDecl *BD, 1677fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const void *ContextData); 168ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 169a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek /// Return the specified analysis object, lazily running the analysis if 170a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek /// necessary. Return NULL if the analysis could not run. 171a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek template <typename T> 172a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek T *getAnalysis() { 173a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek const void *tag = T::getTag(); 174a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek ManagedAnalysis *&data = getAnalysisImpl(tag); 175a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek if (!data) { 176a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek data = T::create(*this); 177a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek } 178a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek return static_cast<T*>(data); 179a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek } 180a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenekprivate: 181a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek ManagedAnalysis *&getAnalysisImpl(const void* tag); 182ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 183b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek LocationContextManager &getLocationContextManager(); 184326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek}; 185326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 186326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass LocationContext : public llvm::FoldingSetNode { 187326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 188326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek enum ContextKind { StackFrame, Scope, Block }; 189326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 190326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekprivate: 191326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ContextKind Kind; 192a02d893f15d4663bdba3bd92ade10070bf0510e4Zhongxing Xu 193ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie // AnalysisDeclContext can't be const since some methods may modify its 194ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie // member. 1951d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek AnalysisDeclContext *Ctx; 196a02d893f15d4663bdba3bd92ade10070bf0510e4Zhongxing Xu 197326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *Parent; 198326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 199326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekprotected: 2001d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek LocationContext(ContextKind k, AnalysisDeclContext *ctx, 201326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *parent) 202326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek : Kind(k), Ctx(ctx), Parent(parent) {} 203326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 204326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 205326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek virtual ~LocationContext(); 206d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 207326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ContextKind getKind() const { return Kind; } 208326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 2091d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek AnalysisDeclContext *getAnalysisDeclContext() const { return Ctx; } 210326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 211326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *getParent() const { return Parent; } 212326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 2138ddf7cead8a67342a4584a203e0bf736b7efedbeZhongxing Xu bool isParentOf(const LocationContext *LC) const; 2148ddf7cead8a67342a4584a203e0bf736b7efedbeZhongxing Xu 2151d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek const Decl *getDecl() const { return getAnalysisDeclContext()->getDecl(); } 216326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 2171d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek CFG *getCFG() const { return getAnalysisDeclContext()->getCFG(); } 218326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 219a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek template <typename T> 220a5937bbfd19e61d651a58b0f0ffeef68457902a5Ted Kremenek T *getAnalysis() const { 2211d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek return getAnalysisDeclContext()->getAnalysis<T>(); 222326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 223326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 224d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek ParentMap &getParentMap() const { 2251d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek return getAnalysisDeclContext()->getParentMap(); 226326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 227326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 228326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const ImplicitParamDecl *getSelfDecl() const { 229326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek return Ctx->getSelfDecl(); 230326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 231d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 232326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const StackFrameContext *getCurrentStackFrame() const; 233326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 234326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek virtual void Profile(llvm::FoldingSetNodeID &ID) = 0; 235326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 236326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek static bool classof(const LocationContext*) { return true; } 237326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 238326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 239326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek static void ProfileCommon(llvm::FoldingSetNodeID &ID, 240326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ContextKind ck, 2411d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek AnalysisDeclContext *ctx, 242326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *parent, 2439c378f705405d37f49795d5e915989de774fe11fTed Kremenek const void *data); 244326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek}; 245326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 246326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass StackFrameContext : public LocationContext { 24726c9cb55cb96643c0759c08d037c16c309864087Zhongxing Xu // The callsite where this stack frame is established. 248892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek const Stmt *CallSite; 249326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 250326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek // The parent block of the callsite. 251326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const CFGBlock *Block; 252326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 253326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek // The index of the callsite in the CFGBlock. 254326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek unsigned Index; 255326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 256326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek friend class LocationContextManager; 2571d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek StackFrameContext(AnalysisDeclContext *ctx, const LocationContext *parent, 258ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie const Stmt *s, const CFGBlock *blk, 259d706434b0231c76fd9acf30060646a7aa8f69aefZhongxing Xu unsigned idx) 260892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek : LocationContext(StackFrame, ctx, parent), CallSite(s), 261d706434b0231c76fd9acf30060646a7aa8f69aefZhongxing Xu Block(blk), Index(idx) {} 262326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 263326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 264326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ~StackFrameContext() {} 265326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 266892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek const Stmt *getCallSite() const { return CallSite; } 267d706434b0231c76fd9acf30060646a7aa8f69aefZhongxing Xu 268326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const CFGBlock *getCallSiteBlock() const { return Block; } 269326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 270326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek unsigned getIndex() const { return Index; } 271326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 272326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek void Profile(llvm::FoldingSetNodeID &ID); 273d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 2741d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek static void Profile(llvm::FoldingSetNodeID &ID, AnalysisDeclContext *ctx, 275d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek const LocationContext *parent, const Stmt *s, 276892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek const CFGBlock *blk, unsigned idx) { 277326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ProfileCommon(ID, StackFrame, ctx, parent, s); 278326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ID.AddPointer(blk); 279326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ID.AddInteger(idx); 280326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 281326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 2829c378f705405d37f49795d5e915989de774fe11fTed Kremenek static bool classof(const LocationContext *Ctx) { 283326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek return Ctx->getKind() == StackFrame; 284326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 285326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek}; 286326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 287326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass ScopeContext : public LocationContext { 288326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const Stmt *Enter; 289d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 290326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek friend class LocationContextManager; 2911d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek ScopeContext(AnalysisDeclContext *ctx, const LocationContext *parent, 292326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const Stmt *s) 293326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek : LocationContext(Scope, ctx, parent), Enter(s) {} 294326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 295326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 296326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ~ScopeContext() {} 297326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 298326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek void Profile(llvm::FoldingSetNodeID &ID); 299326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 3001d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek static void Profile(llvm::FoldingSetNodeID &ID, AnalysisDeclContext *ctx, 301326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *parent, const Stmt *s) { 302326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ProfileCommon(ID, Scope, ctx, parent, s); 303326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 304326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 3059c378f705405d37f49795d5e915989de774fe11fTed Kremenek static bool classof(const LocationContext *Ctx) { 306326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek return Ctx->getKind() == Scope; 307326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 308326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek}; 309326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 310326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass BlockInvocationContext : public LocationContext { 311326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const BlockDecl *BD; 3127fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 3137fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek // FIXME: Come up with a more type-safe way to model context-sensitivity. 3147fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const void *ContextData; 315326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 316326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek friend class LocationContextManager; 317326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 318ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie BlockInvocationContext(AnalysisDeclContext *ctx, 319ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie const LocationContext *parent, 3207fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const BlockDecl *bd, const void *contextData) 3217fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek : LocationContext(Block, ctx, parent), BD(bd), ContextData(contextData) {} 322326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 323326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 324326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ~BlockInvocationContext() {} 325326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 326326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const BlockDecl *getBlockDecl() const { return BD; } 3277fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 3287fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const void *getContextData() const { return ContextData; } 329326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 330326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek void Profile(llvm::FoldingSetNodeID &ID); 331326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 3321d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek static void Profile(llvm::FoldingSetNodeID &ID, AnalysisDeclContext *ctx, 3337fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const LocationContext *parent, const BlockDecl *bd, 3347fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const void *contextData) { 335326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ProfileCommon(ID, Block, ctx, parent, bd); 3367fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek ID.AddPointer(contextData); 337326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 338d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 3399c378f705405d37f49795d5e915989de774fe11fTed Kremenek static bool classof(const LocationContext *Ctx) { 340326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek return Ctx->getKind() == Block; 341326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 342326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek}; 343326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 344326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass LocationContextManager { 345326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek llvm::FoldingSet<LocationContext> Contexts; 346326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 347326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ~LocationContextManager(); 348d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 3491d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek const StackFrameContext *getStackFrame(AnalysisDeclContext *ctx, 350326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *parent, 351892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek const Stmt *s, 352d706434b0231c76fd9acf30060646a7aa8f69aefZhongxing Xu const CFGBlock *blk, unsigned idx); 353326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 3541d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek const ScopeContext *getScope(AnalysisDeclContext *ctx, 355326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *parent, 356326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const Stmt *s); 3577fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek 3587fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const BlockInvocationContext * 3597fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek getBlockInvocationContext(AnalysisDeclContext *ctx, 3607fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const LocationContext *parent, 3617fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const BlockDecl *BD, 3627fa9b4f258636d89342eda28f21a986c8ac353b1Ted Kremenek const void *ContextData); 363d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 364326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek /// Discard all previously created LocationContext objects. 365326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek void clear(); 366326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekprivate: 367326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek template <typename LOC, typename DATA> 3681d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek const LOC *getLocationContext(AnalysisDeclContext *ctx, 369326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *parent, 370326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const DATA *d); 371326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek}; 372326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 3731d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenekclass AnalysisDeclContextManager { 3741d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek typedef llvm::DenseMap<const Decl*, AnalysisDeclContext*> ContextMap; 375ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 376b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek ContextMap Contexts; 377b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek LocationContextManager LocContexts; 378b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek CFG::BuildOptions cfgBuildOptions; 379ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 380b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenekpublic: 3811d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek AnalysisDeclContextManager(bool useUnoptimizedCFG = false, 3825a1ffe98b04120846a15f7105905b5f363b08635Jordan Rose bool addImplicitDtors = false, 3835a1ffe98b04120846a15f7105905b5f363b08635Jordan Rose bool addInitializers = false, 3845a1ffe98b04120846a15f7105905b5f363b08635Jordan Rose bool addTemporaryDtors = false); 385ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 3861d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek ~AnalysisDeclContextManager(); 387ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 388d200187bd27f9ad68699693a6e57f9ee3ff260faJordy Rose AnalysisDeclContext *getContext(const Decl *D); 389ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 390b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek bool getUseUnoptimizedCFG() const { 391b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek return !cfgBuildOptions.PruneTriviallyFalseEdges; 392b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek } 393ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 394b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek CFG::BuildOptions &getCFGBuildOptions() { 395b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek return cfgBuildOptions; 396b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek } 397ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 3981d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek const StackFrameContext *getStackFrame(AnalysisDeclContext *Ctx, 399b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek LocationContext const *Parent, 400b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek const Stmt *S, 401b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek const CFGBlock *Blk, 402b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek unsigned Idx) { 403b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek return LocContexts.getStackFrame(Ctx, Parent, S, Blk, Idx); 404b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek } 405ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 406b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek // Get the top level stack frame. 407d200187bd27f9ad68699693a6e57f9ee3ff260faJordy Rose const StackFrameContext *getStackFrame(const Decl *D) { 408d200187bd27f9ad68699693a6e57f9ee3ff260faJordy Rose return LocContexts.getStackFrame(getContext(D), 0, 0, 0, 0); 409b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek } 410ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie 411b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek // Get a stack frame with parent. 412ba243b59a1074e0962f6abfa3bb9aa984eac1245David Blaikie StackFrameContext const *getStackFrame(const Decl *D, 413b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek LocationContext const *Parent, 414b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek const Stmt *S, 415b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek const CFGBlock *Blk, 416b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek unsigned Idx) { 417b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek return LocContexts.getStackFrame(getContext(D), Parent, S, Blk, Idx); 418b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek } 419b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek 4201d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek /// Discard all previously created AnalysisDeclContexts. 421b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek void clear(); 422b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek 423b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenekprivate: 4241d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek friend class AnalysisDeclContext; 425b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek 426b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek LocationContextManager &getLocationContextManager() { 427b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek return LocContexts; 428b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek } 429b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek}; 430b1b5daf30d2597e066936772bd206500232d7d65Ted Kremenek 431326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek} // end clang namespace 432326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek#endif 433