AnalysisContext.h revision 0d28d360b5559abda755e50b855ba5e59727d9cd
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// 10326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek// This file defines AnalysisContext, a class that manages the analysis context 11326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek// 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" 22326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek#include "llvm/ADT/FoldingSet.h" 23326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek#include "llvm/ADT/PointerUnion.h" 24326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek#include "llvm/ADT/DenseMap.h" 25326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek#include "llvm/Support/Allocator.h" 26326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 27326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremeneknamespace clang { 28326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 29326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass Decl; 30326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass Stmt; 3142461eecee98fff3671b3c14ce10f1a9e18cc95cTed Kremenekclass CFGReachabilityAnalysis; 32283a358aecb75e30fcd486f2206f6c03c5e7f11dTed Kremenekclass CFGStmtMap; 33326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass LiveVariables; 34326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass ParentMap; 35db34ab70961ca4b24b600eb47053d7af304659f5Tom Careclass PseudoConstantAnalysis; 36326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass ImplicitParamDecl; 37326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass LocationContextManager; 38326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass StackFrameContext; 39d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 40c6238d2786cfd961b94580b3d3675a1b3ff0721cZhongxing Xunamespace idx { class TranslationUnit; } 41c6238d2786cfd961b94580b3d3675a1b3ff0721cZhongxing Xu 42326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek/// AnalysisContext contains the context data for the function or method under 43326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek/// analysis. 44326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass AnalysisContext { 45326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const Decl *D; 46326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 47c6238d2786cfd961b94580b3d3675a1b3ff0721cZhongxing Xu // TranslationUnit is NULL if we don't have multiple translation units. 482ce43c8f43254a9edea53a20dc0e69195bc82ae0Zhongxing Xu idx::TranslationUnit *TU; 49c6238d2786cfd961b94580b3d3675a1b3ff0721cZhongxing Xu 50b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek llvm::OwningPtr<CFG> cfg, completeCFG; 51b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek llvm::OwningPtr<CFGStmtMap> cfgStmtMap; 52b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek 53b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek CFG::BuildOptions cfgBuildOptions; 54b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek CFG::BuildOptions::ForcedBlkExprs *forcedBlkExprs; 55b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek 56ad5a894df1841698c824381b414630799adc26caTed Kremenek bool builtCFG, builtCompleteCFG; 57b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek const bool useUnoptimizedCFG; 58b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek 59b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek llvm::OwningPtr<LiveVariables> liveness; 60b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek llvm::OwningPtr<LiveVariables> relaxedLiveness; 61b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek llvm::OwningPtr<ParentMap> PM; 62b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek llvm::OwningPtr<PseudoConstantAnalysis> PCA; 63b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek llvm::OwningPtr<CFGReachabilityAnalysis> CFA; 64b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek 65326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek llvm::BumpPtrAllocator A; 66b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek 67b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek // FIXME: remove. 68b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek llvm::DenseMap<const BlockDecl*,void*> *ReferencedBlockVars; 69b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek 70326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 712ce43c8f43254a9edea53a20dc0e69195bc82ae0Zhongxing Xu AnalysisContext(const Decl *d, idx::TranslationUnit *tu, 729b823e8e1ccb8a2cb49923bad22a80ca96f41f92Ted Kremenek bool useUnoptimizedCFG = false, 739121ba232903ebe61e7bbe14ca294cf0f07dfa96Marcin Swiderski bool addehedges = false, 749121ba232903ebe61e7bbe14ca294cf0f07dfa96Marcin Swiderski bool addImplicitDtors = false, 75b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek bool addInitializers = false); 76326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 77326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ~AnalysisContext(); 78326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 79326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ASTContext &getASTContext() { return D->getASTContext(); } 80c6238d2786cfd961b94580b3d3675a1b3ff0721cZhongxing Xu const Decl *getDecl() const { return D; } 81c6238d2786cfd961b94580b3d3675a1b3ff0721cZhongxing Xu 822ce43c8f43254a9edea53a20dc0e69195bc82ae0Zhongxing Xu idx::TranslationUnit *getTranslationUnit() const { return TU; } 83c6238d2786cfd961b94580b3d3675a1b3ff0721cZhongxing Xu 84326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek /// getAddEHEdges - Return true iff we are adding exceptional edges from 85326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek /// callExprs. If this is false, then try/catch statements and blocks 86326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek /// reachable from them can appear to be dead in the CFG, analysis passes must 87326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek /// cope with that. 88b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek bool getAddEHEdges() const { return cfgBuildOptions.AddEHEdges; } 89b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek bool getUseUnoptimizedCFG() const { 90b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek return cfgBuildOptions.PruneTriviallyFalseEdges; 91b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek } 92b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek bool getAddImplicitDtors() const { return cfgBuildOptions.AddImplicitDtors; } 93b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek bool getAddInitializers() const { return cfgBuildOptions.AddInitializers; } 949b823e8e1ccb8a2cb49923bad22a80ca96f41f92Ted Kremenek 950d28d360b5559abda755e50b855ba5e59727d9cdTed Kremenek void registerForcedBlockExpression(const Stmt *stmt); 960d28d360b5559abda755e50b855ba5e59727d9cdTed Kremenek const CFGBlock *getBlockForRegisteredExpression(const Stmt *stmt); 970d28d360b5559abda755e50b855ba5e59727d9cdTed Kremenek 98326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek Stmt *getBody(); 99326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek CFG *getCFG(); 100283a358aecb75e30fcd486f2206f6c03c5e7f11dTed Kremenek 101283a358aecb75e30fcd486f2206f6c03c5e7f11dTed Kremenek CFGStmtMap *getCFGStmtMap(); 10204eeba43040969c05cfcb563195ef5b199297b62Anders Carlsson 10342461eecee98fff3671b3c14ce10f1a9e18cc95cTed Kremenek CFGReachabilityAnalysis *getCFGReachablityAnalysis(); 10442461eecee98fff3671b3c14ce10f1a9e18cc95cTed Kremenek 105ad5a894df1841698c824381b414630799adc26caTed Kremenek /// Return a version of the CFG without any edges pruned. 106ad5a894df1841698c824381b414630799adc26caTed Kremenek CFG *getUnoptimizedCFG(); 107ad5a894df1841698c824381b414630799adc26caTed Kremenek 10804eeba43040969c05cfcb563195ef5b199297b62Anders Carlsson void dumpCFG(); 10904eeba43040969c05cfcb563195ef5b199297b62Anders Carlsson 110326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ParentMap &getParentMap(); 111db34ab70961ca4b24b600eb47053d7af304659f5Tom Care PseudoConstantAnalysis *getPseudoConstantAnalysis(); 112326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek LiveVariables *getLiveVariables(); 113ec49bf464c91a52b3a463940da6589d03bf40248Tom Care LiveVariables *getRelaxedLiveVariables(); 114326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 115326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek typedef const VarDecl * const * referenced_decls_iterator; 116326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 117326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek std::pair<referenced_decls_iterator, referenced_decls_iterator> 118326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek getReferencedBlockVars(const BlockDecl *BD); 119d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 120326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek /// Return the ImplicitParamDecl* associated with 'self' if this 121326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek /// AnalysisContext wraps an ObjCMethodDecl. Returns NULL otherwise. 122326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const ImplicitParamDecl *getSelfDecl() const; 123326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek}; 124326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 125326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass AnalysisContextManager { 126326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek typedef llvm::DenseMap<const Decl*, AnalysisContext*> ContextMap; 127326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ContextMap Contexts; 1289b823e8e1ccb8a2cb49923bad22a80ca96f41f92Ted Kremenek bool UseUnoptimizedCFG; 1299121ba232903ebe61e7bbe14ca294cf0f07dfa96Marcin Swiderski bool AddImplicitDtors; 1309121ba232903ebe61e7bbe14ca294cf0f07dfa96Marcin Swiderski bool AddInitializers; 131326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 1329121ba232903ebe61e7bbe14ca294cf0f07dfa96Marcin Swiderski AnalysisContextManager(bool useUnoptimizedCFG = false, 1339121ba232903ebe61e7bbe14ca294cf0f07dfa96Marcin Swiderski bool addImplicitDtors = false, bool addInitializers = false) 1349121ba232903ebe61e7bbe14ca294cf0f07dfa96Marcin Swiderski : UseUnoptimizedCFG(useUnoptimizedCFG), AddImplicitDtors(addImplicitDtors), 1359121ba232903ebe61e7bbe14ca294cf0f07dfa96Marcin Swiderski AddInitializers(addInitializers) {} 1369b823e8e1ccb8a2cb49923bad22a80ca96f41f92Ted Kremenek 137326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ~AnalysisContextManager(); 138326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 1392ce43c8f43254a9edea53a20dc0e69195bc82ae0Zhongxing Xu AnalysisContext *getContext(const Decl *D, idx::TranslationUnit *TU = 0); 140d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 1419b823e8e1ccb8a2cb49923bad22a80ca96f41f92Ted Kremenek bool getUseUnoptimizedCFG() const { return UseUnoptimizedCFG; } 1429121ba232903ebe61e7bbe14ca294cf0f07dfa96Marcin Swiderski bool getAddImplicitDtors() const { return AddImplicitDtors; } 1439121ba232903ebe61e7bbe14ca294cf0f07dfa96Marcin Swiderski bool getAddInitializers() const { return AddInitializers; } 1449b823e8e1ccb8a2cb49923bad22a80ca96f41f92Ted Kremenek 145326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek // Discard all previously created AnalysisContexts. 146326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek void clear(); 147326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek}; 148326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 149326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass LocationContext : public llvm::FoldingSetNode { 150326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 151326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek enum ContextKind { StackFrame, Scope, Block }; 152326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 153326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekprivate: 154326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ContextKind Kind; 155a02d893f15d4663bdba3bd92ade10070bf0510e4Zhongxing Xu 156a02d893f15d4663bdba3bd92ade10070bf0510e4Zhongxing Xu // AnalysisContext can't be const since some methods may modify its member. 157326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek AnalysisContext *Ctx; 158a02d893f15d4663bdba3bd92ade10070bf0510e4Zhongxing Xu 159326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *Parent; 160326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 161326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekprotected: 162326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek LocationContext(ContextKind k, AnalysisContext *ctx, 163326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *parent) 164326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek : Kind(k), Ctx(ctx), Parent(parent) {} 165326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 166326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 167326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek virtual ~LocationContext(); 168d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 169326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ContextKind getKind() const { return Kind; } 170326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 171326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek AnalysisContext *getAnalysisContext() const { return Ctx; } 172326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 1732ce43c8f43254a9edea53a20dc0e69195bc82ae0Zhongxing Xu idx::TranslationUnit *getTranslationUnit() const { 174c6238d2786cfd961b94580b3d3675a1b3ff0721cZhongxing Xu return Ctx->getTranslationUnit(); 175c6238d2786cfd961b94580b3d3675a1b3ff0721cZhongxing Xu } 176c6238d2786cfd961b94580b3d3675a1b3ff0721cZhongxing Xu 177326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *getParent() const { return Parent; } 178326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 1798ddf7cead8a67342a4584a203e0bf736b7efedbeZhongxing Xu bool isParentOf(const LocationContext *LC) const; 1808ddf7cead8a67342a4584a203e0bf736b7efedbeZhongxing Xu 181326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const Decl *getDecl() const { return getAnalysisContext()->getDecl(); } 182326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 183326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek CFG *getCFG() const { return getAnalysisContext()->getCFG(); } 184326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 185326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek LiveVariables *getLiveVariables() const { 186326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek return getAnalysisContext()->getLiveVariables(); 187326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 188326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 189d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek ParentMap &getParentMap() const { 190326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek return getAnalysisContext()->getParentMap(); 191326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 192326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 193326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const ImplicitParamDecl *getSelfDecl() const { 194326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek return Ctx->getSelfDecl(); 195326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 196d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 197326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const StackFrameContext *getCurrentStackFrame() const; 198326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const StackFrameContext * 199326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek getStackFrameForDeclContext(const DeclContext *DC) const; 200326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 201326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek virtual void Profile(llvm::FoldingSetNodeID &ID) = 0; 202326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 203326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek static bool classof(const LocationContext*) { return true; } 204326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 205326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 206326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek static void ProfileCommon(llvm::FoldingSetNodeID &ID, 207326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ContextKind ck, 208326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek AnalysisContext *ctx, 209326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *parent, 210326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const void* data); 211326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek}; 212326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 213326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass StackFrameContext : public LocationContext { 21426c9cb55cb96643c0759c08d037c16c309864087Zhongxing Xu // The callsite where this stack frame is established. 215892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek const Stmt *CallSite; 216326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 217326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek // The parent block of the callsite. 218326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const CFGBlock *Block; 219326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 220326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek // The index of the callsite in the CFGBlock. 221326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek unsigned Index; 222326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 223326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek friend class LocationContextManager; 224326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek StackFrameContext(AnalysisContext *ctx, const LocationContext *parent, 225892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek const Stmt *s, const CFGBlock *blk, 226d706434b0231c76fd9acf30060646a7aa8f69aefZhongxing Xu unsigned idx) 227892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek : LocationContext(StackFrame, ctx, parent), CallSite(s), 228d706434b0231c76fd9acf30060646a7aa8f69aefZhongxing Xu Block(blk), Index(idx) {} 229326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 230326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 231326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ~StackFrameContext() {} 232326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 233892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek const Stmt *getCallSite() const { return CallSite; } 234d706434b0231c76fd9acf30060646a7aa8f69aefZhongxing Xu 235326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const CFGBlock *getCallSiteBlock() const { return Block; } 236326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 237326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek unsigned getIndex() const { return Index; } 238326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 239326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek void Profile(llvm::FoldingSetNodeID &ID); 240d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 241326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek static void Profile(llvm::FoldingSetNodeID &ID, AnalysisContext *ctx, 242d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek const LocationContext *parent, const Stmt *s, 243892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek const CFGBlock *blk, unsigned idx) { 244326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ProfileCommon(ID, StackFrame, ctx, parent, s); 245326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ID.AddPointer(blk); 246326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ID.AddInteger(idx); 247326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 248326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 249326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek static bool classof(const LocationContext* Ctx) { 250326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek return Ctx->getKind() == StackFrame; 251326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 252326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek}; 253326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 254326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass ScopeContext : public LocationContext { 255326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const Stmt *Enter; 256d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 257326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek friend class LocationContextManager; 258326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ScopeContext(AnalysisContext *ctx, const LocationContext *parent, 259326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const Stmt *s) 260326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek : LocationContext(Scope, ctx, parent), Enter(s) {} 261326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 262326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 263326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ~ScopeContext() {} 264326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 265326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek void Profile(llvm::FoldingSetNodeID &ID); 266326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 267326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek static void Profile(llvm::FoldingSetNodeID &ID, AnalysisContext *ctx, 268326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *parent, const Stmt *s) { 269326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ProfileCommon(ID, Scope, ctx, parent, s); 270326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 271326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 272326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek static bool classof(const LocationContext* Ctx) { 273326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek return Ctx->getKind() == Scope; 274326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 275326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek}; 276326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 277326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass BlockInvocationContext : public LocationContext { 278326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek // FIXME: Add back context-sensivity (we don't want libAnalysis to know 279326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek // about MemRegion). 280326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const BlockDecl *BD; 281326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 282326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek friend class LocationContextManager; 283326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 284326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek BlockInvocationContext(AnalysisContext *ctx, const LocationContext *parent, 285326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const BlockDecl *bd) 286326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek : LocationContext(Block, ctx, parent), BD(bd) {} 287326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 288326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 289326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ~BlockInvocationContext() {} 290326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 291326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const BlockDecl *getBlockDecl() const { return BD; } 292326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 293326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek void Profile(llvm::FoldingSetNodeID &ID); 294326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 295326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek static void Profile(llvm::FoldingSetNodeID &ID, AnalysisContext *ctx, 296326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *parent, const BlockDecl *bd) { 297326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ProfileCommon(ID, Block, ctx, parent, bd); 298326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 299d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 300326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek static bool classof(const LocationContext* Ctx) { 301326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek return Ctx->getKind() == Block; 302326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek } 303326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek}; 304326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 305326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekclass LocationContextManager { 306326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek llvm::FoldingSet<LocationContext> Contexts; 307326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekpublic: 308326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek ~LocationContextManager(); 309d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 310326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const StackFrameContext *getStackFrame(AnalysisContext *ctx, 311326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *parent, 312892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek const Stmt *s, 313d706434b0231c76fd9acf30060646a7aa8f69aefZhongxing Xu const CFGBlock *blk, unsigned idx); 314326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 315326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const ScopeContext *getScope(AnalysisContext *ctx, 316326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *parent, 317326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const Stmt *s); 318d064fdc4b7b64ca55b40b70490c79d6f569df78eTed Kremenek 319326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek /// Discard all previously created LocationContext objects. 320326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek void clear(); 321326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenekprivate: 322326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek template <typename LOC, typename DATA> 323326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LOC *getLocationContext(AnalysisContext *ctx, 324326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const LocationContext *parent, 325326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek const DATA *d); 326326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek}; 327326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek 328326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek} // end clang namespace 329326be568e2cb04285c84e6e26a3e6b3822607361Ted Kremenek#endif 330