1 // AnalysisDeclContext.h - Analysis context for Path Sens analysis -*- C++ -*-//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 // This file defines AnalysisDeclContext, a class that manages the analysis
10 // context data for path sensitive analysis.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_ANALYSIS_ANALYSISDECLCONTEXT_H
15 #define LLVM_CLANG_ANALYSIS_ANALYSISDECLCONTEXT_H
17 #include "clang/AST/DeclBase.h"
18 #include "clang/Analysis/BodyFarm.h"
19 #include "clang/Analysis/CFG.h"
20 #include "clang/Analysis/CodeInjector.h"
21 #include "clang/Basic/LLVM.h"
22 #include "llvm/ADT/DenseMap.h"
23 #include "llvm/ADT/FoldingSet.h"
24 #include "llvm/ADT/StringRef.h"
25 #include "llvm/ADT/iterator_range.h"
26 #include "llvm/Support/Allocator.h"
32 class AnalysisDeclContextManager;
35 class BlockInvocationContext;
36 class CFGReverseBlockReachabilityAnalysis;
38 class ImplicitParamDecl;
39 class LocationContext;
40 class LocationContextManager;
42 class StackFrameContext;
46 /// The base class of a hierarchy of objects representing analyses tied
47 /// to AnalysisDeclContext.
48 class ManagedAnalysis {
50 ManagedAnalysis() = default;
53 virtual ~ManagedAnalysis();
55 // Subclasses need to implement:
57 // static const void *getTag();
59 // Which returns a fixed pointer address to distinguish classes of
60 // analysis objects. They also need to implement:
62 // static [Derived*] create(AnalysisDeclContext &Ctx);
64 // which creates the analysis object given an AnalysisDeclContext.
67 /// AnalysisDeclContext contains the context data for the function or method
69 class AnalysisDeclContext {
70 /// Backpoint to the AnalysisManager object that created this
71 /// AnalysisDeclContext. This may be null.
72 AnalysisDeclContextManager *Manager;
76 std::unique_ptr<CFG> cfg, completeCFG;
77 std::unique_ptr<CFGStmtMap> cfgStmtMap;
79 CFG::BuildOptions cfgBuildOptions;
80 CFG::BuildOptions::ForcedBlkExprs *forcedBlkExprs = nullptr;
82 bool builtCFG = false;
83 bool builtCompleteCFG = false;
84 std::unique_ptr<ParentMap> PM;
85 std::unique_ptr<CFGReverseBlockReachabilityAnalysis> CFA;
87 llvm::BumpPtrAllocator A;
89 llvm::DenseMap<const BlockDecl *,void *> *ReferencedBlockVars = nullptr;
91 void *ManagedAnalyses = nullptr;
94 AnalysisDeclContext(AnalysisDeclContextManager *Mgr,
97 AnalysisDeclContext(AnalysisDeclContextManager *Mgr,
99 const CFG::BuildOptions &BuildOptions);
101 ~AnalysisDeclContext();
103 ASTContext &getASTContext() const { return D->getASTContext(); }
104 const Decl *getDecl() const { return D; }
106 /// Return the AnalysisDeclContextManager (if any) that created
107 /// this AnalysisDeclContext.
108 AnalysisDeclContextManager *getManager() const {
112 /// Return the build options used to construct the CFG.
113 CFG::BuildOptions &getCFGBuildOptions() {
114 return cfgBuildOptions;
117 const CFG::BuildOptions &getCFGBuildOptions() const {
118 return cfgBuildOptions;
121 /// getAddEHEdges - Return true iff we are adding exceptional edges from
122 /// callExprs. If this is false, then try/catch statements and blocks
123 /// reachable from them can appear to be dead in the CFG, analysis passes must
125 bool getAddEHEdges() const { return cfgBuildOptions.AddEHEdges; }
126 bool getUseUnoptimizedCFG() const {
127 return !cfgBuildOptions.PruneTriviallyFalseEdges;
129 bool getAddImplicitDtors() const { return cfgBuildOptions.AddImplicitDtors; }
130 bool getAddInitializers() const { return cfgBuildOptions.AddInitializers; }
132 void registerForcedBlockExpression(const Stmt *stmt);
133 const CFGBlock *getBlockForRegisteredExpression(const Stmt *stmt);
135 /// Get the body of the Declaration.
136 Stmt *getBody() const;
138 /// Get the body of the Declaration.
139 /// \param[out] IsAutosynthesized Specifies if the body is auto-generated
141 Stmt *getBody(bool &IsAutosynthesized) const;
143 /// Checks if the body of the Decl is generated by the BodyFarm.
145 /// Note, the lookup is not free. We are going to call getBody behind
148 bool isBodyAutosynthesized() const;
150 /// Checks if the body of the Decl is generated by the BodyFarm from a
153 /// Note, the lookup is not free. We are going to call getBody behind
156 bool isBodyAutosynthesizedFromModelFile() const;
160 CFGStmtMap *getCFGStmtMap();
162 CFGReverseBlockReachabilityAnalysis *getCFGReachablityAnalysis();
164 /// Return a version of the CFG without any edges pruned.
165 CFG *getUnoptimizedCFG();
167 void dumpCFG(bool ShowColors);
169 /// Returns true if we have built a CFG for this analysis context.
170 /// Note that this doesn't correspond to whether or not a valid CFG exists, it
171 /// corresponds to whether we *attempted* to build one.
172 bool isCFGBuilt() const { return builtCFG; }
174 ParentMap &getParentMap();
176 using referenced_decls_iterator = const VarDecl * const *;
178 llvm::iterator_range<referenced_decls_iterator>
179 getReferencedBlockVars(const BlockDecl *BD);
181 /// Return the ImplicitParamDecl* associated with 'self' if this
182 /// AnalysisDeclContext wraps an ObjCMethodDecl. Returns NULL otherwise.
183 const ImplicitParamDecl *getSelfDecl() const;
185 const StackFrameContext *getStackFrame(LocationContext const *Parent,
186 const Stmt *S, const CFGBlock *Blk,
187 unsigned BlockCount, unsigned Idx);
189 const BlockInvocationContext *
190 getBlockInvocationContext(const LocationContext *parent,
192 const void *ContextData);
194 /// Return the specified analysis object, lazily running the analysis if
195 /// necessary. Return NULL if the analysis could not run.
196 template <typename T>
198 const void *tag = T::getTag();
199 ManagedAnalysis *&data = getAnalysisImpl(tag);
201 data = T::create(*this);
203 return static_cast<T *>(data);
206 /// Returns true if the root namespace of the given declaration is the 'std'
208 static bool isInStdNamespace(const Decl *D);
211 ManagedAnalysis *&getAnalysisImpl(const void* tag);
213 LocationContextManager &getLocationContextManager();
216 class LocationContext : public llvm::FoldingSetNode {
218 enum ContextKind { StackFrame, Scope, Block };
223 // AnalysisDeclContext can't be const since some methods may modify its
225 AnalysisDeclContext *Ctx;
227 const LocationContext *Parent;
231 LocationContext(ContextKind k, AnalysisDeclContext *ctx,
232 const LocationContext *parent,
234 : Kind(k), Ctx(ctx), Parent(parent), ID(ID) {}
237 virtual ~LocationContext();
239 ContextKind getKind() const { return Kind; }
241 int64_t getID() const {
245 AnalysisDeclContext *getAnalysisDeclContext() const { return Ctx; }
247 const LocationContext *getParent() const { return Parent; }
249 bool isParentOf(const LocationContext *LC) const;
251 const Decl *getDecl() const { return getAnalysisDeclContext()->getDecl(); }
253 CFG *getCFG() const { return getAnalysisDeclContext()->getCFG(); }
255 template <typename T>
256 T *getAnalysis() const {
257 return getAnalysisDeclContext()->getAnalysis<T>();
260 const ParentMap &getParentMap() const {
261 return getAnalysisDeclContext()->getParentMap();
264 const ImplicitParamDecl *getSelfDecl() const {
265 return Ctx->getSelfDecl();
268 const StackFrameContext *getStackFrame() const;
270 /// Return true if the current LocationContext has no caller context.
271 virtual bool inTopFrame() const;
273 virtual void Profile(llvm::FoldingSetNodeID &ID) = 0;
276 raw_ostream &Out, const char *NL = "\n",
277 std::function<void(const LocationContext *)> printMoreInfoPerContext =
278 [](const LocationContext *) {}) const;
281 raw_ostream &Out, const char *NL = "\n", unsigned int Space = 0,
283 std::function<void(const LocationContext *)> printMoreInfoPerContext =
284 [](const LocationContext *) {}) const;
289 static void ProfileCommon(llvm::FoldingSetNodeID &ID,
291 AnalysisDeclContext *ctx,
292 const LocationContext *parent,
296 class StackFrameContext : public LocationContext {
297 friend class LocationContextManager;
299 // The callsite where this stack frame is established.
300 const Stmt *CallSite;
302 // The parent block of the callsite.
303 const CFGBlock *Block;
305 // The number of times the 'Block' has been visited.
306 // It allows discriminating between stack frames of the same call that is
307 // called multiple times in a loop.
308 const unsigned BlockCount;
310 // The index of the callsite in the CFGBlock.
311 const unsigned Index;
313 StackFrameContext(AnalysisDeclContext *ctx, const LocationContext *parent,
314 const Stmt *s, const CFGBlock *blk, unsigned blockCount,
315 unsigned idx, int64_t ID)
316 : LocationContext(StackFrame, ctx, parent, ID), CallSite(s), Block(blk),
317 BlockCount(blockCount), Index(idx) {}
320 ~StackFrameContext() override = default;
322 const Stmt *getCallSite() const { return CallSite; }
324 const CFGBlock *getCallSiteBlock() const { return Block; }
326 /// Return true if the current LocationContext has no caller context.
327 bool inTopFrame() const override { return getParent() == nullptr; }
329 unsigned getIndex() const { return Index; }
331 void Profile(llvm::FoldingSetNodeID &ID) override;
333 static void Profile(llvm::FoldingSetNodeID &ID, AnalysisDeclContext *ctx,
334 const LocationContext *parent, const Stmt *s,
335 const CFGBlock *blk, unsigned blockCount, unsigned idx) {
336 ProfileCommon(ID, StackFrame, ctx, parent, s);
338 ID.AddInteger(blockCount);
342 static bool classof(const LocationContext *Ctx) {
343 return Ctx->getKind() == StackFrame;
347 class ScopeContext : public LocationContext {
348 friend class LocationContextManager;
352 ScopeContext(AnalysisDeclContext *ctx, const LocationContext *parent,
353 const Stmt *s, int64_t ID)
354 : LocationContext(Scope, ctx, parent, ID), Enter(s) {}
357 ~ScopeContext() override = default;
359 void Profile(llvm::FoldingSetNodeID &ID) override;
361 static void Profile(llvm::FoldingSetNodeID &ID, AnalysisDeclContext *ctx,
362 const LocationContext *parent, const Stmt *s) {
363 ProfileCommon(ID, Scope, ctx, parent, s);
366 static bool classof(const LocationContext *Ctx) {
367 return Ctx->getKind() == Scope;
371 class BlockInvocationContext : public LocationContext {
372 friend class LocationContextManager;
376 // FIXME: Come up with a more type-safe way to model context-sensitivity.
377 const void *ContextData;
379 BlockInvocationContext(AnalysisDeclContext *ctx,
380 const LocationContext *parent, const BlockDecl *bd,
381 const void *contextData, int64_t ID)
382 : LocationContext(Block, ctx, parent, ID), BD(bd),
383 ContextData(contextData) {}
386 ~BlockInvocationContext() override = default;
388 const BlockDecl *getBlockDecl() const { return BD; }
390 const void *getContextData() const { return ContextData; }
392 void Profile(llvm::FoldingSetNodeID &ID) override;
394 static void Profile(llvm::FoldingSetNodeID &ID, AnalysisDeclContext *ctx,
395 const LocationContext *parent, const BlockDecl *bd,
396 const void *contextData) {
397 ProfileCommon(ID, Block, ctx, parent, bd);
398 ID.AddPointer(contextData);
401 static bool classof(const LocationContext *Ctx) {
402 return Ctx->getKind() == Block;
406 class LocationContextManager {
407 llvm::FoldingSet<LocationContext> Contexts;
409 /// ID used for generating a new location context.
413 ~LocationContextManager();
415 const StackFrameContext *getStackFrame(AnalysisDeclContext *ctx,
416 const LocationContext *parent,
417 const Stmt *s, const CFGBlock *blk,
418 unsigned blockCount, unsigned idx);
420 const ScopeContext *getScope(AnalysisDeclContext *ctx,
421 const LocationContext *parent,
424 const BlockInvocationContext *
425 getBlockInvocationContext(AnalysisDeclContext *ctx,
426 const LocationContext *parent,
428 const void *ContextData);
430 /// Discard all previously created LocationContext objects.
433 template <typename LOC, typename DATA>
434 const LOC *getLocationContext(AnalysisDeclContext *ctx,
435 const LocationContext *parent,
439 class AnalysisDeclContextManager {
441 llvm::DenseMap<const Decl *, std::unique_ptr<AnalysisDeclContext>>;
444 LocationContextManager LocContexts;
445 CFG::BuildOptions cfgBuildOptions;
447 /// Pointer to an interface that can provide function bodies for
448 /// declarations from external source.
449 std::unique_ptr<CodeInjector> Injector;
451 /// A factory for creating and caching implementations for common
452 /// methods during the analysis.
453 BodyFarm FunctionBodyFarm;
455 /// Flag to indicate whether or not bodies should be synthesized
456 /// for well-known functions.
457 bool SynthesizeBodies;
460 AnalysisDeclContextManager(ASTContext &ASTCtx, bool useUnoptimizedCFG = false,
461 bool addImplicitDtors = false,
462 bool addInitializers = false,
463 bool addTemporaryDtors = false,
464 bool addLifetime = false,
465 bool addLoopExit = false,
466 bool addScopes = false,
467 bool synthesizeBodies = false,
468 bool addStaticInitBranches = false,
469 bool addCXXNewAllocator = true,
470 bool addRichCXXConstructors = true,
471 bool markElidedCXXConstructors = true,
472 bool addVirtualBaseBranches = true,
473 CodeInjector *injector = nullptr);
475 AnalysisDeclContext *getContext(const Decl *D);
477 bool getUseUnoptimizedCFG() const {
478 return !cfgBuildOptions.PruneTriviallyFalseEdges;
481 CFG::BuildOptions &getCFGBuildOptions() {
482 return cfgBuildOptions;
485 /// Return true if faux bodies should be synthesized for well-known
487 bool synthesizeBodies() const { return SynthesizeBodies; }
489 const StackFrameContext *getStackFrame(AnalysisDeclContext *Ctx,
490 const LocationContext *Parent,
491 const Stmt *S, const CFGBlock *Blk,
492 unsigned BlockCount, unsigned Idx) {
493 return LocContexts.getStackFrame(Ctx, Parent, S, Blk, BlockCount, Idx);
496 // Get the top level stack frame.
497 const StackFrameContext *getStackFrame(const Decl *D) {
498 return LocContexts.getStackFrame(getContext(D), nullptr, nullptr, nullptr,
502 // Get a stack frame with parent.
503 StackFrameContext const *getStackFrame(const Decl *D,
504 const LocationContext *Parent,
505 const Stmt *S, const CFGBlock *Blk,
506 unsigned BlockCount, unsigned Idx) {
507 return LocContexts.getStackFrame(getContext(D), Parent, S, Blk, BlockCount,
511 /// Get a reference to {@code BodyFarm} instance.
512 BodyFarm &getBodyFarm();
514 /// Discard all previously created AnalysisDeclContexts.
518 friend class AnalysisDeclContext;
520 LocationContextManager &getLocationContextManager() {
527 #endif // LLVM_CLANG_ANALYSIS_ANALYSISDECLCONTEXT_H