clang  14.0.0git
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
clang::ento::NodeBuilder Class Reference

#include "clang/StaticAnalyzer/Core/PathSensitive/CoreEngine.h"

Inheritance diagram for clang::ento::NodeBuilder:
Inheritance graph
[legend]
Collaboration diagram for clang::ento::NodeBuilder:
Collaboration graph
[legend]

Public Types

using iterator = ExplodedNodeSet::iterator
 

Public Member Functions

 NodeBuilder (ExplodedNode *SrcNode, ExplodedNodeSet &DstSet, const NodeBuilderContext &Ctx, bool F=true)
 
 NodeBuilder (const ExplodedNodeSet &SrcSet, ExplodedNodeSet &DstSet, const NodeBuilderContext &Ctx, bool F=true)
 
virtual ~NodeBuilder ()=default
 
ExplodedNodegenerateNode (const ProgramPoint &PP, ProgramStateRef State, ExplodedNode *Pred)
 Generates a node in the ExplodedGraph. More...
 
ExplodedNodegenerateSink (const ProgramPoint &PP, ProgramStateRef State, ExplodedNode *Pred)
 Generates a sink in the ExplodedGraph. More...
 
const ExplodedNodeSetgetResults ()
 
iterator begin ()
 Iterators through the results frontier. More...
 
iterator end ()
 
const NodeBuilderContextgetContext ()
 
bool hasGeneratedNodes ()
 
void takeNodes (const ExplodedNodeSet &S)
 
void takeNodes (ExplodedNode *N)
 
void addNodes (const ExplodedNodeSet &S)
 
void addNodes (ExplodedNode *N)
 

Protected Member Functions

virtual bool checkResults ()
 Checks if the results are ready. More...
 
bool hasNoSinksInFrontier ()
 
virtual void finalizeResults ()
 Allow subclasses to finalize results before result_begin() is executed. More...
 
ExplodedNodegenerateNodeImpl (const ProgramPoint &PP, ProgramStateRef State, ExplodedNode *Pred, bool MarkAsSink=false)
 

Protected Attributes

const NodeBuilderContextC
 
bool Finalized
 Specifies if the builder results have been finalized. More...
 
bool HasGeneratedNodes = false
 
ExplodedNodeSetFrontier
 The frontier set - a set of nodes which need to be propagated after the builder dies. More...
 

Detailed Description

This is the simplest builder which generates nodes in the ExplodedGraph.

The main benefit of the builder is that it automatically tracks the frontier nodes (or destination set). This is the set of nodes which should be propagated to the next step / builder. They are the nodes which have been added to the builder (either as the input node set or as the newly constructed nodes) but did not have any outgoing transitions added.

Definition at line 237 of file CoreEngine.h.

Member Typedef Documentation

◆ iterator

Definition at line 313 of file CoreEngine.h.

Constructor & Destructor Documentation

◆ NodeBuilder() [1/2]

clang::ento::NodeBuilder::NodeBuilder ( ExplodedNode SrcNode,
ExplodedNodeSet DstSet,
const NodeBuilderContext Ctx,
bool  F = true 
)
inline

Definition at line 274 of file CoreEngine.h.

References clang::ento::ExplodedNodeSet::Add(), and Frontier.

◆ NodeBuilder() [2/2]

clang::ento::NodeBuilder::NodeBuilder ( const ExplodedNodeSet SrcSet,
ExplodedNodeSet DstSet,
const NodeBuilderContext Ctx,
bool  F = true 
)
inline

◆ ~NodeBuilder()

virtual clang::ento::NodeBuilder::~NodeBuilder ( )
virtualdefault

Member Function Documentation

◆ addNodes() [1/2]

void clang::ento::NodeBuilder::addNodes ( const ExplodedNodeSet S)
inline

◆ addNodes() [2/2]

void clang::ento::NodeBuilder::addNodes ( ExplodedNode N)
inline

Definition at line 337 of file CoreEngine.h.

References clang::ento::ExplodedNodeSet::Add(), and Frontier.

◆ begin()

iterator clang::ento::NodeBuilder::begin ( )
inline

