clang  14.0.0git
CoreEngine.h
Go to the documentation of this file.
1 //===- CoreEngine.h - Path-Sensitive Dataflow Engine ------------*- 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 a generic engine for intraprocedural, path-sensitive,
10 // dataflow analysis via graph reachability.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_CLANG_STATICANALYZER_CORE_PATHSENSITIVE_COREENGINE_H
15 #define LLVM_CLANG_STATICANALYZER_CORE_PATHSENSITIVE_COREENGINE_H
16 
17 #include "clang/AST/Stmt.h"
19 #include "clang/Analysis/CFG.h"
21 #include "clang/Basic/LLVM.h"
27 #include "llvm/ADT/SmallVector.h"
28 #include "llvm/Support/Casting.h"
29 #include <cassert>
30 #include <memory>
31 #include <utility>
32 #include <vector>
33 
34 namespace clang {
35 
36 class AnalyzerOptions;
37 class CXXBindTemporaryExpr;
38 class Expr;
39 class LabelDecl;
40 
41 namespace ento {
42 
43 class FunctionSummariesTy;
44 class ExprEngine;
45 
46 //===----------------------------------------------------------------------===//
47 /// CoreEngine - Implements the core logic of the graph-reachability
48 /// analysis. It traverses the CFG and generates the ExplodedGraph.
49 /// Program "states" are treated as opaque void pointers.
50 /// The template class CoreEngine (which subclasses CoreEngine)
51 /// provides the matching component to the engine that knows the actual types
52 /// for states. Note that this engine only dispatches to transfer functions
53 /// at the statement and block-level. The analyses themselves must implement
54 /// any transfer function logic and the sub-expression level (if any).
55 class CoreEngine {
56  friend class CommonNodeBuilder;
58  friend class ExprEngine;
60  friend class NodeBuilder;
61  friend struct NodeBuilderContext;
62  friend class SwitchNodeBuilder;
63 
64 public:
65  using BlocksExhausted =
66  std::vector<std::pair<BlockEdge, const ExplodedNode *>>;
67 
68  using BlocksAborted =
69  std::vector<std::pair<const CFGBlock *, const ExplodedNode *>>;
70 
71 private:
72  ExprEngine &ExprEng;
73 
74  /// G - The simulation graph. Each node is a (location,state) pair.
75  mutable ExplodedGraph G;
76 
77  /// WList - A set of queued nodes that need to be processed by the
78  /// worklist algorithm. It is up to the implementation of WList to decide
79  /// the order that nodes are processed.
80  std::unique_ptr<WorkList> WList;
81 
82  /// BCounterFactory - A factory object for created BlockCounter objects.
83  /// These are used to record for key nodes in the ExplodedGraph the
84  /// number of times different CFGBlocks have been visited along a path.
85  BlockCounter::Factory BCounterFactory;
86 
87  /// The locations where we stopped doing work because we visited a location
88  /// too many times.
89  BlocksExhausted blocksExhausted;
90 
91  /// The locations where we stopped because the engine aborted analysis,
92  /// usually because it could not reason about something.
93  BlocksAborted blocksAborted;
94 
95  /// The information about functions shared by the whole translation unit.
96  /// (This data is owned by AnalysisConsumer.)
97  FunctionSummariesTy *FunctionSummaries;
98 
99  /// Add path tags with some useful data along the path when we see that
100  /// something interesting is happening. This field is the allocator for such
101  /// tags.
102  DataTag::Factory DataTags;
103 
104  void generateNode(const ProgramPoint &Loc,
106  ExplodedNode *Pred);
107 
108  void HandleBlockEdge(const BlockEdge &E, ExplodedNode *Pred);
109  void HandleBlockEntrance(const BlockEntrance &E, ExplodedNode *Pred);
110  void HandleBlockExit(const CFGBlock *B, ExplodedNode *Pred);
111 
112  void HandleCallEnter(const CallEnter &CE, ExplodedNode *Pred);
113 
114  void HandlePostStmt(const CFGBlock *B, unsigned StmtIdx, ExplodedNode *Pred);
115 
116  void HandleBranch(const Stmt *Cond, const Stmt *Term, const CFGBlock *B,
117  ExplodedNode *Pred);
118  void HandleCleanupTemporaryBranch(const CXXBindTemporaryExpr *BTE,
119  const CFGBlock *B, ExplodedNode *Pred);
120 
121  /// Handle conditional logic for running static initializers.
122  void HandleStaticInit(const DeclStmt *DS, const CFGBlock *B,
123  ExplodedNode *Pred);
124 
125  void HandleVirtualBaseBranch(const CFGBlock *B, ExplodedNode *Pred);
126 
127 private:
128  ExplodedNode *generateCallExitBeginNode(ExplodedNode *N,
129  const ReturnStmt *RS);
130 
131 public:
132  /// Construct a CoreEngine object to analyze the provided CFG.
133  CoreEngine(ExprEngine &exprengine,
135  AnalyzerOptions &Opts);
136 
137  CoreEngine(const CoreEngine &) = delete;
138  CoreEngine &operator=(const CoreEngine &) = delete;
139 
140  /// getGraph - Returns the exploded graph.
141  ExplodedGraph &getGraph() { return G; }
142 
143  /// ExecuteWorkList - Run the worklist algorithm for a maximum number of
144  /// steps. Returns true if there is still simulation state on the worklist.
145  bool ExecuteWorkList(const LocationContext *L, unsigned Steps,
146  ProgramStateRef InitState);
147 
148  /// Returns true if there is still simulation state on the worklist.
150  unsigned Steps,
151  ProgramStateRef InitState,
152  ExplodedNodeSet &Dst);
153 
154  /// Dispatch the work list item based on the given location information.
155  /// Use Pred parameter as the predecessor state.
157  const WorkListUnit& WU);
158 
159  // Functions for external checking of whether we have unfinished work
160  bool wasBlockAborted() const { return !blocksAborted.empty(); }
161  bool wasBlocksExhausted() const { return !blocksExhausted.empty(); }
162  bool hasWorkRemaining() const { return wasBlocksExhausted() ||
163  WList->hasWork() ||
164  wasBlockAborted(); }
165 
166  /// Inform the CoreEngine that a basic block was aborted because
167  /// it could not be completely analyzed.
168  void addAbortedBlock(const ExplodedNode *node, const CFGBlock *block) {
169  blocksAborted.push_back(std::make_pair(block, node));
170  }
171 
172  WorkList *getWorkList() const { return WList.get(); }
173 
174  BlocksExhausted::const_iterator blocks_exhausted_begin() const {
175  return blocksExhausted.begin();
176  }
177 
178  BlocksExhausted::const_iterator blocks_exhausted_end() const {
179  return blocksExhausted.end();
180  }
181 
182  BlocksAborted::const_iterator blocks_aborted_begin() const {
183  return blocksAborted.begin();
184  }
185 
186  BlocksAborted::const_iterator blocks_aborted_end() const {
187  return blocksAborted.end();
188  }
189 
190  /// Enqueue the given set of nodes onto the work list.
191  void enqueue(ExplodedNodeSet &Set);
192 
193  /// Enqueue nodes that were created as a result of processing
194  /// a statement onto the work list.
195  void enqueue(ExplodedNodeSet &Set, const CFGBlock *Block, unsigned Idx);
196 
197  /// enqueue the nodes corresponding to the end of function onto the
198  /// end of path / work list.
199  void enqueueEndOfFunction(ExplodedNodeSet &Set, const ReturnStmt *RS);
200 
201  /// Enqueue a single node created as a result of statement processing.
202  void enqueueStmtNode(ExplodedNode *N, const CFGBlock *Block, unsigned Idx);
203 
204  DataTag::Factory &getDataTags() { return DataTags; }
205 };
206 
207 // TODO: Turn into a class.
209  const CoreEngine &Eng;
210  const CFGBlock *Block;
212 
214  : Eng(E), Block(B), LC(N->getLocationContext()) { assert(B); }
215 
216  /// Return the CFGBlock associated with this builder.
217  const CFGBlock *getBlock() const { return Block; }
218 
219  /// Returns the number of times the current basic block has been
220  /// visited on the exploded graph path.
221  unsigned blockCount() const {
222  return Eng.WList->getBlockCounter().getNumVisited(
223  LC->getStackFrame(),
224  Block->getBlockID());
225  }
226 };
227 
228 /// \class NodeBuilder
229 /// This is the simplest builder which generates nodes in the
230 /// ExplodedGraph.
231 ///
232 /// The main benefit of the builder is that it automatically tracks the
233 /// frontier nodes (or destination set). This is the set of nodes which should
234 /// be propagated to the next step / builder. They are the nodes which have been
235 /// added to the builder (either as the input node set or as the newly
236 /// constructed nodes) but did not have any outgoing transitions added.
237 class NodeBuilder {
238  virtual void anchor();
239 
240 protected:
242 
243  /// Specifies if the builder results have been finalized. For example, if it
244  /// is set to false, autotransitions are yet to be generated.
245  bool Finalized;
246 
247  bool HasGeneratedNodes = false;
248 
249  /// The frontier set - a set of nodes which need to be propagated after
250  /// the builder dies.
252 
253  /// Checks if the results are ready.
254  virtual bool checkResults() {
255  return Finalized;
256  }
257 
259  for (const auto I : Frontier)
260  if (I->isSink())
261  return false;
262  return true;
263  }
264 
265  /// Allow subclasses to finalize results before result_begin() is executed.
266  virtual void finalizeResults() {}
267 
270  ExplodedNode *Pred,
271  bool MarkAsSink = false);
272 
273 public:
275  const NodeBuilderContext &Ctx, bool F = true)
276  : C(Ctx), Finalized(F), Frontier(DstSet) {
277  Frontier.Add(SrcNode);
278  }
279 
281  const NodeBuilderContext &Ctx, bool F = true)
282  : C(Ctx), Finalized(F), Frontier(DstSet) {
283  Frontier.insert(SrcSet);
284  assert(hasNoSinksInFrontier());
285  }
286 
287  virtual ~NodeBuilder() = default;
288 
289  /// Generates a node in the ExplodedGraph.
292  ExplodedNode *Pred) {
293  return generateNodeImpl(PP, State, Pred, false);
294  }
295 
296  /// Generates a sink in the ExplodedGraph.
297  ///
298  /// When a node is marked as sink, the exploration from the node is stopped -
299  /// the node becomes the last node on the path and certain kinds of bugs are
300  /// suppressed.
303  ExplodedNode *Pred) {
304  return generateNodeImpl(PP, State, Pred, true);
305  }
306 
308  finalizeResults();
309  assert(checkResults());
310  return Frontier;
311  }
312 
314 
315  /// Iterators through the results frontier.
317  finalizeResults();
318  assert(checkResults());
319  return Frontier.begin();
320  }
321 
323  finalizeResults();
324  return Frontier.end();
325  }
326 
327  const NodeBuilderContext &getContext() { return C; }
329 
330  void takeNodes(const ExplodedNodeSet &S) {
331  for (const auto I : S)
332  Frontier.erase(I);
333  }
334 
336  void addNodes(const ExplodedNodeSet &S) { Frontier.insert(S); }
338 };
339 
340 /// \class NodeBuilderWithSinks
341 /// This node builder keeps track of the generated sink nodes.
343  void anchor() override;
344 
345 protected:
348 
349 public:
351  const NodeBuilderContext &Ctx, ProgramPoint &L)
352  : NodeBuilder(Pred, DstSet, Ctx), Location(L) {}
353 
355  ExplodedNode *Pred,
356  const ProgramPointTag *Tag = nullptr) {
357  const ProgramPoint &LocalLoc = (Tag ? Location.withTag(Tag) : Location);
358  return NodeBuilder::generateNode(LocalLoc, State, Pred);
359  }
360 
362  const ProgramPointTag *Tag = nullptr) {
363  const ProgramPoint &LocalLoc = (Tag ? Location.withTag(Tag) : Location);
364  ExplodedNode *N = NodeBuilder::generateSink(LocalLoc, State, Pred);
365  if (N && N->isSink())
366  sinksGenerated.push_back(N);
367  return N;
368  }
369 
371  return sinksGenerated;
372  }
373 };
374 
375 /// \class StmtNodeBuilder
376 /// This builder class is useful for generating nodes that resulted from
377 /// visiting a statement. The main difference from its parent NodeBuilder is
378 /// that it creates a statement specific ProgramPoint.
380  NodeBuilder *EnclosingBldr;
381 
382 public:
383  /// Constructs a StmtNodeBuilder. If the builder is going to process
384  /// nodes currently owned by another builder(with larger scope), use
385  /// Enclosing builder to transfer ownership.
387  const NodeBuilderContext &Ctx,
388  NodeBuilder *Enclosing = nullptr)
389  : NodeBuilder(SrcNode, DstSet, Ctx), EnclosingBldr(Enclosing) {
390  if (EnclosingBldr)
391  EnclosingBldr->takeNodes(SrcNode);
392  }
393 
395  const NodeBuilderContext &Ctx,
396  NodeBuilder *Enclosing = nullptr)
397  : NodeBuilder(SrcSet, DstSet, Ctx), EnclosingBldr(Enclosing) {
398  if (EnclosingBldr)
399  for (const auto I : SrcSet)
400  EnclosingBldr->takeNodes(I);
401  }
402 
403  ~StmtNodeBuilder() override;
404 
407 
409  ExplodedNode *Pred,
410  ProgramStateRef St,
411  const ProgramPointTag *tag = nullptr,
414  Pred->getLocationContext(), tag);
415  return NodeBuilder::generateNode(L, St, Pred);
416  }
417 
419  ExplodedNode *Pred,
420  ProgramStateRef St,
421  const ProgramPointTag *tag = nullptr,
424  Pred->getLocationContext(), tag);
425  return NodeBuilder::generateSink(L, St, Pred);
426  }
427 };
428 
429 /// BranchNodeBuilder is responsible for constructing the nodes
430 /// corresponding to the two branches of the if statement - true and false.
432  const CFGBlock *DstT;
433  const CFGBlock *DstF;
434 
435  bool InFeasibleTrue;
436  bool InFeasibleFalse;
437 
438  void anchor() override;
439 
440 public:
442  const NodeBuilderContext &C,
443  const CFGBlock *dstT, const CFGBlock *dstF)
444  : NodeBuilder(SrcNode, DstSet, C), DstT(dstT), DstF(dstF),
445  InFeasibleTrue(!DstT), InFeasibleFalse(!DstF) {
446  // The branch node builder does not generate autotransitions.
447  // If there are no successors it means that both branches are infeasible.
448  takeNodes(SrcNode);
449  }
450 
452  const NodeBuilderContext &C,
453  const CFGBlock *dstT, const CFGBlock *dstF)
454  : NodeBuilder(SrcSet, DstSet, C), DstT(dstT), DstF(dstF),
455  InFeasibleTrue(!DstT), InFeasibleFalse(!DstF) {
456  takeNodes(SrcSet);
457  }
458 
460  ExplodedNode *Pred);
461 
462  const CFGBlock *getTargetBlock(bool branch) const {
463  return branch ? DstT : DstF;
464  }
465 
466  void markInfeasible(bool branch) {
467  if (branch)
468  InFeasibleTrue = true;
469  else
470  InFeasibleFalse = true;
471  }
472 
473  bool isFeasible(bool branch) {
474  return branch ? !InFeasibleTrue : !InFeasibleFalse;
475  }
476 };
477 
479  CoreEngine& Eng;
480  const CFGBlock *Src;
481  const CFGBlock &DispatchBlock;
482  const Expr *E;
483  ExplodedNode *Pred;
484 
485 public:
487  const Expr *e, const CFGBlock *dispatch, CoreEngine* eng)
488  : Eng(*eng), Src(src), DispatchBlock(*dispatch), E(e), Pred(pred) {}
489 
490  class iterator {
492 
494 
496 
497  public:
498  iterator &operator++() { ++I; return *this; }
499  bool operator!=(const iterator &X) const { return I != X.I; }
500 
501  const LabelDecl *getLabel() const {
502  return cast<LabelStmt>((*I)->getLabel())->getDecl();
503  }
504 
505  const CFGBlock *getBlock() const {
506  return *I;
507  }
508  };
509 
510  iterator begin() { return iterator(DispatchBlock.succ_begin()); }
511  iterator end() { return iterator(DispatchBlock.succ_end()); }
512 
513  ExplodedNode *generateNode(const iterator &I,
515  bool isSink = false);
516 
517  const Expr *getTarget() const { return E; }
518 
519  ProgramStateRef getState() const { return Pred->State; }
520 
522  return Pred->getLocationContext();
523  }
524 };
525 
527  CoreEngine& Eng;
528  const CFGBlock *Src;
529  const Expr *Condition;
530  ExplodedNode *Pred;
531 
532 public:
534  const Expr *condition, CoreEngine* eng)
535  : Eng(*eng), Src(src), Condition(condition), Pred(pred) {}
536 
537  class iterator {
538  friend class SwitchNodeBuilder;
539 
541 
543 
544  public:
545  iterator &operator++() { ++I; return *this; }
546  bool operator!=(const iterator &X) const { return I != X.I; }
547  bool operator==(const iterator &X) const { return I == X.I; }
548 
549  const CaseStmt *getCase() const {
550  return cast<CaseStmt>((*I)->getLabel());
551  }
552 
553  const CFGBlock *getBlock() const {
554  return *I;
555  }
556  };
557 
558  iterator begin() { return iterator(Src->succ_rbegin()+1); }
559  iterator end() { return iterator(Src->succ_rend()); }
560 
561  const SwitchStmt *getSwitch() const {
562  return cast<SwitchStmt>(Src->getTerminator());
563  }
564 
565  ExplodedNode *generateCaseStmtNode(const iterator &I,
567 
569  bool isSink = false);
570 
571  const Expr *getCondition() const { return Condition; }
572 
573  ProgramStateRef getState() const { return Pred->State; }
574 
576  return Pred->getLocationContext();
577  }
578 };
579 
580 } // namespace ento
581 
582 } // namespace clang
583 
584 #endif // LLVM_CLANG_STATICANALYZER_CORE_PATHSENSITIVE_COREENGINE_H
clang::ento::CoreEngine::BlocksAborted
std::vector< std::pair< const CFGBlock *, const ExplodedNode * > > BlocksAborted
Definition: CoreEngine.h:69
clang::CFGBlock::getTerminator
CFGTerminator getTerminator() const
Definition: CFG.h:1048
clang::ento::StmtNodeBuilder::generateSink
ExplodedNode * generateSink(const Stmt *S, ExplodedNode *Pred, ProgramStateRef St, const ProgramPointTag *tag=nullptr, ProgramPoint::Kind K=ProgramPoint::PostStmtKind)
Definition: CoreEngine.h:418
clang::ento::SwitchNodeBuilder::SwitchNodeBuilder
SwitchNodeBuilder(ExplodedNode *pred, const CFGBlock *src, const Expr *condition, CoreEngine *eng)
Definition: CoreEngine.h:533
clang::ento::NodeBuilderWithSinks::NodeBuilderWithSinks
NodeBuilderWithSinks(ExplodedNode *Pred, ExplodedNodeSet &DstSet, const NodeBuilderContext &Ctx, ProgramPoint &L)
Definition: CoreEngine.h:350
clang::ento::CoreEngine::BlocksExhausted
std::vector< std::pair< BlockEdge, const ExplodedNode * > > BlocksExhausted
Definition: CoreEngine.h:66
clang::CaseStmt
CaseStmt - Represent a case statement.
Definition: Stmt.h:1567
clang::ProgramPoint::withTag
ProgramPoint withTag(const ProgramPointTag *tag) const
Create a new ProgramPoint object that is the same as the original except for using the specified tag ...
Definition: ProgramPoint.h:132
clang::ento::ExplodedNode::getLocationContext
const LocationContext * getLocationContext() const
Definition: ExplodedGraph.h:146
clang::ento::SwitchNodeBuilder::getLocationContext
const LocationContext * getLocationContext() const
Definition: CoreEngine.h:575
clang::ento::BranchNodeBuilder::getTargetBlock
const CFGBlock * getTargetBlock(bool branch) const
Definition: CoreEngine.h:462
clang::LocationContext
It wraps the AnalysisDeclContext to represent both the call stack with the help of StackFrameContext ...
Definition: AnalysisDeclContext.h:215
clang::LocationContext::getStackFrame
const StackFrameContext * getStackFrame() const
Definition: AnalysisDeclContext.cpp:463
clang::SwitchStmt
SwitchStmt - This represents a 'switch' stmt.
Definition: Stmt.h:2150
clang::CFGBlock::succ_rbegin
succ_reverse_iterator succ_rbegin()
Definition: CFG.h:960
clang::ento::WorkList
Definition: WorkList.h:60
clang::ento::ExplodedNodeSet::iterator
ImplTy::iterator iterator
Definition: ExplodedGraph.h:479
clang::ProgramPointTag
ProgramPoints can be "tagged" as representing points specific to a given analysis entity.
Definition: ProgramPoint.h:39
clang::ento::SwitchNodeBuilder::getCondition
const Expr * getCondition() const
Definition: CoreEngine.h:571
clang::CFGBlock::succ_begin
succ_iterator succ_begin()
Definition: CFG.h:955
clang::ento::SwitchNodeBuilder::iterator
Definition: CoreEngine.h:537
AnalysisDeclContext.h
llvm::SmallVector
Definition: LLVM.h:38
clang::ento::NodeBuilder::iterator
ExplodedNodeSet::iterator iterator
Definition: CoreEngine.h:313
clang::ento::IndirectGotoNodeBuilder::getTarget
const Expr * getTarget() const
Definition: CoreEngine.h:517
clang::ento::IndirectGotoNodeBuilder::begin
iterator begin()
Definition: CoreEngine.h:510
clang::CFGBlock::getBlockID
unsigned getBlockID() const
Definition: CFG.h:1074
clang::ento::IndirectGotoNodeBuilder::iterator::operator!=
bool operator!=(const iterator &X) const
Definition: CoreEngine.h:499
clang::ento::ExplodedNode
Definition: ExplodedGraph.h:65
clang::ento::CoreEngine::EndOfFunctionNodeBuilder
friend class EndOfFunctionNodeBuilder
Definition: CoreEngine.h:57
clang::ento::NodeBuilderContext::LC
const LocationContext * LC
Definition: CoreEngine.h:211
ProgramState_Fwd.h
clang::ento::CoreEngine::CoreEngine
CoreEngine(ExprEngine &exprengine, FunctionSummariesTy *FS, AnalyzerOptions &Opts)
Construct a CoreEngine object to analyze the provided CFG.
Definition: CoreEngine.cpp:73
clang::ento::StmtNodeBuilder::StmtNodeBuilder
StmtNodeBuilder(ExplodedNode *SrcNode, ExplodedNodeSet &DstSet, const NodeBuilderContext &Ctx, NodeBuilder *Enclosing=nullptr)
Constructs a StmtNodeBuilder.
Definition: CoreEngine.h:386
clang::ento::ExplodedNodeSet::Add
void Add(ExplodedNode *N)
Definition: ExplodedGraph.h:475
clang::ento::WorkListUnit
Definition: WorkList.h:27
clang::ento::BranchNodeBuilder
BranchNodeBuilder is responsible for constructing the nodes corresponding to the two branches of the ...
Definition: CoreEngine.h:431
clang::tooling::X
static ToolExecutorPluginRegistry::Add< AllTUsToolExecutorPlugin > X("all-TUs", "Runs FrontendActions on all TUs in the compilation database. " "Tool results are stored in memory.")
clang::ento::StmtNodeBuilder
Definition: CoreEngine.h:379
clang::ento::CoreEngine::blocks_exhausted_end
BlocksExhausted::const_iterator blocks_exhausted_end() const
Definition: CoreEngine.h:178
clang::ento::StmtNodeBuilder::StmtNodeBuilder
StmtNodeBuilder(ExplodedNodeSet &SrcSet, ExplodedNodeSet &DstSet, const NodeBuilderContext &Ctx, NodeBuilder *Enclosing=nullptr)
Definition: CoreEngine.h:394
clang::CFGBlock::const_succ_iterator
AdjacentBlocks::const_iterator const_succ_iterator
Definition: CFG.h:931
clang::ento::NodeBuilderContext::Block
const CFGBlock * Block
Definition: CoreEngine.h:210
clang::ento::NodeBuilderContext::NodeBuilderContext
NodeBuilderContext(const CoreEngine &E, const CFGBlock *B, ExplodedNode *N)
Definition: CoreEngine.h:213
clang::ento::IndirectGotoNodeBuilder::IndirectGotoNodeBuilder
IndirectGotoNodeBuilder(ExplodedNode *pred, const CFGBlock *src, const Expr *e, const CFGBlock *dispatch, CoreEngine *eng)
Definition: CoreEngine.h:486
clang::ento::CoreEngine::CommonNodeBuilder
friend class CommonNodeBuilder
Definition: CoreEngine.h:56
BlockCounter.h
clang::ento::NodeBuilder::Frontier
ExplodedNodeSet & Frontier
The frontier set - a set of nodes which need to be propagated after the builder dies.
Definition: CoreEngine.h:251
clang::ento::CoreEngine::addAbortedBlock
void addAbortedBlock(const ExplodedNode *node, const CFGBlock *block)
Inform the CoreEngine that a basic block was aborted because it could not be completely analyzed.
Definition: CoreEngine.h:168
clang::CFGBlock
Represents a single basic block in a source-level CFG.
Definition: CFG.h:576
clang::ento::SwitchNodeBuilder::getSwitch
const SwitchStmt * getSwitch() const
Definition: CoreEngine.h:561
clang::ento::NodeBuilder::takeNodes
void takeNodes(const ExplodedNodeSet &S)
Definition: CoreEngine.h:330
clang::ento::NodeBuilder::Finalized
bool Finalized
Specifies if the builder results have been finalized.
Definition: CoreEngine.h:245
clang::ento::NodeBuilder::end
iterator end()
Definition: CoreEngine.h:322
clang::ento::CoreEngine::blocks_exhausted_begin
BlocksExhausted::const_iterator blocks_exhausted_begin() const
Definition: CoreEngine.h:174
clang::ento::SwitchNodeBuilder::iterator::operator!=
bool operator!=(const iterator &X) const
Definition: CoreEngine.h:546
ProgramPoint.h
clang::ento::CoreEngine::dispatchWorkItem
void dispatchWorkItem(ExplodedNode *Pred, ProgramPoint Loc, const WorkListUnit &WU)
Dispatch the work list item based on the given location information.
Definition: CoreEngine.cpp:153
clang::ento::NodeBuilder::finalizeResults
virtual void finalizeResults()
Allow subclasses to finalize results before result_begin() is executed.
Definition: CoreEngine.h:266
clang::ento::BranchNodeBuilder::generateNode
ExplodedNode * generateNode(ProgramStateRef State, bool branch, ExplodedNode *Pred)
Definition: CoreEngine.cpp:635
clang::ento::NodeBuilder
Definition: CoreEngine.h:237
clang::CXXBindTemporaryExpr
Represents binding an expression to a temporary.
Definition: ExprCXX.h:1412
clang::ento::NodeBuilder::generateSink
ExplodedNode * generateSink(const ProgramPoint &PP, ProgramStateRef State, ExplodedNode *Pred)
Generates a sink in the ExplodedGraph.
Definition: CoreEngine.h:301
clang::ento::BranchNodeBuilder::BranchNodeBuilder
BranchNodeBuilder(const ExplodedNodeSet &SrcSet, ExplodedNodeSet &DstSet, const NodeBuilderContext &C, const CFGBlock *dstT, const CFGBlock *dstF)
Definition: CoreEngine.h:451
BugReporter.h
clang::ento::CoreEngine::ExecuteWorkListWithInitialState
bool ExecuteWorkListWithInitialState(const LocationContext *L, unsigned Steps, ProgramStateRef InitState, ExplodedNodeSet &Dst)
Returns true if there is still simulation state on the worklist.
Definition: CoreEngine.cpp:196
clang::ento::ExplodedNode::isSink
bool isSink() const
Definition: ExplodedGraph.h:204
clang::ento::SwitchNodeBuilder::getState
ProgramStateRef getState() const
Definition: CoreEngine.h:573
clang::ento::NodeBuilderWithSinks::sinksGenerated
SmallVector< ExplodedNode *, 2 > sinksGenerated
Definition: CoreEngine.h:346
clang::ento::IndirectGotoNodeBuilder::end
iterator end()
Definition: CoreEngine.h:511
clang::ento::CoreEngine::enqueueStmtNode
void enqueueStmtNode(ExplodedNode *N, const CFGBlock *Block, unsigned Idx)
Enqueue a single node created as a result of statement processing.
Definition: CoreEngine.cpp:514
clang::LabelDecl
Represents the declaration of a label.
Definition: Decl.h:496
clang::ento::NodeBuilder::getResults
const ExplodedNodeSet & getResults()
Definition: CoreEngine.h:307
clang::ento::ExplodedNodeSet::end
iterator end()
Definition: ExplodedGraph.h:497
clang::ento::NodeBuilderWithSinks::generateNode
ExplodedNode * generateNode(ProgramStateRef State, ExplodedNode *Pred, const ProgramPointTag *Tag=nullptr)
Definition: CoreEngine.h:354
clang::ento::NodeBuilder::generateNodeImpl
ExplodedNode * generateNodeImpl(const ProgramPoint &PP, ProgramStateRef State, ExplodedNode *Pred, bool MarkAsSink=false)
Definition: CoreEngine.cpp:606
clang::ento::NodeBuilder::hasNoSinksInFrontier
bool hasNoSinksInFrontier()
Definition: CoreEngine.h:258
clang::ento::NodeBuilder::addNodes
void addNodes(ExplodedNode *N)
Definition: CoreEngine.h:337
clang::ento::BlockCounter::Factory
Definition: BlockCounter.h:40
clang::ento::NodeBuilderContext::blockCount
unsigned blockCount() const
Returns the number of times the current basic block has been visited on the exploded graph path.
Definition: CoreEngine.h:221
clang::ento::IndirectGotoNodeBuilder
Definition: CoreEngine.h:478
clang::ento::BranchNodeBuilder::markInfeasible
void markInfeasible(bool branch)
Definition: CoreEngine.h:466
clang::ento::BranchNodeBuilder::BranchNodeBuilder
BranchNodeBuilder(ExplodedNode *SrcNode, ExplodedNodeSet &DstSet, const NodeBuilderContext &C, const CFGBlock *dstT, const CFGBlock *dstF)
Definition: CoreEngine.h:441
clang::ento::ExplodedGraph
Definition: ExplodedGraph.h:304
clang::ento::IndirectGotoNodeBuilder::iterator::getBlock
const CFGBlock * getBlock() const
Definition: CoreEngine.h:505
clang::ento::SwitchNodeBuilder
Definition: CoreEngine.h:526
clang::ento::CoreEngine
CoreEngine - Implements the core logic of the graph-reachability analysis.
Definition: CoreEngine.h:55
clang::ento::NodeBuilderWithSinks::getSinks
const SmallVectorImpl< ExplodedNode * > & getSinks() const
Definition: CoreEngine.h:370
clang::ento::NodeBuilder::~NodeBuilder
virtual ~NodeBuilder()=default
ExplodedGraph.h
clang::ento::IndirectGotoNodeBuilder::getLocationContext
const LocationContext * getLocationContext() const
Definition: CoreEngine.h:521
clang::ento::Loc
Definition: SVals.h:327
clang::ento::SwitchNodeBuilder::begin
iterator begin()
Definition: CoreEngine.h:558
clang::ento::NodeBuilder::getContext
const NodeBuilderContext & getContext()
Definition: CoreEngine.h:327
clang::BlockEntrance
Definition: ProgramPoint.h:225
clang::ento::NodeBuilderWithSinks::Location
ProgramPoint & Location
Definition: CoreEngine.h:347
clang::ento::BranchNodeBuilder::isFeasible
bool isFeasible(bool branch)
Definition: CoreEngine.h:473
clang::ento::StmtNodeBuilder::~StmtNodeBuilder
~StmtNodeBuilder() override
Definition: CoreEngine.cpp:627
clang::ento::NodeBuilder::checkResults
virtual bool checkResults()
Checks if the results are ready.
Definition: CoreEngine.h:254
clang::CFGBlock::succ_end
succ_iterator succ_end()
Definition: CFG.h:956
clang::ento::SwitchNodeBuilder::end
iterator end()
Definition: CoreEngine.h:559
clang::ento::NodeBuilder::HasGeneratedNodes
bool HasGeneratedNodes
Definition: CoreEngine.h:247
clang::ento::CoreEngine::enqueueEndOfFunction
void enqueueEndOfFunction(ExplodedNodeSet &Set, const ReturnStmt *RS)
enqueue the nodes corresponding to the end of function onto the end of path / work list.
Definition: CoreEngine.cpp:589
clang::ProgramPoint::Kind
Kind
Definition: ProgramPoint.h:61
clang::ento::FunctionSummariesTy
Definition: FunctionSummary.h:33
clang::ento::CoreEngine::hasWorkRemaining
bool hasWorkRemaining() const
Definition: CoreEngine.h:162
LLVM.h
clang::AnalyzerOptions
Stores options for the analyzer from the command line.
Definition: AnalyzerOptions.h:163
clang::CFGBlock::succ_rend
succ_reverse_iterator succ_rend()
Definition: CFG.h:961
clang::ento::NodeBuilderWithSinks::generateSink
ExplodedNode * generateSink(ProgramStateRef State, ExplodedNode *Pred, const ProgramPointTag *Tag=nullptr)
Definition: CoreEngine.h:361
State
LineState State
Definition: UnwrappedLineFormatter.cpp:986
clang::ProgramPoint::PostStmtKind
@ PostStmtKind
Definition: ProgramPoint.h:67
clang::ento::CoreEngine::blocks_aborted_begin
BlocksAborted::const_iterator blocks_aborted_begin() const
Definition: CoreEngine.h:182
clang::ento::IndirectGotoNodeBuilder::generateNode
ExplodedNode * generateNode(const iterator &I, ProgramStateRef State, bool isSink=false)
Definition: CoreEngine.cpp:649
clang::ento::CoreEngine::wasBlocksExhausted
bool wasBlocksExhausted() const
Definition: CoreEngine.h:161
clang::ento::ExplodedNodeSet::begin
iterator begin()
Definition: ExplodedGraph.h:496
clang::ento::IndirectGotoNodeBuilder::iterator::operator++
iterator & operator++()
Definition: CoreEngine.h:498
clang::DeclStmt
DeclStmt - Adaptor class for mixing declarations with statements and expressions.
Definition: Stmt.h:1292
clang::ento::ExprEngine
Definition: ExprEngine.h:127
clang::ento::CoreEngine::enqueue
void enqueue(ExplodedNodeSet &Set)
Enqueue the given set of nodes onto the work list.
Definition: CoreEngine.cpp:578
clang::ento::CoreEngine::getWorkList
WorkList * getWorkList() const
Definition: CoreEngine.h:172
clang::ento::IndirectGotoNodeBuilder::iterator::getLabel
const LabelDecl * getLabel() const
Definition: CoreEngine.h:501
clang::ento::SwitchNodeBuilder::iterator::operator++
iterator & operator++()
Definition: CoreEngine.h:545
clang::ento::CoreEngine::wasBlockAborted
bool wasBlockAborted() const
Definition: CoreEngine.h:160
clang::ento::NodeBuilder::C
const NodeBuilderContext & C
Definition: CoreEngine.h:241
WorkList.h
clang
Definition: CalledOnceCheck.h:17
clang::ento::NodeBuilder::takeNodes
void takeNodes(ExplodedNode *N)
Definition: CoreEngine.h:335
CFG.h
clang::Stmt
Stmt - This represents one statement.
Definition: Stmt.h:69
clang::ProgramPoint::getProgramPoint
static ProgramPoint getProgramPoint(const Stmt *S, ProgramPoint::Kind K, const LocationContext *LC, const ProgramPointTag *tag)
Definition: ProgramPoint.cpp:22
clang::ento::NodeBuilder::generateNode
ExplodedNode * generateNode(const ProgramPoint &PP, ProgramStateRef State, ExplodedNode *Pred)
Generates a node in the ExplodedGraph.
Definition: CoreEngine.h:290
clang::ento::CoreEngine::operator=
CoreEngine & operator=(const CoreEngine &)=delete
clang::DeclaratorContext::Condition
@ Condition
clang::ento::NodeBuilderContext::getBlock
const CFGBlock * getBlock() const
Return the CFGBlock associated with this builder.
Definition: CoreEngine.h:217
clang::ento::ExplodedNodeSet::insert
void insert(const ExplodedNodeSet &S)
Definition: ExplodedGraph.h:488
clang::ento::IndirectGotoNodeBuilder::iterator
Definition: CoreEngine.h:490
clang::ento::ExplodedNodeSet::erase
bool erase(ExplodedNode *N)
Definition: ExplodedGraph.h:484
clang::ento::NodeBuilderContext
Definition: CoreEngine.h:208
clang::CallEnter
Represents a point when we begin processing an inlined call.
Definition: ProgramPoint.h:630
clang::BlockEdge
Definition: ProgramPoint.h:503
clang::ento::NodeBuilder::NodeBuilder
NodeBuilder(const ExplodedNodeSet &SrcSet, ExplodedNodeSet &DstSet, const NodeBuilderContext &Ctx, bool F=true)
Definition: CoreEngine.h:280
clang::ento::CoreEngine::getDataTags
DataTag::Factory & getDataTags()
Definition: CoreEngine.h:204
clang::ento::CoreEngine::getGraph
ExplodedGraph & getGraph()
getGraph - Returns the exploded graph.
Definition: CoreEngine.h:141
clang::ento::NodeBuilderWithSinks
Definition: CoreEngine.h:342
clang::ento::SwitchNodeBuilder::generateDefaultCaseNode
ExplodedNode * generateDefaultCaseNode(ProgramStateRef State, bool isSink=false)
Definition: CoreEngine.cpp:683
clang::CFGBlock::const_succ_reverse_iterator
AdjacentBlocks::const_reverse_iterator const_succ_reverse_iterator
Definition: CFG.h:933
clang::transformer::node
RangeSelector node(std::string ID)
Selects a node, including trailing semicolon, if any (for declarations and non-expression statements)...
Definition: RangeSelector.cpp:141
Stmt.h
clang::ento::NodeBuilder::addNodes
void addNodes(const ExplodedNodeSet &S)
Definition: CoreEngine.h:336
clang::ento::SwitchNodeBuilder::iterator::getCase
const CaseStmt * getCase() const
Definition: CoreEngine.h:549
llvm::SmallVectorImpl
Definition: LLVM.h:39
clang::ento::CoreEngine::blocks_aborted_end
BlocksAborted::const_iterator blocks_aborted_end() const
Definition: CoreEngine.h:186
clang::Expr
This represents one expression.
Definition: Expr.h:109
clang::ento::NodeBuilderContext::Eng
const CoreEngine & Eng
Definition: CoreEngine.h:209
clang::ento::NodeBuilder::hasGeneratedNodes
bool hasGeneratedNodes()
Definition: CoreEngine.h:328
clang::ento::IndirectGotoNodeBuilder::getState
ProgramStateRef getState() const
Definition: CoreEngine.h:519
clang::ento::SwitchNodeBuilder::iterator::operator==
bool operator==(const iterator &X) const
Definition: CoreEngine.h:547
clang::ento::StmtNodeBuilder::generateNode
ExplodedNode * generateNode(const Stmt *S, ExplodedNode *Pred, ProgramStateRef St, const ProgramPointTag *tag=nullptr, ProgramPoint::Kind K=ProgramPoint::PostStmtKind)
Definition: CoreEngine.h:408
clang::ento::ExplodedNodeSet
Definition: ExplodedGraph.h:463
clang::ProgramPoint
Definition: ProgramPoint.h:59
clang::ento::DataTag::Factory
Definition: BugReporter.h:745
clang::ento::NodeBuilder::NodeBuilder
NodeBuilder(ExplodedNode *SrcNode, ExplodedNodeSet &DstSet, const NodeBuilderContext &Ctx, bool F=true)
Definition: CoreEngine.h:274
clang::ento::SwitchNodeBuilder::generateCaseStmtNode
ExplodedNode * generateCaseStmtNode(const iterator &I, ProgramStateRef State)
Definition: CoreEngine.cpp:668
clang::ento::CoreEngine::ExecuteWorkList
bool ExecuteWorkList(const LocationContext *L, unsigned Steps, ProgramStateRef InitState)
ExecuteWorkList - Run the worklist algorithm for a maximum number of steps.
Definition: CoreEngine.cpp:79
llvm::IntrusiveRefCntPtr< const ProgramState >
clang::ReturnStmt
ReturnStmt - This represents a return, optionally of an expression: return; return 4;.
Definition: Stmt.h:2760
clang::ento::SwitchNodeBuilder::iterator::getBlock
const CFGBlock * getBlock() const
Definition: CoreEngine.h:553
clang::ento::NodeBuilder::begin
iterator begin()
Iterators through the results frontier.
Definition: CoreEngine.h:316