Coverage Report

Created: 2019-02-23 12:57

/Users/buildslave/jenkins/workspace/clang-stage2-coverage-R/llvm/tools/clang/include/clang/Analysis/AnalysisDeclContext.h
Line
Count
Source (jump to first uncovered line)
1
// AnalysisDeclContext.h - Analysis context for Path Sens analysis -*- C++ -*-//
2
//
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
6
//
7
//===----------------------------------------------------------------------===//
8
//
9
// This file defines AnalysisDeclContext, a class that manages the analysis
10
// context data for path sensitive analysis.
11
//
12
//===----------------------------------------------------------------------===//
13
14
#ifndef LLVM_CLANG_ANALYSIS_ANALYSISDECLCONTEXT_H
15
#define LLVM_CLANG_ANALYSIS_ANALYSISDECLCONTEXT_H
16
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"
27
#include <functional>
28
#include <memory>
29
30
namespace clang {
31
32
class AnalysisDeclContextManager;
33
class ASTContext;
34
class BlockDecl;
35
class BlockInvocationContext;
36
class CFGReverseBlockReachabilityAnalysis;
37
class CFGStmtMap;
38
class ImplicitParamDecl;
39
class LocationContext;
40
class LocationContextManager;
41
class ParentMap;
42
class StackFrameContext;
43
class Stmt;
44
class VarDecl;
45
46
/// The base class of a hierarchy of objects representing analyses tied
47
/// to AnalysisDeclContext.
48
class ManagedAnalysis {
49
protected:
50
124k
  ManagedAnalysis() = default;
51
52
public:
53
  virtual ~ManagedAnalysis();
54
55
  // Subclasses need to implement:
56
  //
57
  //  static const void *getTag();
58
  //
59
  // Which returns a fixed pointer address to distinguish classes of
60
  // analysis objects.  They also need to implement:
61
  //
62
  //  static [Derived*] create(AnalysisDeclContext &Ctx);
63
  //
64
  // which creates the analysis object given an AnalysisDeclContext.
65
};
66
67
/// AnalysisDeclContext contains the context data for the function or method
68
/// under analysis.
69
class AnalysisDeclContext {
70
  /// Backpoint to the AnalysisManager object that created this
71
  /// AnalysisDeclContext. This may be null.
72
  AnalysisDeclContextManager *Manager;
73
74
  const Decl * const D;
75
76
  std::unique_ptr<CFG> cfg, completeCFG;
77
  std::unique_ptr<CFGStmtMap> cfgStmtMap;
78
79
  CFG::BuildOptions cfgBuildOptions;
80
  CFG::BuildOptions::ForcedBlkExprs *forcedBlkExprs = nullptr;
81
82
  bool builtCFG = false;
83
  bool builtCompleteCFG = false;
84
  std::unique_ptr<ParentMap> PM;
85
  std::unique_ptr<CFGReverseBlockReachabilityAnalysis> CFA;
86
87
  llvm::BumpPtrAllocator A;
88
89
  llvm::DenseMap<const BlockDecl *,void *> *ReferencedBlockVars = nullptr;
90
91
  void *ManagedAnalyses = nullptr;
92
93
public:
94
  AnalysisDeclContext(AnalysisDeclContextManager *Mgr,
95
                  const Decl *D);
96
97
  AnalysisDeclContext(AnalysisDeclContextManager *Mgr,
98
                  const Decl *D,
99
                  const CFG::BuildOptions &BuildOptions);
100
101
  ~AnalysisDeclContext();
102
103
780k
  ASTContext &getASTContext() const { return D->getASTContext(); }
104
1.38M
  const Decl *getDecl() const { return D; }
105
106
  /// Return the AnalysisDeclContextManager (if any) that created
107
  /// this AnalysisDeclContext.
108
63.2k
  AnalysisDeclContextManager *getManager() const {
109
63.2k
    return Manager;
110
63.2k
  }
111
112
  /// Return the build options used to construct the CFG.
113
3.84M
  CFG::BuildOptions &getCFGBuildOptions() {
114
3.84M
    return cfgBuildOptions;
115
3.84M
  }
116
117
18.3k
  const CFG::BuildOptions &getCFGBuildOptions() const {
118
18.3k
    return cfgBuildOptions;
119
18.3k
  }
120
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
124
  /// cope with that.
125
219k
  bool getAddEHEdges() const { return cfgBuildOptions.AddEHEdges; }
126
0
  bool getUseUnoptimizedCFG() const {
127
0
      return !cfgBuildOptions.PruneTriviallyFalseEdges;
128
0
  }
129
0
  bool getAddImplicitDtors() const { return cfgBuildOptions.AddImplicitDtors; }
130
0
  bool getAddInitializers() const { return cfgBuildOptions.AddInitializers; }
131
132
  void registerForcedBlockExpression(const Stmt *stmt);
133
  const CFGBlock *getBlockForRegisteredExpression(const Stmt *stmt);
134
135
  /// Get the body of the Declaration.
136
  Stmt *getBody() const;
137
138
  /// Get the body of the Declaration.
139
  /// \param[out] IsAutosynthesized Specifies if the body is auto-generated
140
  ///             by the BodyFarm.
141
  Stmt *getBody(bool &IsAutosynthesized) const;
142
143
  /// Checks if the body of the Decl is generated by the BodyFarm.
144
  ///
145
  /// Note, the lookup is not free. We are going to call getBody behind
146
  /// the scenes.
147
  /// \sa getBody
148
  bool isBodyAutosynthesized() const;
149
150
  /// Checks if the body of the Decl is generated by the BodyFarm from a
151
  /// model file.
152
  ///
153
  /// Note, the lookup is not free. We are going to call getBody behind
154
  /// the scenes.
155
  /// \sa getBody
156
  bool isBodyAutosynthesizedFromModelFile() const;
157
158
  CFG *getCFG();
159
160
  CFGStmtMap *getCFGStmtMap();
161
162
  CFGReverseBlockReachabilityAnalysis *getCFGReachablityAnalysis();
163
164
  /// Return a version of the CFG without any edges pruned.
165
  CFG *getUnoptimizedCFG();
166
167
  void dumpCFG(bool ShowColors);
168
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
3
  bool isCFGBuilt() const { return builtCFG; }
173
174
  ParentMap &getParentMap();
175
176
  using referenced_decls_iterator = const VarDecl * const *;
177
178
  llvm::iterator_range<referenced_decls_iterator>
179
  getReferencedBlockVars(const BlockDecl *BD);
180
181
  /// Return the ImplicitParamDecl* associated with 'self' if this
182
  /// AnalysisDeclContext wraps an ObjCMethodDecl.  Returns NULL otherwise.
183
  const ImplicitParamDecl *getSelfDecl() const;
184
185
  const StackFrameContext *getStackFrame(LocationContext const *Parent,
186
                                         const Stmt *S,
187
                                         const CFGBlock *Blk,
188
                                         unsigned Idx);
189
190
  const BlockInvocationContext *
191
  getBlockInvocationContext(const LocationContext *parent,
192
                            const BlockDecl *BD,
193
                            const void *ContextData);
194
195
  /// Return the specified analysis object, lazily running the analysis if
196
  /// necessary.  Return NULL if the analysis could not run.
197
  template <typename T>
198
1.35M
  T *getAnalysis() {
199
1.35M
    const void *tag = T::getTag();
200
1.35M
    ManagedAnalysis *&data = getAnalysisImpl(tag);
201
1.35M
    if (!data) {
202
124k
      data = T::create(*this);
203
124k
    }
204
1.35M
    return static_cast<T *>(data);
205
1.35M
  }
clang::RelaxedLiveVariables* clang::AnalysisDeclContext::getAnalysis<clang::RelaxedLiveVariables>()
Line
Count
Source
198
1.25M
  T *getAnalysis() {
199
1.25M
    const void *tag = T::getTag();
200
1.25M
    ManagedAnalysis *&data = getAnalysisImpl(tag);
201
1.25M
    if (!data) {
202
17.7k
      data = T::create(*this);
203
17.7k
    }
204
1.25M
    return static_cast<T *>(data);
205
1.25M
  }
clang::PostOrderCFGView* clang::AnalysisDeclContext::getAnalysis<clang::PostOrderCFGView>()
Line
Count
Source
198
106k
  T *getAnalysis() {
199
106k
    const void *tag = T::getTag();
200
106k
    ManagedAnalysis *&data = getAnalysisImpl(tag);
201
106k
    if (!data) {
202
106k
      data = T::create(*this);
203
106k
    }
204
106k
    return static_cast<T *>(data);
205
106k
  }
clang::LiveVariables* clang::AnalysisDeclContext::getAnalysis<clang::LiveVariables>()
Line
Count
Source
198
446
  T *getAnalysis() {
199
446
    const void *tag = T::getTag();
200
446
    ManagedAnalysis *&data = getAnalysisImpl(tag);
201
446
    if (!data) {
202
446
      data = T::create(*this);
203
446
    }
204
446
    return static_cast<T *>(data);
205
446
  }
206
207
  /// Returns true if the root namespace of the given declaration is the 'std'
208
  /// C++ namespace.
209
  static bool isInStdNamespace(const Decl *D);
210
211
private:
212
  ManagedAnalysis *&getAnalysisImpl(const void* tag);
213
214
  LocationContextManager &getLocationContextManager();
215
};
216
217
class LocationContext : public llvm::FoldingSetNode {
218
public:
219
  enum ContextKind { StackFrame, Scope, Block };
220
221
private:
222
  ContextKind Kind;
223
224
  // AnalysisDeclContext can't be const since some methods may modify its
225
  // member.
226
  AnalysisDeclContext *Ctx;
227
228
  const LocationContext *Parent;
229
  int64_t ID;
230
231
protected:
232
  LocationContext(ContextKind k, AnalysisDeclContext *ctx,
233
                  const LocationContext *parent,
234
                  int64_t ID)
235
17.7k
      : Kind(k), Ctx(ctx), Parent(parent), ID(ID) {}
236
237
public:
238
  virtual ~LocationContext();
239
240
5.99M
  ContextKind getKind() const { return Kind; }
241
242
1
  int64_t getID() const {
243
1
    return ID;
244
1
  }
245
246
5.65M
  AnalysisDeclContext *getAnalysisDeclContext() const { return Ctx; }
247
248
2.64M
  const LocationContext *getParent() const { return Parent; }
249
250
  bool isParentOf(const LocationContext *LC) const;
251
252
806k
  const Decl *getDecl() const { return getAnalysisDeclContext()->getDecl(); }
253
254
429k
  CFG *getCFG() const { return getAnalysisDeclContext()->getCFG(); }
255
256
  template <typename T>
257
1.23M
  T *getAnalysis() const {
258
1.23M
    return getAnalysisDeclContext()->getAnalysis<T>();
259
1.23M
  }
260
261
1.26M
  ParentMap &getParentMap() const {
262
1.26M
    return getAnalysisDeclContext()->getParentMap();
263
1.26M
  }
264
265
3.50k
  const ImplicitParamDecl *getSelfDecl() const {
266
3.50k
    return Ctx->getSelfDecl();
267
3.50k
  }
268
269
  const StackFrameContext *getStackFrame() const;
270
271
  /// Return true if the current LocationContext has no caller context.
272
  virtual bool inTopFrame() const;
273
274
  virtual void Profile(llvm::FoldingSetNodeID &ID) = 0;
275
276
  void dumpStack(
277
      raw_ostream &OS, StringRef Indent = {}, const char *NL = "\n",
278
      const char *Sep = "",
279
      std::function<void(const LocationContext *)> printMoreInfoPerContext =
280
0
          [](const LocationContext *) {}) const;
281
  void dumpStack() const;
282
283
public:
284
  static void ProfileCommon(llvm::FoldingSetNodeID &ID,
285
                            ContextKind ck,
286
                            AnalysisDeclContext *ctx,
287
                            const LocationContext *parent,
288
                            const void *data);
289
};
290
291
class StackFrameContext : public LocationContext {
292
  friend class LocationContextManager;
293
294
  // The callsite where this stack frame is established.
295
  const Stmt *CallSite;
296
297
  // The parent block of the callsite.
298
  const CFGBlock *Block;
299
300
  // The index of the callsite in the CFGBlock.
301
  unsigned Index;
302
303
  StackFrameContext(AnalysisDeclContext *ctx, const LocationContext *parent,
304
                    const Stmt *s, const CFGBlock *blk,
305
                    unsigned idx,
306
                    int64_t ID)
307
      : LocationContext(StackFrame, ctx, parent, ID), CallSite(s),
308
17.6k
        Block(blk), Index(idx) {}
309
310
public:
311
17.6k
  ~StackFrameContext() override = default;
312
313
135k
  const Stmt *getCallSite() const { return CallSite; }
314
315
78.0k
  const CFGBlock *getCallSiteBlock() const { return Block; }
316
317
  /// Return true if the current LocationContext has no caller context.
318
182k
  bool inTopFrame() const override { return getParent() == nullptr;  }
319
320
78.0k
  unsigned getIndex() const { return Index; }
321
322
  void Profile(llvm::FoldingSetNodeID &ID) override;
323
324
  static void Profile(llvm::FoldingSetNodeID &ID, AnalysisDeclContext *ctx,
325
                      const LocationContext *parent, const Stmt *s,
326
91.3k
                      const CFGBlock *blk, unsigned idx) {
327
91.3k
    ProfileCommon(ID, StackFrame, ctx, parent, s);
328
91.3k
    ID.AddPointer(blk);
329
91.3k
    ID.AddInteger(idx);
330
91.3k
  }
331
332
5.99M
  static bool classof(const LocationContext *Ctx) {
333
5.99M
    return Ctx->getKind() == StackFrame;
334
5.99M
  }
335
};
336
337
class ScopeContext : public LocationContext {
338
  friend class LocationContextManager;
339
340
  const Stmt *Enter;
341
342
  ScopeContext(AnalysisDeclContext *ctx, const LocationContext *parent,
343
               const Stmt *s, int64_t ID)
344
0
      : LocationContext(Scope, ctx, parent, ID), Enter(s) {}
345
346
public:
347
0
  ~ScopeContext() override = default;
348
349
  void Profile(llvm::FoldingSetNodeID &ID) override;
350
351
  static void Profile(llvm::FoldingSetNodeID &ID, AnalysisDeclContext *ctx,
352
0
                      const LocationContext *parent, const Stmt *s) {
353
0
    ProfileCommon(ID, Scope, ctx, parent, s);
354
0
  }
355
356
0
  static bool classof(const LocationContext *Ctx) {
357
0
    return Ctx->getKind() == Scope;
358
0
  }
359
};
360
361
class BlockInvocationContext : public LocationContext {
362
  friend class LocationContextManager;
363
364
  const BlockDecl *BD;
365
366
  // FIXME: Come up with a more type-safe way to model context-sensitivity.
367
  const void *ContextData;
368
369
  BlockInvocationContext(AnalysisDeclContext *ctx,
370
                         const LocationContext *parent, const BlockDecl *bd,
371
                         const void *contextData, int64_t ID)
372
      : LocationContext(Block, ctx, parent, ID), BD(bd),
373
150
        ContextData(contextData) {}
374
375
public:
376
150
  ~BlockInvocationContext() override = default;
377
378
0
  const BlockDecl *getBlockDecl() const { return BD; }
379
380
161
  const void *getContextData() const { return ContextData; }
381
382
  void Profile(llvm::FoldingSetNodeID &ID) override;
383
384
  static void Profile(llvm::FoldingSetNodeID &ID, AnalysisDeclContext *ctx,
385
                      const LocationContext *parent, const BlockDecl *bd,
386
233
                      const void *contextData) {
387
233
    ProfileCommon(ID, Block, ctx, parent, bd);
388
233
    ID.AddPointer(contextData);
389
233
  }
390
391
547
  static bool classof(const LocationContext *Ctx) {
392
547
    return Ctx->getKind() == Block;
393
547
  }
394
};
395
396
class LocationContextManager {
397
  llvm::FoldingSet<LocationContext> Contexts;
398
399
  /// ID used for generating a new location context.
400
  int64_t NewID = 0;
401
402
public:
403
  ~LocationContextManager();
404
405
  const StackFrameContext *getStackFrame(AnalysisDeclContext *ctx,
406
                                         const LocationContext *parent,
407
                                         const Stmt *s,
408
                                         const CFGBlock *blk, unsigned idx);
409
410
  const ScopeContext *getScope(AnalysisDeclContext *ctx,
411
                               const LocationContext *parent,
412
                               const Stmt *s);
413
414
  const BlockInvocationContext *
415
  getBlockInvocationContext(AnalysisDeclContext *ctx,
416
                            const LocationContext *parent,
417
                            const BlockDecl *BD,
418
                            const void *ContextData);
419
420
  /// Discard all previously created LocationContext objects.
421
  void clear();
422
private:
423
  template <typename LOC, typename DATA>
424
  const LOC *getLocationContext(AnalysisDeclContext *ctx,
425
                                const LocationContext *parent,
426
                                const DATA *d);
427
};
428
429
class AnalysisDeclContextManager {
430
  using ContextMap =
431
      llvm::DenseMap<const Decl *, std::unique_ptr<AnalysisDeclContext>>;
432
433
  ContextMap Contexts;
434
  LocationContextManager LocContexts;
435
  CFG::BuildOptions cfgBuildOptions;
436
437
  /// Pointer to an interface that can provide function bodies for
438
  /// declarations from external source.
439
  std::unique_ptr<CodeInjector> Injector;
440
441
  /// A factory for creating and caching implementations for common
442
  /// methods during the analysis.
443
  BodyFarm FunctionBodyFarm;
444
445
  /// Flag to indicate whether or not bodies should be synthesized
446
  /// for well-known functions.
447
  bool SynthesizeBodies;
448
449
public:
450
  AnalysisDeclContextManager(ASTContext &ASTCtx, bool useUnoptimizedCFG = false,
451
                             bool addImplicitDtors = false,
452
                             bool addInitializers = false,
453
                             bool addTemporaryDtors = false,
454
                             bool addLifetime = false,
455
                             bool addLoopExit = false,
456
                             bool addScopes = false,
457
                             bool synthesizeBodies = false,
458
                             bool addStaticInitBranches = false,
459
                             bool addCXXNewAllocator = true,
460
                             bool addRichCXXConstructors = true,
461
                             bool markElidedCXXConstructors = true,
462
                             CodeInjector *injector = nullptr);
463
464
  AnalysisDeclContext *getContext(const Decl *D);
465
466
0
  bool getUseUnoptimizedCFG() const {
467
0
    return !cfgBuildOptions.PruneTriviallyFalseEdges;
468
0
  }
469
470
841
  CFG::BuildOptions &getCFGBuildOptions() {
471
841
    return cfgBuildOptions;
472
841
  }
473
474
  /// Return true if faux bodies should be synthesized for well-known
475
  /// functions.
476
1.29M
  bool synthesizeBodies() const { return SynthesizeBodies; }
477
478
  const StackFrameContext *getStackFrame(AnalysisDeclContext *Ctx,
479
                                         LocationContext const *Parent,
480
                                         const Stmt *S,
481
                                         const CFGBlock *Blk,
482
1.61k
                                         unsigned Idx) {
483
1.61k
    return LocContexts.getStackFrame(Ctx, Parent, S, Blk, Idx);
484
1.61k
  }
485
486
  // Get the top level stack frame.
487
10.5k
  const StackFrameContext *getStackFrame(const Decl *D) {
488
10.5k
    return LocContexts.getStackFrame(getContext(D), nullptr, nullptr, nullptr,
489
10.5k
                                     0);
490
10.5k
  }
491
492
  // Get a stack frame with parent.
493
  StackFrameContext const *getStackFrame(const Decl *D,
494
                                         LocationContext const *Parent,
495
                                         const Stmt *S,
496
                                         const CFGBlock *Blk,
497
0
                                         unsigned Idx) {
498
0
    return LocContexts.getStackFrame(getContext(D), Parent, S, Blk, Idx);
499
0
  }
500
501
  /// Get a reference to {@code BodyFarm} instance.
502
  BodyFarm &getBodyFarm();
503
504
  /// Discard all previously created AnalysisDeclContexts.
505
  void clear();
506
507
private:
508
  friend class AnalysisDeclContext;
509
510
26.8k
  LocationContextManager &getLocationContextManager() {
511
26.8k
    return LocContexts;
512
26.8k
  }
513
};
514
515
} // namespace clang
516
517
#endif // LLVM_CLANG_ANALYSIS_ANALYSISDECLCONTEXT_H