Iterators through the results frontier.

Definition at line 316 of file CoreEngine.h.

References clang::ento::ExplodedNodeSet::begin(), checkResults(), finalizeResults(), and Frontier.

◆ checkResults()

virtual bool clang::ento::NodeBuilder::checkResults ( )
inlineprotectedvirtual

Checks if the results are ready.

Definition at line 254 of file CoreEngine.h.

References Finalized.

Referenced by begin(), and getResults().

◆ end()

iterator clang::ento::NodeBuilder::end ( )
inline

Definition at line 322 of file CoreEngine.h.

References clang::ento::ExplodedNodeSet::end(), finalizeResults(), and Frontier.

◆ finalizeResults()

virtual void clang::ento::NodeBuilder::finalizeResults ( )
inlineprotectedvirtual

Allow subclasses to finalize results before result_begin() is executed.

Definition at line 266 of file CoreEngine.h.

Referenced by begin(), end(), and getResults().

◆ generateNode()

ExplodedNode* clang::ento::NodeBuilder::generateNode ( const ProgramPoint PP,
ProgramStateRef  State,
ExplodedNode Pred 
)
inline

◆ generateNodeImpl()

ExplodedNode * NodeBuilder::generateNodeImpl ( const ProgramPoint PP,
ProgramStateRef  State,
ExplodedNode Pred,
bool  MarkAsSink = false 
)
protected

◆ generateSink()

ExplodedNode* clang::ento::NodeBuilder::generateSink ( const ProgramPoint PP,
ProgramStateRef  State,
ExplodedNode Pred 
)
inline

Generates a sink in the ExplodedGraph.

When a node is marked as sink, the exploration from the node is stopped - the node becomes the last node on the path and certain kinds of bugs are suppressed.

Definition at line 301 of file CoreEngine.h.

References generateNodeImpl(), and State.

Referenced by clang::ento::NodeBuilderWithSinks::generateSink().

◆ getContext()

const NodeBuilderContext& clang::ento::NodeBuilder::getContext ( )
inline

◆ getResults()

const ExplodedNodeSet& clang::ento::NodeBuilder::getResults ( )
inline

◆ hasGeneratedNodes()

bool clang::ento::NodeBuilder::hasGeneratedNodes ( )
inline

Definition at line 328 of file CoreEngine.h.

References HasGeneratedNodes.

◆ hasNoSinksInFrontier()

bool clang::ento::NodeBuilder::hasNoSinksInFrontier ( )
inlineprotected

Definition at line 258 of file CoreEngine.h.

References Frontier.

Referenced by NodeBuilder().

◆ takeNodes() [1/2]

void clang::ento::NodeBuilder::takeNodes ( const ExplodedNodeSet S)
inline

◆ takeNodes() [2/2]

void clang::ento::NodeBuilder::takeNodes ( ExplodedNode N)
inline

Definition at line 335 of file CoreEngine.h.

References clang::ento::ExplodedNodeSet::erase(), and Frontier.

Member Data Documentation

◆ C

const NodeBuilderContext& clang::ento::NodeBuilder::C
protected

◆ Finalized

bool clang::ento::NodeBuilder::Finalized
protected

Specifies if the builder results have been finalized.

For example, if it is set to false, autotransitions are yet to be generated.

Definition at line 245 of file CoreEngine.h.

Referenced by checkResults().

◆ Frontier

ExplodedNodeSet& clang::ento::NodeBuilder::Frontier
protected

The frontier set - a set of nodes which need to be propagated after the builder dies.

Definition at line 251 of file CoreEngine.h.

Referenced by addNodes(), begin(), end(), generateNodeImpl(), getResults(), hasNoSinksInFrontier(), NodeBuilder(), takeNodes(), and clang::ento::StmtNodeBuilder::~StmtNodeBuilder().

◆ HasGeneratedNodes

bool clang::ento::NodeBuilder::HasGeneratedNodes = false
protected

Definition at line 247 of file CoreEngine.h.

Referenced by generateNodeImpl(), and hasGeneratedNodes().


The documentation for this class was generated from the following files: