CheckerManager.h revision 69f87c956b3ac2b80124fd9604af012e1061473a 
1//===--- CheckerManager.h - Static Analyzer Checker Manager -----*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// Defines the Static Analyzer Checker Manager.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_CLANG_SA_CORE_CHECKERMANAGER_H
15#define LLVM_CLANG_SA_CORE_CHECKERMANAGER_H
16
17#include "clang/Basic/LangOptions.h"
18#include "llvm/ADT/SmallVector.h"
19#include "llvm/ADT/DenseMap.h"
20#include "llvm/ADT/FoldingSet.h"
21#include "clang/StaticAnalyzer/Core/PathSensitive/Store.h"
22#include "clang/Analysis/ProgramPoint.h"
23#include <vector>
24
25namespace clang {
26  class Decl;
27  class Stmt;
28  class CallExpr;
29
30namespace ento {
31  class CheckerBase;
32  class ExprEngine;
33  class AnalysisManager;
34  class BugReporter;
35  class CheckerContext;
36  class SimpleCall;
37  class ObjCMethodCall;
38  class SVal;
39  class ExplodedNode;
40  class ExplodedNodeSet;
41  class ExplodedGraph;
42  class ProgramState;
43  class NodeBuilder;
44  struct NodeBuilderContext;
45  class MemRegion;
46  class SymbolReaper;
47
48template <typename T> class CheckerFn;
49
50template <typename RET, typename P1, typename P2, typename P3, typename P4,
51          typename P5>
52class CheckerFn<RET(P1, P2, P3, P4, P5)> {
53  typedef RET (*Func)(void *, P1, P2, P3, P4, P5);
54  Func Fn;
55public:
56  CheckerBase *Checker;
57  CheckerFn(CheckerBase *checker, Func fn) : Fn(fn), Checker(checker) { }
58  RET operator()(P1 p1, P2 p2, P3 p3, P4 p4, P5 p5) const {
59    return Fn(Checker, p1, p2, p3, p4, p5);
60  }
61};
62
63template <typename RET, typename P1, typename P2, typename P3, typename P4>
64class CheckerFn<RET(P1, P2, P3, P4)> {
65  typedef RET (*Func)(void *, P1, P2, P3, P4);
66  Func Fn;
67public:
68  CheckerBase *Checker;
69  CheckerFn(CheckerBase *checker, Func fn) : Fn(fn), Checker(checker) { }
70  RET operator()(P1 p1, P2 p2, P3 p3, P4 p4) const {
71    return Fn(Checker, p1, p2, p3, p4);
72  }
73};
74
75template <typename RET, typename P1, typename P2, typename P3>
76class CheckerFn<RET(P1, P2, P3)> {
77  typedef RET (*Func)(void *, P1, P2, P3);
78  Func Fn;
79public:
80  CheckerBase *Checker;
81  CheckerFn(CheckerBase *checker, Func fn) : Fn(fn), Checker(checker) { }
82  RET operator()(P1 p1, P2 p2, P3 p3) const { return Fn(Checker, p1, p2, p3); }
83};
84
85template <typename RET, typename P1, typename P2>
86class CheckerFn<RET(P1, P2)> {
87  typedef RET (*Func)(void *, P1, P2);
88  Func Fn;
89public:
90  CheckerBase *Checker;
91  CheckerFn(CheckerBase *checker, Func fn) : Fn(fn), Checker(checker) { }
92  RET operator()(P1 p1, P2 p2) const { return Fn(Checker, p1, p2); }
93};
94
95template <typename RET, typename P1>
96class CheckerFn<RET(P1)> {
97  typedef RET (*Func)(void *, P1);
98  Func Fn;
99public:
100  CheckerBase *Checker;
101  CheckerFn(CheckerBase *checker, Func fn) : Fn(fn), Checker(checker) { }
102  RET operator()(P1 p1) const { return Fn(Checker, p1); }
103};
104
105template <typename RET>
106class CheckerFn<RET()> {
107  typedef RET (*Func)(void *);
108  Func Fn;
109public:
110  CheckerBase *Checker;
111  CheckerFn(CheckerBase *checker, Func fn) : Fn(fn), Checker(checker) { }
112  RET operator()() const { return Fn(Checker); }
113};
114
115class CheckerManager {
116  const LangOptions LangOpts;
117
118public:
119  CheckerManager(const LangOptions &langOpts) : LangOpts(langOpts) { }
120  ~CheckerManager();
121
122  bool hasPathSensitiveCheckers() const;
123
124  void finishedCheckerRegistration();
125
126  const LangOptions &getLangOpts() const { return LangOpts; }
127
128  typedef CheckerBase *CheckerRef;
129  typedef const void *CheckerTag;
130  typedef CheckerFn<void ()> CheckerDtor;
131
132//===----------------------------------------------------------------------===//
133// registerChecker
134//===----------------------------------------------------------------------===//
135
136  /// \brief Used to register checkers.
137  ///
138  /// \returns a pointer to the checker object.
139  template <typename CHECKER>
140  CHECKER *registerChecker() {
141    CheckerTag tag = getTag<CHECKER>();
142    CheckerRef &ref = CheckerTags[tag];
143    if (ref)
144      return static_cast<CHECKER *>(ref); // already registered.
145
146    CHECKER *checker = new CHECKER();
147    CheckerDtors.push_back(CheckerDtor(checker, destruct<CHECKER>));
148    CHECKER::_register(checker, *this);
149    ref = checker;
150    return checker;
151  }
152
153//===----------------------------------------------------------------------===//
154// Functions for running checkers for AST traversing..
155//===----------------------------------------------------------------------===//
156
157  /// \brief Run checkers handling Decls.
158  void runCheckersOnASTDecl(const Decl *D, AnalysisManager& mgr,
159                            BugReporter &BR);
160
161  /// \brief Run checkers handling Decls containing a Stmt body.
162  void runCheckersOnASTBody(const Decl *D, AnalysisManager& mgr,
163                            BugReporter &BR);
164
165//===----------------------------------------------------------------------===//
166// Functions for running checkers for path-sensitive checking.
167//===----------------------------------------------------------------------===//
168
169  /// \brief Run checkers for pre-visiting Stmts.
170  ///
171  /// The notification is performed for every explored CFGElement, which does
172  /// not include the control flow statements such as IfStmt.
173  ///
174  /// \sa runCheckersForBranchCondition, runCheckersForPostStmt
175  void runCheckersForPreStmt(ExplodedNodeSet &Dst,
176                             const ExplodedNodeSet &Src,
177                             const Stmt *S,
178                             ExprEngine &Eng) {
179    runCheckersForStmt(/*isPreVisit=*/true, Dst, Src, S, Eng);
180  }
181
182  /// \brief Run checkers for post-visiting Stmts.
183  ///
184  /// The notification is performed for every explored CFGElement, which does
185  /// not include the control flow statements such as IfStmt.
186  ///
187  /// \sa runCheckersForBranchCondition, runCheckersForPreStmt
188  void runCheckersForPostStmt(ExplodedNodeSet &Dst,
189                              const ExplodedNodeSet &Src,
190                              const Stmt *S,
191                              ExprEngine &Eng,
192                              bool wasInlined = false) {
193    runCheckersForStmt(/*isPreVisit=*/false, Dst, Src, S, Eng, wasInlined);
194  }
195
196  /// \brief Run checkers for visiting Stmts.
197  void runCheckersForStmt(bool isPreVisit,
198                          ExplodedNodeSet &Dst, const ExplodedNodeSet &Src,
199                          const Stmt *S, ExprEngine &Eng,
200                          bool wasInlined = false);
201
202  /// \brief Run checkers for pre-visiting obj-c messages.
203  void runCheckersForPreObjCMessage(ExplodedNodeSet &Dst,
204                                    const ExplodedNodeSet &Src,
205                                    const ObjCMethodCall &msg,
206                                    ExprEngine &Eng) {
207    runCheckersForObjCMessage(/*isPreVisit=*/true, Dst, Src, msg, Eng);
208  }
209
210  /// \brief Run checkers for post-visiting obj-c messages.
211  void runCheckersForPostObjCMessage(ExplodedNodeSet &Dst,
212                                     const ExplodedNodeSet &Src,
213                                     const ObjCMethodCall &msg,
214                                     ExprEngine &Eng) {
215    runCheckersForObjCMessage(/*isPreVisit=*/false, Dst, Src, msg, Eng);
216  }
217
218  /// \brief Run checkers for visiting obj-c messages.
219  void runCheckersForObjCMessage(bool isPreVisit,
220                                 ExplodedNodeSet &Dst,
221                                 const ExplodedNodeSet &Src,
222                                 const ObjCMethodCall &msg, ExprEngine &Eng);
223
224  /// \brief Run checkers for load/store of a location.
225  void runCheckersForLocation(ExplodedNodeSet &Dst,
226                              const ExplodedNodeSet &Src,
227                              SVal location,
228                              bool isLoad,
229                              const Stmt *NodeEx,
230                              const Stmt *BoundEx,
231                              ExprEngine &Eng);
232
233  /// \brief Run checkers for binding of a value to a location.
234  void runCheckersForBind(ExplodedNodeSet &Dst,
235                          const ExplodedNodeSet &Src,
236                          SVal location, SVal val,
237                          const Stmt *S, ExprEngine &Eng,
238                          ProgramPoint::Kind PointKind);
239
240  /// \brief Run checkers for end of analysis.
241  void runCheckersForEndAnalysis(ExplodedGraph &G, BugReporter &BR,
242                                 ExprEngine &Eng);
243
244  /// \brief Run checkers for end of path.
245  void runCheckersForEndPath(NodeBuilderContext &BC,
246                             ExplodedNodeSet &Dst,
247                             ExprEngine &Eng);
248
249  /// \brief Run checkers for branch condition.
250  void runCheckersForBranchCondition(const Stmt *condition,
251                                     ExplodedNodeSet &Dst, ExplodedNode *Pred,
252                                     ExprEngine &Eng);
253
254  /// \brief Run checkers for live symbols.
255  ///
256  /// Allows modifying SymbolReaper object. For example, checkers can explicitly
257  /// register symbols of interest as live. These symbols will not be marked
258  /// dead and removed.
259  void runCheckersForLiveSymbols(ProgramStateRef state,
260                                 SymbolReaper &SymReaper);
261
262  /// \brief Run checkers for dead symbols.
263  ///
264  /// Notifies checkers when symbols become dead. For example, this allows
265  /// checkers to aggressively clean up/reduce the checker state and produce
266  /// precise diagnostics.
267  void runCheckersForDeadSymbols(ExplodedNodeSet &Dst,
268                                 const ExplodedNodeSet &Src,
269                                 SymbolReaper &SymReaper, const Stmt *S,
270                                 ExprEngine &Eng,
271                                 ProgramPoint::Kind K);
272
273  /// \brief True if at least one checker wants to check region changes.
274  bool wantsRegionChangeUpdate(ProgramStateRef state);
275
276  /// \brief Run checkers for region changes.
277  ///
278  /// This corresponds to the check::RegionChanges callback.
279  /// \param state The current program state.
280  /// \param invalidated A set of all symbols potentially touched by the change.
281  /// \param ExplicitRegions The regions explicitly requested for invalidation.
282  ///   For example, in the case of a function call, these would be arguments.
283  /// \param Regions The transitive closure of accessible regions,
284  ///   i.e. all regions that may have been touched by this change.
285  /// \param Call The call expression wrapper if the regions are invalidated
286  ///   by a call.
287  ProgramStateRef
288  runCheckersForRegionChanges(ProgramStateRef state,
289                            const StoreManager::InvalidatedSymbols *invalidated,
290                              ArrayRef<const MemRegion *> ExplicitRegions,
291                              ArrayRef<const MemRegion *> Regions,
292                              const CallEvent *Call);
293
294  /// \brief Run checkers for handling assumptions on symbolic values.
295  ProgramStateRef runCheckersForEvalAssume(ProgramStateRef state,
296                                               SVal Cond, bool Assumption);
297
298  /// \brief Run checkers for evaluating a call.
299  void runCheckersForEvalCall(ExplodedNodeSet &Dst,
300                              const ExplodedNodeSet &Src,
301                              const SimpleCall &CE, ExprEngine &Eng);
302
303  /// \brief Run checkers for the entire Translation Unit.
304  void runCheckersOnEndOfTranslationUnit(const TranslationUnitDecl *TU,
305                                         AnalysisManager &mgr,
306                                         BugReporter &BR);
307
308  /// \brief Run checkers for debug-printing a ProgramState.
309  ///
310  /// Unlike most other callbacks, any checker can simply implement the virtual
311  /// method CheckerBase::printState if it has custom data to print.
312  /// \param Out The output stream
313  /// \param State The state being printed
314  /// \param NL The preferred representation of a newline.
315  /// \param Sep The preferred separator between different kinds of data.
316  void runCheckersForPrintState(raw_ostream &Out, ProgramStateRef State,
317                                const char *NL, const char *Sep);
318
319//===----------------------------------------------------------------------===//
320// Internal registration functions for AST traversing.
321//===----------------------------------------------------------------------===//
322
323  // Functions used by the registration mechanism, checkers should not touch
324  // these directly.
325
326  typedef CheckerFn<void (const Decl *, AnalysisManager&, BugReporter &)>
327      CheckDeclFunc;
328
329  typedef bool (*HandlesDeclFunc)(const Decl *D);
330  void _registerForDecl(CheckDeclFunc checkfn, HandlesDeclFunc isForDeclFn);
331
332  void _registerForBody(CheckDeclFunc checkfn);
333
334//===----------------------------------------------------------------------===//
335// Internal registration functions for path-sensitive checking.
336//===----------------------------------------------------------------------===//
337
338  typedef CheckerFn<void (const Stmt *, CheckerContext &)> CheckStmtFunc;
339
340  typedef CheckerFn<void (const ObjCMethodCall &, CheckerContext &)>
341      CheckObjCMessageFunc;
342
343  typedef CheckerFn<void (const SVal &location, bool isLoad,
344                          const Stmt *S,
345                          CheckerContext &)>
346      CheckLocationFunc;
347
348  typedef CheckerFn<void (const SVal &location, const SVal &val,
349                          const Stmt *S, CheckerContext &)>
350      CheckBindFunc;
351
352  typedef CheckerFn<void (ExplodedGraph &, BugReporter &, ExprEngine &)>
353      CheckEndAnalysisFunc;
354
355  typedef CheckerFn<void (CheckerContext &)>
356      CheckEndPathFunc;
357
358  typedef CheckerFn<void (const Stmt *, CheckerContext &)>
359      CheckBranchConditionFunc;
360
361  typedef CheckerFn<void (SymbolReaper &, CheckerContext &)>
362      CheckDeadSymbolsFunc;
363
364  typedef CheckerFn<void (ProgramStateRef,SymbolReaper &)> CheckLiveSymbolsFunc;
365
366  typedef CheckerFn<ProgramStateRef (ProgramStateRef,
367                                const StoreManager::InvalidatedSymbols *symbols,
368                                ArrayRef<const MemRegion *> ExplicitRegions,
369                                ArrayRef<const MemRegion *> Regions,
370                                const CallEvent *Call)>
371      CheckRegionChangesFunc;
372
373  typedef CheckerFn<bool (ProgramStateRef)> WantsRegionChangeUpdateFunc;
374
375  typedef CheckerFn<ProgramStateRef (ProgramStateRef,
376                                          const SVal &cond, bool assumption)>
377      EvalAssumeFunc;
378
379  typedef CheckerFn<bool (const CallExpr *, CheckerContext &)>
380      EvalCallFunc;
381
382  typedef CheckerFn<bool (const CallExpr *, ExprEngine &Eng,
383                                            ExplodedNode *Pred,
384                                            ExplodedNodeSet &Dst)>
385      InlineCallFunc;
386
387  typedef CheckerFn<void (const TranslationUnitDecl *,
388                          AnalysisManager&, BugReporter &)>
389      CheckEndOfTranslationUnit;
390
391  typedef bool (*HandlesStmtFunc)(const Stmt *D);
392  void _registerForPreStmt(CheckStmtFunc checkfn,
393                           HandlesStmtFunc isForStmtFn);
394  void _registerForPostStmt(CheckStmtFunc checkfn,
395                            HandlesStmtFunc isForStmtFn);
396
397  void _registerForPreObjCMessage(CheckObjCMessageFunc checkfn);
398  void _registerForPostObjCMessage(CheckObjCMessageFunc checkfn);
399
400  void _registerForLocation(CheckLocationFunc checkfn);
401
402  void _registerForBind(CheckBindFunc checkfn);
403
404  void _registerForEndAnalysis(CheckEndAnalysisFunc checkfn);
405
406  void _registerForEndPath(CheckEndPathFunc checkfn);
407
408  void _registerForBranchCondition(CheckBranchConditionFunc checkfn);
409
410  void _registerForLiveSymbols(CheckLiveSymbolsFunc checkfn);
411
412  void _registerForDeadSymbols(CheckDeadSymbolsFunc checkfn);
413
414  void _registerForRegionChanges(CheckRegionChangesFunc checkfn,
415                                 WantsRegionChangeUpdateFunc wantUpdateFn);
416
417  void _registerForEvalAssume(EvalAssumeFunc checkfn);
418
419  void _registerForEvalCall(EvalCallFunc checkfn);
420
421  void _registerForInlineCall(InlineCallFunc checkfn);
422
423  void _registerForEndOfTranslationUnit(CheckEndOfTranslationUnit checkfn);
424
425//===----------------------------------------------------------------------===//
426// Internal registration functions for events.
427//===----------------------------------------------------------------------===//
428
429  typedef void *EventTag;
430  typedef CheckerFn<void (const void *event)> CheckEventFunc;
431
432  template <typename EVENT>
433  void _registerListenerForEvent(CheckEventFunc checkfn) {
434    EventInfo &info = Events[getTag<EVENT>()];
435    info.Checkers.push_back(checkfn);
436  }
437
438  template <typename EVENT>
439  void _registerDispatcherForEvent() {
440    EventInfo &info = Events[getTag<EVENT>()];
441    info.HasDispatcher = true;
442  }
443
444  template <typename EVENT>
445  void _dispatchEvent(const EVENT &event) const {
446    EventsTy::const_iterator I = Events.find(getTag<EVENT>());
447    if (I == Events.end())
448      return;
449    const EventInfo &info = I->second;
450    for (unsigned i = 0, e = info.Checkers.size(); i != e; ++i)
451      info.Checkers[i](&event);
452  }
453
454//===----------------------------------------------------------------------===//
455// Implementation details.
456//===----------------------------------------------------------------------===//
457
458private:
459  template <typename CHECKER>
460  static void destruct(void *obj) { delete static_cast<CHECKER *>(obj); }
461
462  template <typename T>
463  static void *getTag() { static int tag; return &tag; }
464
465  llvm::DenseMap<CheckerTag, CheckerRef> CheckerTags;
466
467  std::vector<CheckerDtor> CheckerDtors;
468
469  struct DeclCheckerInfo {
470    CheckDeclFunc CheckFn;
471    HandlesDeclFunc IsForDeclFn;
472  };
473  std::vector<DeclCheckerInfo> DeclCheckers;
474
475  std::vector<CheckDeclFunc> BodyCheckers;
476
477  typedef SmallVector<CheckDeclFunc, 4> CachedDeclCheckers;
478  typedef llvm::DenseMap<unsigned, CachedDeclCheckers> CachedDeclCheckersMapTy;
479  CachedDeclCheckersMapTy CachedDeclCheckersMap;
480
481  struct StmtCheckerInfo {
482    CheckStmtFunc CheckFn;
483    HandlesStmtFunc IsForStmtFn;
484    bool IsPreVisit;
485  };
486  std::vector<StmtCheckerInfo> StmtCheckers;
487
488  struct CachedStmtCheckersKey {
489    unsigned StmtKind;
490    bool IsPreVisit;
491
492    CachedStmtCheckersKey() : StmtKind(0), IsPreVisit(0) { }
493    CachedStmtCheckersKey(unsigned stmtKind, bool isPreVisit)
494      : StmtKind(stmtKind), IsPreVisit(isPreVisit) { }
495
496    static CachedStmtCheckersKey getSentinel() {
497      return CachedStmtCheckersKey(~0U, 0);
498    }
499    unsigned getHashValue() const {
500      llvm::FoldingSetNodeID ID;
501      ID.AddInteger(StmtKind);
502      ID.AddBoolean(IsPreVisit);
503      return ID.ComputeHash();
504    }
505    bool operator==(const CachedStmtCheckersKey &RHS) const {
506      return StmtKind == RHS.StmtKind && IsPreVisit == RHS.IsPreVisit;
507    }
508  };
509  friend struct llvm::DenseMapInfo<CachedStmtCheckersKey>;
510
511  typedef SmallVector<CheckStmtFunc, 4> CachedStmtCheckers;
512  typedef llvm::DenseMap<CachedStmtCheckersKey, CachedStmtCheckers>
513      CachedStmtCheckersMapTy;
514  CachedStmtCheckersMapTy CachedStmtCheckersMap;
515
516  CachedStmtCheckers *getCachedStmtCheckersFor(const Stmt *S, bool isPreVisit);
517
518  std::vector<CheckObjCMessageFunc> PreObjCMessageCheckers;
519  std::vector<CheckObjCMessageFunc> PostObjCMessageCheckers;
520
521  std::vector<CheckLocationFunc> LocationCheckers;
522
523  std::vector<CheckBindFunc> BindCheckers;
524
525  std::vector<CheckEndAnalysisFunc> EndAnalysisCheckers;
526
527  std::vector<CheckEndPathFunc> EndPathCheckers;
528
529  std::vector<CheckBranchConditionFunc> BranchConditionCheckers;
530
531  std::vector<CheckLiveSymbolsFunc> LiveSymbolsCheckers;
532
533  std::vector<CheckDeadSymbolsFunc> DeadSymbolsCheckers;
534
535  struct RegionChangesCheckerInfo {
536    CheckRegionChangesFunc CheckFn;
537    WantsRegionChangeUpdateFunc WantUpdateFn;
538  };
539  std::vector<RegionChangesCheckerInfo> RegionChangesCheckers;
540
541  std::vector<EvalAssumeFunc> EvalAssumeCheckers;
542
543  std::vector<EvalCallFunc> EvalCallCheckers;
544
545  std::vector<InlineCallFunc> InlineCallCheckers;
546
547  std::vector<CheckEndOfTranslationUnit> EndOfTranslationUnitCheckers;
548
549  struct EventInfo {
550    SmallVector<CheckEventFunc, 4> Checkers;
551    bool HasDispatcher;
552    EventInfo() : HasDispatcher(false) { }
553  };
554
555  typedef llvm::DenseMap<EventTag, EventInfo> EventsTy;
556  EventsTy Events;
557};
558
559} // end ento namespace
560
561} // end clang namespace
562
563namespace llvm {
564  /// Define DenseMapInfo so that CachedStmtCheckersKey can be used as key
565  /// in DenseMap and DenseSets.
566  template <>
567  struct DenseMapInfo<clang::ento::CheckerManager::CachedStmtCheckersKey> {
568    static inline clang::ento::CheckerManager::CachedStmtCheckersKey
569        getEmptyKey() {
570      return clang::ento::CheckerManager::CachedStmtCheckersKey();
571    }
572    static inline clang::ento::CheckerManager::CachedStmtCheckersKey
573        getTombstoneKey() {
574      return clang::ento::CheckerManager::CachedStmtCheckersKey::getSentinel();
575    }
576
577    static unsigned
578        getHashValue(clang::ento::CheckerManager::CachedStmtCheckersKey S) {
579      return S.getHashValue();
580    }
581
582    static bool isEqual(clang::ento::CheckerManager::CachedStmtCheckersKey LHS,
583                       clang::ento::CheckerManager::CachedStmtCheckersKey RHS) {
584      return LHS == RHS;
585    }
586  };
587} // end namespace llvm
588
589#endif
590