1 //===-- ExprEngine.h - Path-Sensitive Expression-Level Dataflow ---*- 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 a meta-engine for path-sensitive dataflow analysis that
11 // is built on CoreEngine, but provides the boilerplate to execute transfer
12 // functions and build the ExplodedGraph at the expression level.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_CLANG_STATICANALYZER_CORE_PATHSENSITIVE_EXPRENGINE_H
17 #define LLVM_CLANG_STATICANALYZER_CORE_PATHSENSITIVE_EXPRENGINE_H
19 #include "clang/AST/Expr.h"
20 #include "clang/AST/Type.h"
21 #include "clang/Analysis/DomainSpecific/ObjCNoReturn.h"
22 #include "clang/StaticAnalyzer/Core/BugReporter/BugReporter.h"
23 #include "clang/StaticAnalyzer/Core/PathSensitive/AnalysisManager.h"
24 #include "clang/StaticAnalyzer/Core/PathSensitive/CoreEngine.h"
25 #include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState.h"
26 #include "clang/StaticAnalyzer/Core/PathSensitive/ProgramStateTrait.h"
27 #include "clang/StaticAnalyzer/Core/PathSensitive/SubEngine.h"
31 class AnalysisDeclContextManager;
33 class CXXConstructExpr;
36 class CXXTemporaryObjectExpr;
38 class MaterializeTemporaryExpr;
39 class ObjCAtSynchronizedStmt;
40 class ObjCForCollectionStmt;
44 class AnalysisManager;
46 class CXXConstructorCall;
48 class ExprEngine : public SubEngine {
50 /// The modes of inlining, which override the default analysis-wide settings.
52 /// Follow the default settings for inlining callees.
54 /// Do minimal inlining of callees.
59 AnalysisManager &AMgr;
61 AnalysisDeclContextManager &AnalysisDeclContexts;
65 /// G - the simulation graph.
68 /// StateMgr - Object that manages the data for all created states.
69 ProgramStateManager StateMgr;
71 /// SymMgr - Object that manages the symbol information.
72 SymbolManager& SymMgr;
74 /// svalBuilder - SValBuilder object that creates SVals from expressions.
75 SValBuilder &svalBuilder;
77 unsigned int currStmtIdx;
78 const NodeBuilderContext *currBldrCtx;
80 /// Helper object to determine if an Objective-C message expression
81 /// implicitly never returns.
82 ObjCNoReturn ObjCNoRet;
84 /// Whether or not GC is enabled in this analysis.
87 /// The BugReporter associated with this engine. It is important that
88 /// this object be placed at the very end of member variables so that its
89 /// destructor is called before the rest of the ExprEngine is destroyed.
92 /// The functions which have been analyzed through inlining. This is owned by
93 /// AnalysisConsumer. It can be null.
94 SetOfConstDecls *VisitedCallees;
96 /// The flag, which specifies the mode of inlining for the engine.
97 InliningModes HowToInline;
100 ExprEngine(AnalysisManager &mgr, bool gcEnabled,
101 SetOfConstDecls *VisitedCalleesIn,
102 FunctionSummariesTy *FS,
103 InliningModes HowToInlineIn);
105 ~ExprEngine() override;
107 /// Returns true if there is still simulation state on the worklist.
108 bool ExecuteWorkList(const LocationContext *L, unsigned Steps = 150000) {
109 return Engine.ExecuteWorkList(L, Steps, nullptr);
112 /// Execute the work list with an initial state. Nodes that reaches the exit
113 /// of the function are added into the Dst set, which represent the exit
114 /// state of the function call. Returns true if there is still simulation
115 /// state on the worklist.
116 bool ExecuteWorkListWithInitialState(const LocationContext *L, unsigned Steps,
117 ProgramStateRef InitState,
118 ExplodedNodeSet &Dst) {
119 return Engine.ExecuteWorkListWithInitialState(L, Steps, InitState, Dst);
122 /// getContext - Return the ASTContext associated with this analysis.
123 ASTContext &getContext() const { return AMgr.getASTContext(); }
125 AnalysisManager &getAnalysisManager() override { return AMgr; }
127 CheckerManager &getCheckerManager() const {
128 return *AMgr.getCheckerManager();
131 SValBuilder &getSValBuilder() { return svalBuilder; }
133 BugReporter& getBugReporter() { return BR; }
135 const NodeBuilderContext &getBuilderContext() {
140 bool isObjCGCEnabled() { return ObjCGCEnabled; }
142 const Stmt *getStmt() const;
144 void GenerateAutoTransition(ExplodedNode *N);
145 void enqueueEndOfPath(ExplodedNodeSet &S);
146 void GenerateCallExitNode(ExplodedNode *N);
148 /// Visualize the ExplodedGraph created by executing the simulation.
149 void ViewGraph(bool trim = false);
151 /// Visualize a trimmed ExplodedGraph that only contains paths to the given
153 void ViewGraph(ArrayRef<const ExplodedNode*> Nodes);
155 /// getInitialState - Return the initial state used for the root vertex
156 /// in the ExplodedGraph.
157 ProgramStateRef getInitialState(const LocationContext *InitLoc) override;
159 ExplodedGraph& getGraph() { return G; }
160 const ExplodedGraph& getGraph() const { return G; }
162 /// \brief Run the analyzer's garbage collection - remove dead symbols and
163 /// bindings from the state.
165 /// Checkers can participate in this process with two callbacks:
166 /// \c checkLiveSymbols and \c checkDeadSymbols. See the CheckerDocumentation
167 /// class for more information.
169 /// \param Node The predecessor node, from which the processing should start.
170 /// \param Out The returned set of output nodes.
171 /// \param ReferenceStmt The statement which is about to be processed.
172 /// Everything needed for this statement should be considered live.
173 /// A null statement means that everything in child LocationContexts
175 /// \param LC The location context of the \p ReferenceStmt. A null location
176 /// context means that we have reached the end of analysis and that
177 /// all statements and local variables should be considered dead.
178 /// \param DiagnosticStmt Used as a location for any warnings that should
179 /// occur while removing the dead (e.g. leaks). By default, the
180 /// \p ReferenceStmt is used.
181 /// \param K Denotes whether this is a pre- or post-statement purge. This
182 /// must only be ProgramPoint::PostStmtPurgeDeadSymbolsKind if an
183 /// entire location context is being cleared, in which case the
184 /// \p ReferenceStmt must either be a ReturnStmt or \c NULL. Otherwise,
185 /// it must be ProgramPoint::PreStmtPurgeDeadSymbolsKind (the default)
186 /// and \p ReferenceStmt must be valid (non-null).
187 void removeDead(ExplodedNode *Node, ExplodedNodeSet &Out,
188 const Stmt *ReferenceStmt, const LocationContext *LC,
189 const Stmt *DiagnosticStmt = nullptr,
190 ProgramPoint::Kind K = ProgramPoint::PreStmtPurgeDeadSymbolsKind);
192 /// processCFGElement - Called by CoreEngine. Used to generate new successor
193 /// nodes by processing the 'effects' of a CFG element.
194 void processCFGElement(const CFGElement E, ExplodedNode *Pred,
195 unsigned StmtIdx, NodeBuilderContext *Ctx) override;
197 void ProcessStmt(const CFGStmt S, ExplodedNode *Pred);
199 void ProcessLoopExit(const Stmt* S, ExplodedNode *Pred);
201 void ProcessInitializer(const CFGInitializer I, ExplodedNode *Pred);
203 void ProcessImplicitDtor(const CFGImplicitDtor D, ExplodedNode *Pred);
205 void ProcessNewAllocator(const CXXNewExpr *NE, ExplodedNode *Pred);
207 void ProcessAutomaticObjDtor(const CFGAutomaticObjDtor D,
208 ExplodedNode *Pred, ExplodedNodeSet &Dst);
209 void ProcessDeleteDtor(const CFGDeleteDtor D,
210 ExplodedNode *Pred, ExplodedNodeSet &Dst);
211 void ProcessBaseDtor(const CFGBaseDtor D,
212 ExplodedNode *Pred, ExplodedNodeSet &Dst);
213 void ProcessMemberDtor(const CFGMemberDtor D,
214 ExplodedNode *Pred, ExplodedNodeSet &Dst);
215 void ProcessTemporaryDtor(const CFGTemporaryDtor D,
216 ExplodedNode *Pred, ExplodedNodeSet &Dst);
218 /// Called by CoreEngine when processing the entrance of a CFGBlock.
219 void processCFGBlockEntrance(const BlockEdge &L,
220 NodeBuilderWithSinks &nodeBuilder,
221 ExplodedNode *Pred) override;
223 /// ProcessBranch - Called by CoreEngine. Used to generate successor
224 /// nodes by processing the 'effects' of a branch condition.
225 void processBranch(const Stmt *Condition, const Stmt *Term,
226 NodeBuilderContext& BuilderCtx,
228 ExplodedNodeSet &Dst,
229 const CFGBlock *DstT,
230 const CFGBlock *DstF) override;
232 /// Called by CoreEngine.
233 /// Used to generate successor nodes for temporary destructors depending
234 /// on whether the corresponding constructor was visited.
235 void processCleanupTemporaryBranch(const CXXBindTemporaryExpr *BTE,
236 NodeBuilderContext &BldCtx,
237 ExplodedNode *Pred, ExplodedNodeSet &Dst,
238 const CFGBlock *DstT,
239 const CFGBlock *DstF) override;
241 /// Called by CoreEngine. Used to processing branching behavior
242 /// at static initializers.
243 void processStaticInitializer(const DeclStmt *DS,
244 NodeBuilderContext& BuilderCtx,
246 ExplodedNodeSet &Dst,
247 const CFGBlock *DstT,
248 const CFGBlock *DstF) override;
250 /// processIndirectGoto - Called by CoreEngine. Used to generate successor
251 /// nodes by processing the 'effects' of a computed goto jump.
252 void processIndirectGoto(IndirectGotoNodeBuilder& builder) override;
254 /// ProcessSwitch - Called by CoreEngine. Used to generate successor
255 /// nodes by processing the 'effects' of a switch statement.
256 void processSwitch(SwitchNodeBuilder& builder) override;
258 /// Called by CoreEngine. Used to notify checkers that processing a
259 /// function has begun. Called for both inlined and and top-level functions.
260 void processBeginOfFunction(NodeBuilderContext &BC,
261 ExplodedNode *Pred, ExplodedNodeSet &Dst,
262 const BlockEdge &L) override;
264 /// Called by CoreEngine. Used to notify checkers that processing a
265 /// function has ended. Called for both inlined and and top-level functions.
266 void processEndOfFunction(NodeBuilderContext& BC,
268 const ReturnStmt *RS = nullptr) override;
270 /// Remove dead bindings/symbols before exiting a function.
271 void removeDeadOnEndOfFunction(NodeBuilderContext& BC,
273 ExplodedNodeSet &Dst);
275 /// Generate the entry node of the callee.
276 void processCallEnter(NodeBuilderContext& BC, CallEnter CE,
277 ExplodedNode *Pred) override;
279 /// Generate the sequence of nodes that simulate the call exit and the post
280 /// visit for CallExpr.
281 void processCallExit(ExplodedNode *Pred) override;
283 /// Called by CoreEngine when the analysis worklist has terminated.
284 void processEndWorklist(bool hasWorkRemaining) override;
286 /// evalAssume - Callback function invoked by the ConstraintManager when
287 /// making assumptions about state values.
288 ProgramStateRef processAssume(ProgramStateRef state, SVal cond,
289 bool assumption) override;
291 /// processRegionChanges - Called by ProgramStateManager whenever a change is made
292 /// to the store. Used to update checkers that track region values.
294 processRegionChanges(ProgramStateRef state,
295 const InvalidatedSymbols *invalidated,
296 ArrayRef<const MemRegion *> ExplicitRegions,
297 ArrayRef<const MemRegion *> Regions,
298 const LocationContext *LCtx,
299 const CallEvent *Call) override;
301 /// printState - Called by ProgramStateManager to print checker-specific data.
302 void printState(raw_ostream &Out, ProgramStateRef State,
303 const char *NL, const char *Sep) override;
305 ProgramStateManager& getStateManager() override { return StateMgr; }
307 StoreManager& getStoreManager() { return StateMgr.getStoreManager(); }
309 ConstraintManager& getConstraintManager() {
310 return StateMgr.getConstraintManager();
313 // FIXME: Remove when we migrate over to just using SValBuilder.
314 BasicValueFactory& getBasicVals() {
315 return StateMgr.getBasicVals();
318 // FIXME: Remove when we migrate over to just using ValueManager.
319 SymbolManager& getSymbolManager() { return SymMgr; }
320 const SymbolManager& getSymbolManager() const { return SymMgr; }
322 // Functions for external checking of whether we have unfinished work
323 bool wasBlocksExhausted() const { return Engine.wasBlocksExhausted(); }
324 bool hasEmptyWorkList() const { return !Engine.getWorkList()->hasWork(); }
325 bool hasWorkRemaining() const { return Engine.hasWorkRemaining(); }
327 const CoreEngine &getCoreEngine() const { return Engine; }
330 /// Visit - Transfer function logic for all statements. Dispatches to
331 /// other functions that handle specific kinds of statements.
332 void Visit(const Stmt *S, ExplodedNode *Pred, ExplodedNodeSet &Dst);
334 /// VisitArraySubscriptExpr - Transfer function for array accesses.
335 void VisitArraySubscriptExpr(const ArraySubscriptExpr *Ex,
337 ExplodedNodeSet &Dst);
339 /// VisitGCCAsmStmt - Transfer function logic for inline asm.
340 void VisitGCCAsmStmt(const GCCAsmStmt *A, ExplodedNode *Pred,
341 ExplodedNodeSet &Dst);
343 /// VisitMSAsmStmt - Transfer function logic for MS inline asm.
344 void VisitMSAsmStmt(const MSAsmStmt *A, ExplodedNode *Pred,
345 ExplodedNodeSet &Dst);
347 /// VisitBlockExpr - Transfer function logic for BlockExprs.
348 void VisitBlockExpr(const BlockExpr *BE, ExplodedNode *Pred,
349 ExplodedNodeSet &Dst);
351 /// VisitLambdaExpr - Transfer function logic for LambdaExprs.
352 void VisitLambdaExpr(const LambdaExpr *LE, ExplodedNode *Pred,
353 ExplodedNodeSet &Dst);
355 /// VisitBinaryOperator - Transfer function logic for binary operators.
356 void VisitBinaryOperator(const BinaryOperator* B, ExplodedNode *Pred,
357 ExplodedNodeSet &Dst);
360 /// VisitCall - Transfer function for function calls.
361 void VisitCallExpr(const CallExpr *CE, ExplodedNode *Pred,
362 ExplodedNodeSet &Dst);
364 /// VisitCast - Transfer function logic for all casts (implicit and explicit).
365 void VisitCast(const CastExpr *CastE, const Expr *Ex, ExplodedNode *Pred,
366 ExplodedNodeSet &Dst);
368 /// VisitCompoundLiteralExpr - Transfer function logic for compound literals.
369 void VisitCompoundLiteralExpr(const CompoundLiteralExpr *CL,
370 ExplodedNode *Pred, ExplodedNodeSet &Dst);
372 /// Transfer function logic for DeclRefExprs and BlockDeclRefExprs.
373 void VisitCommonDeclRefExpr(const Expr *DR, const NamedDecl *D,
374 ExplodedNode *Pred, ExplodedNodeSet &Dst);
376 /// VisitDeclStmt - Transfer function logic for DeclStmts.
377 void VisitDeclStmt(const DeclStmt *DS, ExplodedNode *Pred,
378 ExplodedNodeSet &Dst);
380 /// VisitGuardedExpr - Transfer function logic for ?, __builtin_choose
381 void VisitGuardedExpr(const Expr *Ex, const Expr *L, const Expr *R,
382 ExplodedNode *Pred, ExplodedNodeSet &Dst);
384 void VisitInitListExpr(const InitListExpr *E, ExplodedNode *Pred,
385 ExplodedNodeSet &Dst);
387 /// VisitLogicalExpr - Transfer function logic for '&&', '||'
388 void VisitLogicalExpr(const BinaryOperator* B, ExplodedNode *Pred,
389 ExplodedNodeSet &Dst);
391 /// VisitMemberExpr - Transfer function for member expressions.
392 void VisitMemberExpr(const MemberExpr *M, ExplodedNode *Pred,
393 ExplodedNodeSet &Dst);
395 /// VisitMemberExpr - Transfer function for builtin atomic expressions
396 void VisitAtomicExpr(const AtomicExpr *E, ExplodedNode *Pred,
397 ExplodedNodeSet &Dst);
399 /// Transfer function logic for ObjCAtSynchronizedStmts.
400 void VisitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt *S,
401 ExplodedNode *Pred, ExplodedNodeSet &Dst);
403 /// Transfer function logic for computing the lvalue of an Objective-C ivar.
404 void VisitLvalObjCIvarRefExpr(const ObjCIvarRefExpr *DR, ExplodedNode *Pred,
405 ExplodedNodeSet &Dst);
407 /// VisitObjCForCollectionStmt - Transfer function logic for
408 /// ObjCForCollectionStmt.
409 void VisitObjCForCollectionStmt(const ObjCForCollectionStmt *S,
410 ExplodedNode *Pred, ExplodedNodeSet &Dst);
412 void VisitObjCMessage(const ObjCMessageExpr *ME, ExplodedNode *Pred,
413 ExplodedNodeSet &Dst);
415 /// VisitReturnStmt - Transfer function logic for return statements.
416 void VisitReturnStmt(const ReturnStmt *R, ExplodedNode *Pred,
417 ExplodedNodeSet &Dst);
419 /// VisitOffsetOfExpr - Transfer function for offsetof.
420 void VisitOffsetOfExpr(const OffsetOfExpr *Ex, ExplodedNode *Pred,
421 ExplodedNodeSet &Dst);
423 /// VisitUnaryExprOrTypeTraitExpr - Transfer function for sizeof.
424 void VisitUnaryExprOrTypeTraitExpr(const UnaryExprOrTypeTraitExpr *Ex,
425 ExplodedNode *Pred, ExplodedNodeSet &Dst);
427 /// VisitUnaryOperator - Transfer function logic for unary operators.
428 void VisitUnaryOperator(const UnaryOperator* B, ExplodedNode *Pred,
429 ExplodedNodeSet &Dst);
431 /// Handle ++ and -- (both pre- and post-increment).
432 void VisitIncrementDecrementOperator(const UnaryOperator* U,
434 ExplodedNodeSet &Dst);
436 void VisitCXXBindTemporaryExpr(const CXXBindTemporaryExpr *BTE,
437 ExplodedNodeSet &PreVisit,
438 ExplodedNodeSet &Dst);
440 void VisitCXXCatchStmt(const CXXCatchStmt *CS, ExplodedNode *Pred,
441 ExplodedNodeSet &Dst);
443 void VisitCXXThisExpr(const CXXThisExpr *TE, ExplodedNode *Pred,
444 ExplodedNodeSet & Dst);
446 void VisitCXXConstructExpr(const CXXConstructExpr *E, ExplodedNode *Pred,
447 ExplodedNodeSet &Dst);
449 void VisitCXXDestructor(QualType ObjectType, const MemRegion *Dest,
450 const Stmt *S, bool IsBaseDtor,
451 ExplodedNode *Pred, ExplodedNodeSet &Dst);
453 void VisitCXXNewAllocatorCall(const CXXNewExpr *CNE,
455 ExplodedNodeSet &Dst);
457 void VisitCXXNewExpr(const CXXNewExpr *CNE, ExplodedNode *Pred,
458 ExplodedNodeSet &Dst);
460 void VisitCXXDeleteExpr(const CXXDeleteExpr *CDE, ExplodedNode *Pred,
461 ExplodedNodeSet &Dst);
463 /// Create a C++ temporary object for an rvalue.
464 void CreateCXXTemporaryObject(const MaterializeTemporaryExpr *ME,
466 ExplodedNodeSet &Dst);
468 /// evalEagerlyAssumeBinOpBifurcation - Given the nodes in 'Src', eagerly assume symbolic
469 /// expressions of the form 'x != 0' and generate new nodes (stored in Dst)
470 /// with those assumptions.
471 void evalEagerlyAssumeBinOpBifurcation(ExplodedNodeSet &Dst, ExplodedNodeSet &Src,
474 std::pair<const ProgramPointTag *, const ProgramPointTag*>
475 geteagerlyAssumeBinOpBifurcationTags();
477 SVal evalMinus(SVal X) {
478 return X.isValid() ? svalBuilder.evalMinus(X.castAs<NonLoc>()) : X;
481 SVal evalComplement(SVal X) {
482 return X.isValid() ? svalBuilder.evalComplement(X.castAs<NonLoc>()) : X;
485 ProgramStateRef handleLValueBitCast(ProgramStateRef state, const Expr *Ex,
486 const LocationContext *LCtx, QualType T,
487 QualType ExTy, const CastExpr *CastE,
488 StmtNodeBuilder &Bldr,
491 ProgramStateRef handleLVectorSplat(ProgramStateRef state,
492 const LocationContext *LCtx,
493 const CastExpr *CastE,
494 StmtNodeBuilder &Bldr,
497 void handleUOExtension(ExplodedNodeSet::iterator I,
498 const UnaryOperator* U,
499 StmtNodeBuilder &Bldr);
503 SVal evalBinOp(ProgramStateRef state, BinaryOperator::Opcode op,
504 NonLoc L, NonLoc R, QualType T) {
505 return svalBuilder.evalBinOpNN(state, op, L, R, T);
508 SVal evalBinOp(ProgramStateRef state, BinaryOperator::Opcode op,
509 NonLoc L, SVal R, QualType T) {
510 return R.isValid() ? svalBuilder.evalBinOpNN(state, op, L,
511 R.castAs<NonLoc>(), T) : R;
514 SVal evalBinOp(ProgramStateRef ST, BinaryOperator::Opcode Op,
515 SVal LHS, SVal RHS, QualType T) {
516 return svalBuilder.evalBinOp(ST, Op, LHS, RHS, T);
520 /// evalBind - Handle the semantics of binding a value to a specific location.
521 /// This method is used by evalStore, VisitDeclStmt, and others.
522 void evalBind(ExplodedNodeSet &Dst, const Stmt *StoreE, ExplodedNode *Pred,
523 SVal location, SVal Val, bool atDeclInit = false,
524 const ProgramPoint *PP = nullptr);
526 /// Call PointerEscape callback when a value escapes as a result of bind.
527 ProgramStateRef processPointerEscapedOnBind(ProgramStateRef State,
530 const LocationContext *LCtx) override;
531 /// Call PointerEscape callback when a value escapes as a result of
532 /// region invalidation.
533 /// \param[in] ITraits Specifies invalidation traits for regions/symbols.
534 ProgramStateRef notifyCheckersOfPointerEscape(
535 ProgramStateRef State,
536 const InvalidatedSymbols *Invalidated,
537 ArrayRef<const MemRegion *> ExplicitRegions,
538 ArrayRef<const MemRegion *> Regions,
539 const CallEvent *Call,
540 RegionAndSymbolInvalidationTraits &ITraits) override;
543 // FIXME: 'tag' should be removed, and a LocationContext should be used
545 // FIXME: Comment on the meaning of the arguments, when 'St' may not
546 // be the same as Pred->state, and when 'location' may not be the
547 // same as state->getLValue(Ex).
548 /// Simulate a read of the result of Ex.
549 void evalLoad(ExplodedNodeSet &Dst,
550 const Expr *NodeEx, /* Eventually will be a CFGStmt */
551 const Expr *BoundExpr,
555 const ProgramPointTag *tag = nullptr,
556 QualType LoadTy = QualType());
558 // FIXME: 'tag' should be removed, and a LocationContext should be used
560 void evalStore(ExplodedNodeSet &Dst, const Expr *AssignE, const Expr *StoreE,
561 ExplodedNode *Pred, ProgramStateRef St, SVal TargetLV, SVal Val,
562 const ProgramPointTag *tag = nullptr);
564 /// \brief Create a new state in which the call return value is binded to the
565 /// call origin expression.
566 ProgramStateRef bindReturnValue(const CallEvent &Call,
567 const LocationContext *LCtx,
568 ProgramStateRef State);
570 /// Evaluate a call, running pre- and post-call checks and allowing checkers
571 /// to be responsible for handling the evaluation of the call itself.
572 void evalCall(ExplodedNodeSet &Dst, ExplodedNode *Pred,
573 const CallEvent &Call);
575 /// \brief Default implementation of call evaluation.
576 void defaultEvalCall(NodeBuilder &B, ExplodedNode *Pred,
577 const CallEvent &Call);
579 void evalLoadCommon(ExplodedNodeSet &Dst,
580 const Expr *NodeEx, /* Eventually will be a CFGStmt */
585 const ProgramPointTag *tag,
588 // FIXME: 'tag' should be removed, and a LocationContext should be used
590 void evalLocation(ExplodedNodeSet &Dst,
591 const Stmt *NodeEx, /* This will eventually be a CFGStmt */
594 ProgramStateRef St, SVal location,
595 const ProgramPointTag *tag, bool isLoad);
597 /// Count the stack depth and determine if the call is recursive.
598 void examineStackFrames(const Decl *D, const LocationContext *LCtx,
599 bool &IsRecursive, unsigned &StackDepth);
601 /// Checks our policies and decides weither the given call should be inlined.
602 bool shouldInlineCall(const CallEvent &Call, const Decl *D,
603 const ExplodedNode *Pred);
605 bool inlineCall(const CallEvent &Call, const Decl *D, NodeBuilder &Bldr,
606 ExplodedNode *Pred, ProgramStateRef State);
608 /// \brief Conservatively evaluate call by invalidating regions and binding
609 /// a conjured return value.
610 void conservativeEvalCall(const CallEvent &Call, NodeBuilder &Bldr,
611 ExplodedNode *Pred, ProgramStateRef State);
613 /// \brief Either inline or process the call conservatively (or both), based
614 /// on DynamicDispatchBifurcation data.
615 void BifurcateCall(const MemRegion *BifurReg,
616 const CallEvent &Call, const Decl *D, NodeBuilder &Bldr,
619 bool replayWithoutInlining(ExplodedNode *P, const LocationContext *CalleeLC);
621 /// Models a trivial copy or move constructor or trivial assignment operator
622 /// call with a simple bind.
623 void performTrivialCopy(NodeBuilder &Bldr, ExplodedNode *Pred,
624 const CallEvent &Call);
626 /// If the value of the given expression \p InitWithAdjustments is a NonLoc,
627 /// copy it into a new temporary object region, and replace the value of the
628 /// expression with that.
630 /// If \p Result is provided, the new region will be bound to this expression
631 /// instead of \p InitWithAdjustments.
632 ProgramStateRef createTemporaryRegionIfNeeded(ProgramStateRef State,
633 const LocationContext *LC,
634 const Expr *InitWithAdjustments,
635 const Expr *Result = nullptr);
637 /// For a DeclStmt or CXXInitCtorInitializer, walk backward in the current CFG
638 /// block to find the constructor expression that directly constructed into
639 /// the storage for this statement. Returns null if the constructor for this
640 /// statement created a temporary object region rather than directly
641 /// constructing into an existing region.
642 const CXXConstructExpr *findDirectConstructorForCurrentCFGElement();
644 /// For a CXXConstructExpr, walk forward in the current CFG block to find the
645 /// CFGElement for the DeclStmt or CXXInitCtorInitializer for which is
646 /// directly constructed by this constructor. Returns None if the current
647 /// constructor expression did not directly construct into an existing
649 Optional<CFGElement> findElementDirectlyInitializedByCurrentConstructor();
651 /// For a given constructor, look forward in the current CFG block to
652 /// determine the region into which an object will be constructed by \p CE.
653 /// Returns either a field or local variable region if the object will be
654 /// directly constructed in an existing region or a temporary object region
656 const MemRegion *getRegionForConstructedObject(const CXXConstructExpr *CE,
660 /// Traits for storing the call processing policy inside GDM.
661 /// The GDM stores the corresponding CallExpr pointer.
662 // FIXME: This does not use the nice trait macros because it must be accessible
663 // from multiple translation units.
664 struct ReplayWithoutInlining{};
666 struct ProgramStateTrait<ReplayWithoutInlining> :
667 public ProgramStatePartialTrait<const void*> {
668 static void *GDMIndex() { static int index = 0; return &index; }
671 } // end ento namespace
673 } // end clang namespace