1 //=== AnalysisContext.h - Analysis context for Path Sens analysis --*- C++ -*-//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines AnalysisDeclContext, a class that manages the analysis
11 // context data for path sensitive analysis.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_CLANG_ANALYSIS_ANALYSISCONTEXT_H
16 #define LLVM_CLANG_ANALYSIS_ANALYSISCONTEXT_H
18 #include "clang/AST/Decl.h"
19 #include "clang/Analysis/CFG.h"
20 #include "clang/Analysis/CodeInjector.h"
21 #include "llvm/ADT/DenseMap.h"
22 #include "llvm/ADT/FoldingSet.h"
23 #include "llvm/Support/Allocator.h"
29 class CFGReverseBlockReachabilityAnalysis;
32 class ManagedAnalysis;
34 class PseudoConstantAnalysis;
35 class LocationContextManager;
36 class StackFrameContext;
37 class BlockInvocationContext;
38 class AnalysisDeclContextManager;
39 class LocationContext;
41 namespace idx { class TranslationUnit; }
43 /// The base class of a hierarchy of objects representing analyses tied
44 /// to AnalysisDeclContext.
45 class ManagedAnalysis {
49 virtual ~ManagedAnalysis();
51 // Subclasses need to implement:
53 // static const void *getTag();
55 // Which returns a fixed pointer address to distinguish classes of
56 // analysis objects. They also need to implement:
58 // static [Derived*] create(AnalysisDeclContext &Ctx);
60 // which creates the analysis object given an AnalysisDeclContext.
64 /// AnalysisDeclContext contains the context data for the function or method
66 class AnalysisDeclContext {
67 /// Backpoint to the AnalysisManager object that created this
68 /// AnalysisDeclContext. This may be null.
69 AnalysisDeclContextManager *Manager;
73 std::unique_ptr<CFG> cfg, completeCFG;
74 std::unique_ptr<CFGStmtMap> cfgStmtMap;
76 CFG::BuildOptions cfgBuildOptions;
77 CFG::BuildOptions::ForcedBlkExprs *forcedBlkExprs;
79 bool builtCFG, builtCompleteCFG;
80 std::unique_ptr<ParentMap> PM;
81 std::unique_ptr<PseudoConstantAnalysis> PCA;
82 std::unique_ptr<CFGReverseBlockReachabilityAnalysis> CFA;
84 llvm::BumpPtrAllocator A;
86 llvm::DenseMap<const BlockDecl*,void*> *ReferencedBlockVars;
88 void *ManagedAnalyses;
91 AnalysisDeclContext(AnalysisDeclContextManager *Mgr,
94 AnalysisDeclContext(AnalysisDeclContextManager *Mgr,
96 const CFG::BuildOptions &BuildOptions);
98 ~AnalysisDeclContext();
100 ASTContext &getASTContext() const { return D->getASTContext(); }
101 const Decl *getDecl() const { return D; }
103 /// Return the AnalysisDeclContextManager (if any) that created
104 /// this AnalysisDeclContext.
105 AnalysisDeclContextManager *getManager() const {
109 /// Return the build options used to construct the CFG.
110 CFG::BuildOptions &getCFGBuildOptions() {
111 return cfgBuildOptions;
114 const CFG::BuildOptions &getCFGBuildOptions() const {
115 return cfgBuildOptions;
118 /// getAddEHEdges - Return true iff we are adding exceptional edges from
119 /// callExprs. If this is false, then try/catch statements and blocks
120 /// reachable from them can appear to be dead in the CFG, analysis passes must
122 bool getAddEHEdges() const { return cfgBuildOptions.AddEHEdges; }
123 bool getUseUnoptimizedCFG() const {
124 return !cfgBuildOptions.PruneTriviallyFalseEdges;
126 bool getAddImplicitDtors() const { return cfgBuildOptions.AddImplicitDtors; }
127 bool getAddInitializers() const { return cfgBuildOptions.AddInitializers; }
129 void registerForcedBlockExpression(const Stmt *stmt);
130 const CFGBlock *getBlockForRegisteredExpression(const Stmt *stmt);
132 /// \brief Get the body of the Declaration.
133 Stmt *getBody() const;
135 /// \brief Get the body of the Declaration.
136 /// \param[out] IsAutosynthesized Specifies if the body is auto-generated
138 Stmt *getBody(bool &IsAutosynthesized) const;
140 /// \brief Checks if the body of the Decl is generated by the BodyFarm.
142 /// Note, the lookup is not free. We are going to call getBody behind
145 bool isBodyAutosynthesized() const;
147 /// \brief Checks if the body of the Decl is generated by the BodyFarm from a
150 /// Note, the lookup is not free. We are going to call getBody behind
153 bool isBodyAutosynthesizedFromModelFile() const;
157 CFGStmtMap *getCFGStmtMap();
159 CFGReverseBlockReachabilityAnalysis *getCFGReachablityAnalysis();
161 /// Return a version of the CFG without any edges pruned.
162 CFG *getUnoptimizedCFG();
164 void dumpCFG(bool ShowColors);
166 /// \brief Returns true if we have built a CFG for this analysis context.
167 /// Note that this doesn't correspond to whether or not a valid CFG exists, it
168 /// corresponds to whether we *attempted* to build one.
169 bool isCFGBuilt() const { return builtCFG; }
171 ParentMap &getParentMap();
172 PseudoConstantAnalysis *getPseudoConstantAnalysis();
174 typedef const VarDecl * const * referenced_decls_iterator;
176 llvm::iterator_range<referenced_decls_iterator>
177 getReferencedBlockVars(const BlockDecl *BD);
179 /// Return the ImplicitParamDecl* associated with 'self' if this
180 /// AnalysisDeclContext wraps an ObjCMethodDecl. Returns NULL otherwise.
181 const ImplicitParamDecl *getSelfDecl() const;
183 const StackFrameContext *getStackFrame(LocationContext const *Parent,
188 const BlockInvocationContext *
189 getBlockInvocationContext(const LocationContext *parent,
191 const void *ContextData);
193 /// Return the specified analysis object, lazily running the analysis if
194 /// necessary. Return NULL if the analysis could not run.
195 template <typename T>
197 const void *tag = T::getTag();
198 ManagedAnalysis *&data = getAnalysisImpl(tag);
200 data = T::create(*this);
202 return static_cast<T*>(data);
205 ManagedAnalysis *&getAnalysisImpl(const void* tag);
207 LocationContextManager &getLocationContextManager();
210 class LocationContext : public llvm::FoldingSetNode {
212 enum ContextKind { StackFrame, Scope, Block };
217 // AnalysisDeclContext can't be const since some methods may modify its
219 AnalysisDeclContext *Ctx;
221 const LocationContext *Parent;
224 LocationContext(ContextKind k, AnalysisDeclContext *ctx,
225 const LocationContext *parent)
226 : Kind(k), Ctx(ctx), Parent(parent) {}
229 virtual ~LocationContext();
231 ContextKind getKind() const { return Kind; }
233 AnalysisDeclContext *getAnalysisDeclContext() const { return Ctx; }
235 const LocationContext *getParent() const { return Parent; }
237 bool isParentOf(const LocationContext *LC) const;
239 const Decl *getDecl() const { return getAnalysisDeclContext()->getDecl(); }
241 CFG *getCFG() const { return getAnalysisDeclContext()->getCFG(); }
243 template <typename T>
244 T *getAnalysis() const {
245 return getAnalysisDeclContext()->getAnalysis<T>();
248 ParentMap &getParentMap() const {
249 return getAnalysisDeclContext()->getParentMap();
252 const ImplicitParamDecl *getSelfDecl() const {
253 return Ctx->getSelfDecl();
256 const StackFrameContext *getCurrentStackFrame() const;
258 /// Return true if the current LocationContext has no caller context.
259 virtual bool inTopFrame() const;
261 virtual void Profile(llvm::FoldingSetNodeID &ID) = 0;
263 void dumpStack(raw_ostream &OS, StringRef Indent = "") const;
264 void dumpStack() const;
267 static void ProfileCommon(llvm::FoldingSetNodeID &ID,
269 AnalysisDeclContext *ctx,
270 const LocationContext *parent,
274 class StackFrameContext : public LocationContext {
275 // The callsite where this stack frame is established.
276 const Stmt *CallSite;
278 // The parent block of the callsite.
279 const CFGBlock *Block;
281 // The index of the callsite in the CFGBlock.
284 friend class LocationContextManager;
285 StackFrameContext(AnalysisDeclContext *ctx, const LocationContext *parent,
286 const Stmt *s, const CFGBlock *blk,
288 : LocationContext(StackFrame, ctx, parent), CallSite(s),
289 Block(blk), Index(idx) {}
292 ~StackFrameContext() override {}
294 const Stmt *getCallSite() const { return CallSite; }
296 const CFGBlock *getCallSiteBlock() const { return Block; }
298 /// Return true if the current LocationContext has no caller context.
299 bool inTopFrame() const override { return getParent() == nullptr; }
301 unsigned getIndex() const { return Index; }
303 void Profile(llvm::FoldingSetNodeID &ID) override;
305 static void Profile(llvm::FoldingSetNodeID &ID, AnalysisDeclContext *ctx,
306 const LocationContext *parent, const Stmt *s,
307 const CFGBlock *blk, unsigned idx) {
308 ProfileCommon(ID, StackFrame, ctx, parent, s);
313 static bool classof(const LocationContext *Ctx) {
314 return Ctx->getKind() == StackFrame;
318 class ScopeContext : public LocationContext {
321 friend class LocationContextManager;
322 ScopeContext(AnalysisDeclContext *ctx, const LocationContext *parent,
324 : LocationContext(Scope, ctx, parent), Enter(s) {}
327 ~ScopeContext() override {}
329 void Profile(llvm::FoldingSetNodeID &ID) override;
331 static void Profile(llvm::FoldingSetNodeID &ID, AnalysisDeclContext *ctx,
332 const LocationContext *parent, const Stmt *s) {
333 ProfileCommon(ID, Scope, ctx, parent, s);
336 static bool classof(const LocationContext *Ctx) {
337 return Ctx->getKind() == Scope;
341 class BlockInvocationContext : public LocationContext {
344 // FIXME: Come up with a more type-safe way to model context-sensitivity.
345 const void *ContextData;
347 friend class LocationContextManager;
349 BlockInvocationContext(AnalysisDeclContext *ctx,
350 const LocationContext *parent,
351 const BlockDecl *bd, const void *contextData)
352 : LocationContext(Block, ctx, parent), BD(bd), ContextData(contextData) {}
355 ~BlockInvocationContext() override {}
357 const BlockDecl *getBlockDecl() const { return BD; }
359 const void *getContextData() const { return ContextData; }
361 void Profile(llvm::FoldingSetNodeID &ID) override;
363 static void Profile(llvm::FoldingSetNodeID &ID, AnalysisDeclContext *ctx,
364 const LocationContext *parent, const BlockDecl *bd,
365 const void *contextData) {
366 ProfileCommon(ID, Block, ctx, parent, bd);
367 ID.AddPointer(contextData);
370 static bool classof(const LocationContext *Ctx) {
371 return Ctx->getKind() == Block;
375 class LocationContextManager {
376 llvm::FoldingSet<LocationContext> Contexts;
378 ~LocationContextManager();
380 const StackFrameContext *getStackFrame(AnalysisDeclContext *ctx,
381 const LocationContext *parent,
383 const CFGBlock *blk, unsigned idx);
385 const ScopeContext *getScope(AnalysisDeclContext *ctx,
386 const LocationContext *parent,
389 const BlockInvocationContext *
390 getBlockInvocationContext(AnalysisDeclContext *ctx,
391 const LocationContext *parent,
393 const void *ContextData);
395 /// Discard all previously created LocationContext objects.
398 template <typename LOC, typename DATA>
399 const LOC *getLocationContext(AnalysisDeclContext *ctx,
400 const LocationContext *parent,
404 class AnalysisDeclContextManager {
405 typedef llvm::DenseMap<const Decl*, AnalysisDeclContext*> ContextMap;
408 LocationContextManager LocContexts;
409 CFG::BuildOptions cfgBuildOptions;
411 /// Pointer to an interface that can provide function bodies for
412 /// declarations from external source.
413 std::unique_ptr<CodeInjector> Injector;
415 /// Flag to indicate whether or not bodies should be synthesized
416 /// for well-known functions.
417 bool SynthesizeBodies;
420 AnalysisDeclContextManager(bool useUnoptimizedCFG = false,
421 bool addImplicitDtors = false,
422 bool addInitializers = false,
423 bool addTemporaryDtors = false,
424 bool synthesizeBodies = false,
425 bool addStaticInitBranches = false,
426 bool addCXXNewAllocator = true,
427 CodeInjector* injector = nullptr);
429 ~AnalysisDeclContextManager();
431 AnalysisDeclContext *getContext(const Decl *D);
433 bool getUseUnoptimizedCFG() const {
434 return !cfgBuildOptions.PruneTriviallyFalseEdges;
437 CFG::BuildOptions &getCFGBuildOptions() {
438 return cfgBuildOptions;
441 /// Return true if faux bodies should be synthesized for well-known
443 bool synthesizeBodies() const { return SynthesizeBodies; }
445 const StackFrameContext *getStackFrame(AnalysisDeclContext *Ctx,
446 LocationContext const *Parent,
450 return LocContexts.getStackFrame(Ctx, Parent, S, Blk, Idx);
453 // Get the top level stack frame.
454 const StackFrameContext *getStackFrame(const Decl *D) {
455 return LocContexts.getStackFrame(getContext(D), nullptr, nullptr, nullptr,
459 // Get a stack frame with parent.
460 StackFrameContext const *getStackFrame(const Decl *D,
461 LocationContext const *Parent,
465 return LocContexts.getStackFrame(getContext(D), Parent, S, Blk, Idx);
468 /// Discard all previously created AnalysisDeclContexts.
472 friend class AnalysisDeclContext;
474 LocationContextManager &getLocationContextManager() {
479 } // end clang namespace