1 //== SubEngine.h - Interface of the subengine of CoreEngine --------*- 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 the interface of a subengine of the CoreEngine.
12 //===----------------------------------------------------------------------===//
13 #ifndef LLVM_CLANG_GR_SUBENGINE_H
14 #define LLVM_CLANG_GR_SUBENGINE_H
16 #include "clang/Analysis/ProgramPoint.h"
17 #include "clang/StaticAnalyzer/Core/PathSensitive/SVals.h"
18 #include "clang/StaticAnalyzer/Core/PathSensitive/Store.h"
24 class LocationContext;
29 struct NodeBuilderContext;
30 class AnalysisManager;
31 class ExplodedNodeSet;
34 class ProgramStateManager;
36 class BranchNodeBuilder;
37 class IndirectGotoNodeBuilder;
38 class SwitchNodeBuilder;
39 class EndOfFunctionNodeBuilder;
40 class NodeBuilderWithSinks;
44 virtual void anchor();
46 virtual ~SubEngine() {}
48 virtual ProgramStateRef getInitialState(const LocationContext *InitLoc) = 0;
50 virtual AnalysisManager &getAnalysisManager() = 0;
52 virtual ProgramStateManager &getStateManager() = 0;
54 /// Called by CoreEngine. Used to generate new successor
55 /// nodes by processing the 'effects' of a block-level statement.
56 virtual void processCFGElement(const CFGElement E, ExplodedNode* Pred,
57 unsigned StmtIdx, NodeBuilderContext *Ctx)=0;
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(const BlockEdge &L,
63 NodeBuilderWithSinks &nodeBuilder,
64 ExplodedNode *Pred) = 0;
66 /// Called by CoreEngine. Used to generate successor
67 /// nodes by processing the 'effects' of a branch condition.
68 virtual void processBranch(const Stmt *Condition, const Stmt *Term,
69 NodeBuilderContext& BuilderCtx,
73 const CFGBlock *DstF) = 0;
75 /// Called by CoreEngine. Used to processing branching behavior
76 /// at static initalizers.
77 virtual void processStaticInitializer(const DeclStmt *DS,
78 NodeBuilderContext& BuilderCtx,
82 const CFGBlock *DstF) = 0;
84 /// Called by CoreEngine. Used to generate successor
85 /// nodes by processing the 'effects' of a computed goto jump.
86 virtual void processIndirectGoto(IndirectGotoNodeBuilder& builder) = 0;
88 /// Called by CoreEngine. Used to generate successor
89 /// nodes by processing the 'effects' of a switch statement.
90 virtual void processSwitch(SwitchNodeBuilder& builder) = 0;
92 /// Called by CoreEngine. Used to generate end-of-path
93 /// nodes when the control reaches the end of a function.
94 virtual void processEndOfFunction(NodeBuilderContext& BC,
95 ExplodedNode *Pred) = 0;
97 // Generate the entry node of the callee.
98 virtual void processCallEnter(CallEnter CE, ExplodedNode *Pred) = 0;
100 // Generate the first post callsite node.
101 virtual void processCallExit(ExplodedNode *Pred) = 0;
103 /// Called by ConstraintManager. Used to call checker-specific
104 /// logic for handling assumptions on symbolic values.
105 virtual ProgramStateRef processAssume(ProgramStateRef state,
106 SVal cond, bool assumption) = 0;
108 /// wantsRegionChangeUpdate - Called by ProgramStateManager to determine if a
109 /// region change should trigger a processRegionChanges update.
110 virtual bool wantsRegionChangeUpdate(ProgramStateRef state) = 0;
112 /// processRegionChanges - Called by ProgramStateManager whenever a change is
113 /// made to the store. Used to update checkers that track region values.
114 virtual ProgramStateRef
115 processRegionChanges(ProgramStateRef state,
116 const InvalidatedSymbols *invalidated,
117 ArrayRef<const MemRegion *> ExplicitRegions,
118 ArrayRef<const MemRegion *> Regions,
119 const CallEvent *Call) = 0;
122 inline ProgramStateRef
123 processRegionChange(ProgramStateRef state,
124 const MemRegion* MR) {
125 return processRegionChanges(state, 0, MR, MR, 0);
128 virtual ProgramStateRef
129 processPointerEscapedOnBind(ProgramStateRef State, SVal Loc, SVal Val) = 0;
131 virtual ProgramStateRef
132 notifyCheckersOfPointerEscape(ProgramStateRef State,
133 const InvalidatedSymbols *Invalidated,
134 ArrayRef<const MemRegion *> ExplicitRegions,
135 ArrayRef<const MemRegion *> Regions,
136 const CallEvent *Call,
137 RegionAndSymbolInvalidationTraits &HTraits) = 0;
139 /// printState - Called by ProgramStateManager to print checker-specific data.
140 virtual void printState(raw_ostream &Out, ProgramStateRef State,
141 const char *NL, const char *Sep) = 0;
143 /// Called by CoreEngine when the analysis worklist is either empty or the
144 // maximum number of analysis steps have been reached.
145 virtual void processEndWorklist(bool hasWorkRemaining) = 0;
148 } // end GR namespace
150 } // end clang namespace