Represents a single basic block in a source-level CFG. More...
#include "clang/Analysis/CFG.h"
Classes | |
| class | AdjacentBlock |
| This class represents a potential adjacent block in the CFG. More... | |
| class | FilteredCFGBlockIterator |
| class | FilterOptions |
Static Public Member Functions | |
| static bool | FilterEdge (const FilterOptions &F, const CFGBlock *Src, const CFGBlock *Dst) |
Public Attributes | |
| ElementList | Elements |
| The set of statements in the basic block. | |
| Stmt * | Label = nullptr |
| An (optional) label that prefixes the executable statements in the block. | |
| CFGTerminator | Terminator |
| The terminator for a basic block that indicates the type of control-flow that occurs between a block and its successors. | |
| const Stmt * | LoopTarget = nullptr |
| Some blocks are used to represent the "loop edge" to the start of a loop from within the loop body. | |
| unsigned | BlockID |
| A numerical ID assigned to a CFGBlock during construction of the CFG. | |
Detailed Description
Represents a single basic block in a source-level CFG.
It consists of:
(1) A set of statements/expressions (which may contain subexpressions). (2) A "terminator" statement (not in the set of statements). (3) A list of successors and predecessors.
Terminator: The terminator represents the type of control-flow that occurs at the end of the basic block. The terminator is a Stmt* referring to an AST node that has control-flow: if-statements, breaks, loops, etc. If the control-flow is conditional, the condition expression will appear within the set of statements in the block (usually the last statement).
Predecessors: the order in the set of predecessors is arbitrary.
Successors: the order in the set of successors is NOT arbitrary. We currently have the following orderings based on the terminator:
| Terminator | Successor Ordering |
|---|---|
| if | Then Block; Else Block |
| ? operator | LHS expression; RHS expression |
| logical and/or | expression that consumes the op, RHS |
| vbase inits | already handled by the most derived class; not yet |
But note that any of that may be NULL in case of optimized-out edges.
Member Typedef Documentation
◆ CFGElementRef
| using clang::CFGBlock::CFGElementRef = ElementRefImpl<false> |
◆ const_iterator
| using clang::CFGBlock::const_iterator = ElementList::const_iterator |
◆ const_pred_iterator
◆ const_pred_reverse_iterator
◆ const_ref_iterator
| using clang::CFGBlock::const_ref_iterator = ElementRefIterator<false, true> |
◆ const_ref_iterator_range
| using clang::CFGBlock::const_ref_iterator_range = llvm::iterator_range<const_ref_iterator> |
◆ const_reverse_iterator
◆ const_reverse_ref_iterator
| using clang::CFGBlock::const_reverse_ref_iterator = ElementRefIterator<true, true> |
◆ const_reverse_ref_iterator_range
| using clang::CFGBlock::const_reverse_ref_iterator_range = llvm::iterator_range<const_reverse_ref_iterator> |
◆ const_succ_iterator
◆ const_succ_reverse_iterator
◆ ConstCFGElementRef
| using clang::CFGBlock::ConstCFGElementRef = ElementRefImpl<true> |
◆ filtered_pred_iterator
◆ filtered_succ_iterator
◆ iterator
| using clang::CFGBlock::iterator = ElementList::iterator |
◆ pred_const_range
| using clang::CFGBlock::pred_const_range = llvm::iterator_range<const_pred_iterator> |
◆ pred_iterator
◆ pred_range
| using clang::CFGBlock::pred_range = llvm::iterator_range<pred_iterator> |
◆ pred_reverse_iterator
◆ ref_iterator
| using clang::CFGBlock::ref_iterator = ElementRefIterator<false, false> |
◆ ref_iterator_range
| using clang::CFGBlock::ref_iterator_range = llvm::iterator_range<ref_iterator> |
◆ reverse_iterator
◆ reverse_ref_iterator
| using clang::CFGBlock::reverse_ref_iterator = ElementRefIterator<true, false> |
◆ reverse_ref_iterator_range
| using clang::CFGBlock::reverse_ref_iterator_range = llvm::iterator_range<reverse_ref_iterator> |
◆ succ_const_range
| using clang::CFGBlock::succ_const_range = llvm::iterator_range<const_succ_iterator> |
◆ succ_iterator
◆ succ_range
| using clang::CFGBlock::succ_range = llvm::iterator_range<succ_iterator> |
◆ succ_reverse_iterator
Constructor & Destructor Documentation
◆ CFGBlock()
|
inlineexplicit |
Member Function Documentation
◆ addSuccessor()
| void CFGBlock::addSuccessor | ( | AdjacentBlock | Succ, |
| BumpVectorContext & | C | ||
| ) |
Adds a (potentially unreachable) successor block to the current block.
Definition at line 5368 of file CFG.cpp.
References clang::C, clang::CFGBlock::AdjacentBlock::getPossiblyUnreachableBlock(), clang::CFGBlock::AdjacentBlock::getReachableBlock(), clang::CFGBlock::AdjacentBlock::isReachable(), and clang::BumpVector< T >::push_back().
◆ appendAutomaticObjDtor()
|
inline |
◆ appendBaseDtor()
|
inline |
◆ appendConstructor()
|
inline |
◆ appendCXXRecordTypedCall()
|
inline |
◆ appendDeleteDtor()
|
inline |
◆ appendInitializer()
|
inline |
◆ appendLifetimeEnds()
|
inline |
◆ appendLoopExit()
|
inline |
◆ appendMemberDtor()
|
inline |
◆ appendNewAllocator()
|
inline |
◆ appendScopeBegin()
|
inline |
◆ appendScopeEnd()
|
inline |
◆ appendStmt()
|
inline |
◆ appendTemporaryDtor()
|
inline |
◆ back()
|
inline |
Definition at line 873 of file CFG.h.
References Elements.
Referenced by isBuiltinAssumeFalse(), and neverReturns().
◆ begin() [1/2]
|
inline |
Definition at line 875 of file CFG.h.
References Elements.
Referenced by Accumulate(), print_block(), and ref_begin().
◆ begin() [2/2]
|
inline |
◆ beginAutomaticObjDtorsInsert()
|
inline |
◆ beginLifetimeEndsInsert()
|
inline |
◆ beginScopeEndInsert()
|
inline |
◆ dump() [1/2]
| LLVM_DUMP_METHOD void CFGBlock::dump | ( | ) | const |
◆ dump() [2/2]
| void CFGBlock::dump | ( | const CFG * | cfg, |
| const LangOptions & | LO, | ||
| bool | ShowColors = false |
||
| ) | const |
dump - A simply pretty printer of a CFGBlock that outputs to stderr.
Definition at line 6122 of file CFG.cpp.
References print(), and ShowColors.
◆ empty()
|
inline |
Definition at line 918 of file CFG.h.
References Elements.
Referenced by DiagnoseSwitchLabelsFallthrough(), clang::ento::CoreEngine::ExecuteWorkList(), clang::BlockEntrance::getFirstElement(), isBuiltinAssumeFalse(), neverReturns(), clang::ento::ExprEngine::processCallEnter(), and clang::ento::ExprEngine::VisitLogicalExpr().
◆ end() [1/2]
|
inline |
Definition at line 876 of file CFG.h.
References Elements.
Referenced by Accumulate(), print_block(), and ref_end().
◆ end() [2/2]
|
inline |
◆ filtered_pred_start_end()
|
inline |
Definition at line 1029 of file CFG.h.
References pred_begin(), and pred_end().
Referenced by CheckFallThrough().
◆ filtered_succ_start_end()
|
inline |
Definition at line 1033 of file CFG.h.
References succ_begin(), and succ_end().
◆ FilterEdge()
|
static |
Definition at line 5379 of file CFG.cpp.
References getLabel(), getTerminatorStmt(), clang::CFGBlock::FilterOptions::IgnoreDefaultsWithCoveredEnums, and clang::CFGBlock::FilterOptions::IgnoreNullPredecessors.
◆ front()
|
inline |
Definition at line 872 of file CFG.h.
References Elements.
Referenced by clang::BlockEntrance::getFirstElement().
◆ getBlockID()
|
inline |
Definition at line 1074 of file CFG.h.
References BlockID.
Referenced by clang::consumed::ConsumedBlockInfo::allBackEdgesVisited(), clang::ento::NodeBuilderContext::blockCount(), CheckFallThrough(), checkForRecursiveFunctionCall(), clang::LiveVariables::computeLiveness(), clang::DataflowWorklistBase< Comp, QueueSize >::dequeue(), clang::ento::CoreEngine::ExecuteWorkList(), clang::reachable_code::FindUnreachableCode(), clang::ento::CheckerContext::getBlockID(), clang::consumed::ConsumedBlockInfo::isBackEdge(), clang::dataflow::ControlFlowContext::isBlockReachable(), clang::CFGReverseBlockReachabilityAnalysis::isReachable(), clang::threadSafety::SExprBuilder::lookupBlock(), print_block(), printAsOperand(), clang::ProgramPoint::printJson(), runOnBlock(), clang::dataflow::runTypeErasedDataflowAnalysis(), clang::runUninitializedVariablesAnalysis(), scanFromBlock(), and throwEscapes().
◆ getIndexInCFG()
| size_t CFGBlock::getIndexInCFG | ( | ) | const |
Definition at line 6117 of file CFG.cpp.
References clang::CFG::begin(), and getParent().
◆ getLabel() [1/2]
|
inline |
Definition at line 1069 of file CFG.h.
References Label.
Referenced by Accumulate(), DiagnoseSwitchLabelsFallthrough(), FilterEdge(), print_block(), and clang::ProgramPoint::printJson().
◆ getLabel() [2/2]
|
inline |
◆ getLastCondition()
| const Expr * CFGBlock::getLastCondition | ( | ) | const |
- Returns
- the last (
rbegin()) condition, e.g. observe the following code snippet: if (A && B && C) A block would be created forA,B, andC. For the latter,getTerminatorStmt()would retrieve the entire condition, rather than C itself, while this method would only return C.
Definition at line 6223 of file CFG.cpp.
References clang::CFGElement::getAs(), clang::CFGTerminator::getKind(), clang::Expr::IgnoreParens(), rbegin(), size(), clang::CFGTerminator::StmtBranch, succ_size(), and Terminator.
◆ getLoopTarget()
|
inline |
Definition at line 1067 of file CFG.h.
References LoopTarget.
◆ getParent()
|
inline |
Definition at line 1076 of file CFG.h.
References Parent.
Referenced by annotateStartParameter(), clang::ento::PathDiagnosticLocation::create(), dump(), getIndexInCFG(), and isInevitablySinking().
◆ getTerminator()
|
inline |
Definition at line 1048 of file CFG.h.
References Terminator.
Referenced by clang::ento::PathDiagnosticLocation::create(), clang::ento::SwitchNodeBuilder::getSwitch(), print_block(), printTerminator(), ResolveCondition(), runOnBlock(), and clang::ento::ExprEngine::VisitLogicalExpr().
◆ getTerminatorCondition() [1/2]
Definition at line 6251 of file CFG.cpp.
References getTerminatorStmt(), clang::Expr::IgnoreParens(), and Terminator.
Referenced by clang::ento::PathDiagnosticLocation::create(), getTerminatorCondition(), getTerminatorCondition(), isAssertlikeBlock(), and shouldTreatSuccessorsAsReachable().
◆ getTerminatorCondition() [2/2]
Definition at line 1063 of file CFG.h.
References getTerminatorCondition().
◆ getTerminatorStmt() [1/2]
|
inline |
Definition at line 1050 of file CFG.h.
References clang::CFGTerminator::getStmt(), and Terminator.
Referenced by Accumulate(), CheckFallThrough(), DiagnoseSwitchLabelsFallthrough(), FilterEdge(), clang::BlockExit::getTerminator(), getTerminatorCondition(), clang::dataflow::isLoopHead(), isTrivialDoWhile(), peelOffOuterExpr(), clang::ProgramPoint::printJson(), clang::ento::ExprEngine::processCFGBlockEntrance(), shouldTreatSuccessorsAsReachable(), clang::ento::SuppressInlineDefensiveChecksVisitor::VisitNode(), and clang::ento::ConditionBRVisitor::VisitNodeImpl().
◆ getTerminatorStmt() [2/2]
|
inline |
Definition at line 1051 of file CFG.h.
References clang::CFGTerminator::getStmt(), and Terminator.
◆ hasNoReturnElement()
|
inline |
Definition at line 1072 of file CFG.h.
Referenced by CheckFallThrough(), isImmediateSinkBlock(), neverReturns(), and print_block().
◆ insertAutomaticObjDtor()
◆ insertLifetimeEnds()
◆ insertScopeEnd()
◆ isInevitablySinking()
| bool CFGBlock::isInevitablySinking | ( | ) | const |
Returns true if the block would eventually end with a sink (a noreturn node).
Definition at line 6185 of file CFG.cpp.
References clang::CFG::getExit(), getParent(), isImmediateSinkBlock(), and succs().
Referenced by isAssertlikeBlock().
◆ operator[]()
|
inline |
◆ pred_begin() [1/2]
|
inline |
Definition at line 937 of file CFG.h.
Referenced by clang::consumed::ConsumedBlockInfo::allBackEdgesVisited(), llvm::GraphTraits< Inverse< ::clang::CFGBlock * > >::child_begin(), llvm::GraphTraits< Inverse< const ::clang::CFGBlock * > >::child_begin(), filtered_pred_start_end(), preds(), print_block(), and runOnBlock().
◆ pred_begin() [2/2]
|
inline |
◆ pred_empty()
|
inline |
Definition at line 977 of file CFG.h.
Referenced by checkRecursiveFunction(), checkThrowInNonThrowingFunc(), and print_block().
◆ pred_end() [1/2]
|
inline |
Definition at line 938 of file CFG.h.
Referenced by clang::consumed::ConsumedBlockInfo::allBackEdgesVisited(), llvm::GraphTraits< Inverse< ::clang::CFGBlock * > >::child_end(), llvm::GraphTraits< Inverse< const ::clang::CFGBlock * > >::child_end(), filtered_pred_start_end(), preds(), print_block(), and runOnBlock().
◆ pred_end() [2/2]
|
inline |
◆ pred_rbegin() [1/2]
|
inline |
◆ pred_rbegin() [2/2]
|
inline |
◆ pred_rend() [1/2]
|
inline |
◆ pred_rend() [2/2]
|
inline |
◆ pred_size()
|
inline |
Definition at line 976 of file CFG.h.
Referenced by print_block().
◆ preds() [1/2]
|
inline |
Definition at line 947 of file CFG.h.
References pred_begin(), and pred_end().
◆ preds() [2/2]
|
inline |
Definition at line 951 of file CFG.h.
References pred_begin(), and pred_end().
◆ prependScopeBegin()
|
inline |
◆ prependScopeEnd()
|
inline |
◆ print()
| void CFGBlock::print | ( | raw_ostream & | OS, |
| const CFG * | cfg, | ||
| const LangOptions & | LO, | ||
| bool | ShowColors | ||
| ) | const |
print - A simple pretty printer of a CFGBlock that outputs to an ostream.
Generally this will only be called from CFG::print.
Definition at line 6133 of file CFG.cpp.
References OS, print_block(), and ShowColors.
Referenced by dump(), and clang::CFG::dump().
◆ printAsOperand()
|
inline |
Definition at line 1088 of file CFG.h.
References getBlockID(), and OS.
◆ printTerminator()
| void CFGBlock::printTerminator | ( | raw_ostream & | OS, |
| const LangOptions & | LO | ||
| ) | const |
printTerminator - A simple pretty printer of the terminator of a CFGBlock.
Definition at line 6141 of file CFG.cpp.
References getTerminator(), and OS.
Referenced by printTerminatorJson().
◆ printTerminatorJson()
| void CFGBlock::printTerminatorJson | ( | raw_ostream & | Out, |
| const LangOptions & | LO, | ||
| bool | AddQuotes | ||
| ) | const |
printTerminatorJson - Pretty-prints the terminator in JSON format.
Definition at line 6148 of file CFG.cpp.
References clang::JsonFormat(), and printTerminator().
Referenced by clang::ProgramPoint::printJson().
◆ rbegin() [1/2]
|
inline |
Definition at line 880 of file CFG.h.
References Elements.
Referenced by CheckFallThrough(), getLastCondition(), ResolveCondition(), rref_begin(), and clang::ento::ExprEngine::VisitLogicalExpr().
◆ rbegin() [2/2]
|
inline |
◆ ref_begin() [1/2]
|
inline |
◆ ref_begin() [2/2]
|
inline |
◆ ref_end() [1/2]
|
inline |
◆ ref_end() [2/2]
|
inline |
◆ refs() [1/2]
|
inline |
Definition at line 910 of file CFG.h.
References ref_begin(), and ref_end().
◆ refs() [2/2]
|
inline |
Definition at line 911 of file CFG.h.
References ref_begin(), and ref_end().
◆ rend() [1/2]
|
inline |
Definition at line 881 of file CFG.h.
References Elements.
Referenced by CheckFallThrough(), ResolveCondition(), and rref_end().
◆ rend() [2/2]
|
inline |
◆ rref_begin() [1/2]
|
inline |
◆ rref_begin() [2/2]
|
inline |
◆ rref_end() [1/2]
|
inline |
◆ rref_end() [2/2]
|
inline |
◆ rrefs() [1/2]
|
inline |
Definition at line 912 of file CFG.h.
References rref_begin(), and rref_end().
◆ rrefs() [2/2]
|
inline |
Definition at line 913 of file CFG.h.
References rref_begin(), and rref_end().
◆ setHasNoReturnElement()
◆ setLabel()
|
inline |
◆ setLoopTarget()
|
inline |
Definition at line 1041 of file CFG.h.
References LoopTarget.
◆ setTerminator()
|
inline |
Definition at line 1039 of file CFG.h.
References Terminator.
◆ size()
|
inline |
Definition at line 917 of file CFG.h.
References Elements.
Referenced by clang::ento::CallEvent::getCalleeStackFrame(), and getLastCondition().
◆ succ_begin() [1/2]
|
inline |
Definition at line 955 of file CFG.h.
Referenced by clang::ento::IndirectGotoNodeBuilder::begin(), clang::dataflow::blockIndexInPredecessor(), llvm::GraphTraits< ::clang::CFGBlock * >::child_begin(), llvm::GraphTraits< const ::clang::CFGBlock * >::child_begin(), clang::LiveVariables::computeLiveness(), DiagnoseSwitchLabelsFallthrough(), clang::ento::CoreEngine::ExecuteWorkList(), filtered_succ_start_end(), isAssertlikeBlock(), isJumpToFalseBranch(), peelOffOuterExpr(), print_block(), clang::ProgramPoint::printJson(), clang::ento::ExprEngine::processCallEnter(), scanFromBlock(), succs(), clang::ento::ExprEngine::VisitLogicalExpr(), and clang::ento::ConditionBRVisitor::VisitTerminator().
◆ succ_begin() [2/2]
|
inline |
◆ succ_empty()
|
inline |
Definition at line 974 of file CFG.h.
Referenced by print_block().
◆ succ_end() [1/2]
|
inline |
Definition at line 956 of file CFG.h.
Referenced by llvm::GraphTraits< ::clang::CFGBlock * >::child_end(), llvm::GraphTraits< const ::clang::CFGBlock * >::child_end(), clang::LiveVariables::computeLiveness(), clang::ento::IndirectGotoNodeBuilder::end(), filtered_succ_start_end(), print_block(), scanFromBlock(), and succs().
◆ succ_end() [2/2]
|
inline |
◆ succ_rbegin() [1/2]
|
inline |
Definition at line 960 of file CFG.h.
Referenced by clang::ento::SwitchNodeBuilder::begin(), and clang::ento::SwitchNodeBuilder::generateDefaultCaseNode().
◆ succ_rbegin() [2/2]
|
inline |
◆ succ_rend() [1/2]
|
inline |
Definition at line 961 of file CFG.h.
Referenced by clang::ento::SwitchNodeBuilder::end(), and clang::ento::SwitchNodeBuilder::generateDefaultCaseNode().
◆ succ_rend() [2/2]
|
inline |
◆ succ_size()
|
inline |
Definition at line 973 of file CFG.h.
Referenced by DiagnoseSwitchLabelsFallthrough(), clang::ento::CoreEngine::ExecuteWorkList(), getLastCondition(), isAssertlikeBlock(), isJumpToFalseBranch(), print_block(), clang::ento::ExprEngine::processCallEnter(), clang::ento::ExprEngine::VisitLogicalExpr(), and clang::ento::ConditionBRVisitor::VisitTerminator().
◆ succs() [1/2]
|
inline |
Definition at line 965 of file CFG.h.
References succ_begin(), and succ_end().
Referenced by clang::dataflow::blockIndexInPredecessor(), CheckFallThrough(), isInevitablySinking(), clang::CFG::isLinear(), and throwEscapes().
◆ succs() [2/2]
|
inline |
Definition at line 969 of file CFG.h.
References succ_begin(), and succ_end().
Member Data Documentation
◆ BlockID
| unsigned clang::CFGBlock::BlockID |
A numerical ID assigned to a CFGBlock during construction of the CFG.
Definition at line 783 of file CFG.h.
Referenced by getBlockID().
◆ Elements
| ElementList clang::CFGBlock::Elements |
The set of statements in the basic block.
Definition at line 766 of file CFG.h.
Referenced by appendAutomaticObjDtor(), appendBaseDtor(), appendConstructor(), appendCXXRecordTypedCall(), appendDeleteDtor(), appendInitializer(), appendLifetimeEnds(), appendLoopExit(), appendMemberDtor(), appendNewAllocator(), appendScopeBegin(), appendScopeEnd(), appendStmt(), appendTemporaryDtor(), back(), begin(), beginAutomaticObjDtorsInsert(), beginLifetimeEndsInsert(), beginScopeEndInsert(), empty(), end(), front(), operator[](), prependScopeBegin(), prependScopeEnd(), rbegin(), rend(), and size().
◆ Label
| Stmt* clang::CFGBlock::Label = nullptr |
An (optional) label that prefixes the executable statements in the block.
When this variable is non-NULL, it is either an instance of LabelStmt, SwitchCase or CXXCatchStmt.
Definition at line 771 of file CFG.h.
Referenced by getLabel(), print_block(), and setLabel().
◆ LoopTarget
| const Stmt* clang::CFGBlock::LoopTarget = nullptr |
Some blocks are used to represent the "loop edge" to the start of a loop from within the loop body.
This Stmt* will be refer to the loop statement for such blocks (and be null otherwise).
Definition at line 780 of file CFG.h.
Referenced by getLoopTarget(), and setLoopTarget().
◆ Terminator
| CFGTerminator clang::CFGBlock::Terminator |
The terminator for a basic block that indicates the type of control-flow that occurs between a block and its successors.
Definition at line 775 of file CFG.h.
Referenced by getLastCondition(), getTerminator(), getTerminatorCondition(), getTerminatorStmt(), and setTerminator().
The documentation for this class was generated from the following files:
