SubEngine.h revision 537716ad8dd10f984b6cfe6985afade1185c5e3c 
1//== SubEngine.h - Interface of the subengine of CoreEngine --------*- 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// This file defines the interface of a subengine of the CoreEngine.
11//
12//===----------------------------------------------------------------------===//
13#ifndef LLVM_CLANG_GR_SUBENGINE_H
14#define LLVM_CLANG_GR_SUBENGINE_H
15
16#include "clang/Analysis/ProgramPoint.h"
17#include "clang/StaticAnalyzer/Core/PathSensitive/SVals.h"
18#include "clang/StaticAnalyzer/Core/PathSensitive/Store.h"
19
20namespace clang {
21
22class CFGBlock;
23class CFGElement;
24class LocationContext;
25class Stmt;
26
27namespace ento {
28
29template <typename PP> class GenericNodeBuilder;
30class AnalysisManager;
31class ExplodedNodeSet;
32class ExplodedNode;
33class ProgramState;
34class ProgramStateManager;
35class BlockCounter;
36class StmtNodeBuilder;
37class BranchNodeBuilder;
38class IndirectGotoNodeBuilder;
39class SwitchNodeBuilder;
40class EndOfFunctionNodeBuilder;
41class CallEnterNodeBuilder;
42class CallExitNodeBuilder;
43class MemRegion;
44
45class SubEngine {
46public:
47  virtual ~SubEngine() {}
48
49  virtual const ProgramState *getInitialState(const LocationContext *InitLoc) = 0;
50
51  virtual AnalysisManager &getAnalysisManager() = 0;
52
53  virtual ProgramStateManager &getStateManager() = 0;
54
55  /// Called by CoreEngine. Used to generate new successor
56  /// nodes by processing the 'effects' of a block-level statement.
57  virtual void processCFGElement(const CFGElement E, StmtNodeBuilder& builder)=0;
58
59  /// Called by CoreEngine when it starts processing a CFGBlock.  The
60  /// SubEngine is expected to populate dstNodes with new nodes representing
61  /// updated analysis state, or generate no nodes at all if it doesn't.
62  virtual void processCFGBlockEntrance(ExplodedNodeSet &dstNodes,
63                            GenericNodeBuilder<BlockEntrance> &nodeBuilder) = 0;
64
65  /// Called by CoreEngine.  Used to generate successor
66  ///  nodes by processing the 'effects' of a branch condition.
67  virtual void processBranch(const Stmt *Condition, const Stmt *Term,
68                             BranchNodeBuilder& builder) = 0;
69
70  /// Called by CoreEngine.  Used to generate successor
71  /// nodes by processing the 'effects' of a computed goto jump.
72  virtual void processIndirectGoto(IndirectGotoNodeBuilder& builder) = 0;
73
74  /// Called by CoreEngine.  Used to generate successor
75  /// nodes by processing the 'effects' of a switch statement.
76  virtual void processSwitch(SwitchNodeBuilder& builder) = 0;
77
78  /// Called by CoreEngine.  Used to generate end-of-path
79  /// nodes when the control reaches the end of a function.
80  virtual void processEndOfFunction(EndOfFunctionNodeBuilder& builder) = 0;
81
82  // Generate the entry node of the callee.
83  virtual void processCallEnter(CallEnterNodeBuilder &builder) = 0;
84
85  // Generate the first post callsite node.
86  virtual void processCallExit(CallExitNodeBuilder &builder) = 0;
87
88  /// Called by ConstraintManager. Used to call checker-specific
89  /// logic for handling assumptions on symbolic values.
90  virtual const ProgramState *processAssume(const ProgramState *state,
91                                       SVal cond, bool assumption) = 0;
92
93  /// wantsRegionChangeUpdate - Called by ProgramStateManager to determine if a
94  ///  region change should trigger a processRegionChanges update.
95  virtual bool wantsRegionChangeUpdate(const ProgramState *state) = 0;
96
97  /// processRegionChanges - Called by ProgramStateManager whenever a change is made
98  ///  to the store. Used to update checkers that track region values.
99  virtual const ProgramState *
100  processRegionChanges(const ProgramState *state,
101                       const StoreManager::InvalidatedSymbols *invalidated,
102                       ArrayRef<const MemRegion *> ExplicitRegions,
103                       ArrayRef<const MemRegion *> Regions) = 0;
104
105
106  inline const ProgramState *
107  processRegionChange(const ProgramState *state,
108                      const MemRegion* MR) {
109    return processRegionChanges(state, 0, MR, MR);
110  }
111
112  /// Called by CoreEngine when the analysis worklist is either empty or the
113  //  maximum number of analysis steps have been reached.
114  virtual void processEndWorklist(bool hasWorkRemaining) = 0;
115};
116
117} // end GR namespace
118
119} // end clang namespace
120
121#endif
122