Module DataFlowUtil

Provides C++-specific definitions for use in the data flow library.

Import path

import semmle.code.cpp.ir.dataflow.internal.DataFlowUtil

Imports

Cached
ExprFlowCached	INTERNAL: Do not use.
ExprNodes	Provides the classes `ExprNode` and `IndirectExprNode` for converting between `Expr` and `Node`.
RawIndirectNodes

Predicates

conversionFlow	Holds if `opFrom` is an operand whose value flows to the result of `instrTo`.
convertedExprNode	Gets the `Node` corresponding to the value of evaluating `e`. Here, `e` may be a `Conversion`. For data flowing out of an expression, like when an argument is passed by reference, use `definitionByReferenceNodeFromArgument` instead.
definitionByReferenceNodeFromArgument	Gets the `Node` corresponding to a definition by reference of the variable that is passed as unconverted `argument` of a call.
exprNode	Gets the `Node` corresponding to the value of evaluating `e` or any of its conversions. There is no result if `e` is a `Conversion`. For data flowing out of an expression, like when an argument is passed by reference, use `definitionByReferenceNodeFromArgument` instead.
getARuntimeTarget	Gets a function that may be called by `call`.
getTypeImpl	INTERNAL: Do not use.
hasInstructionAndIndex
hasOperandAndIndex
instructionNode	Gets the node corresponding to `instr`.
localExprFlow	Holds if data can flow from `e1` to `e2` in zero or more local (intra-procedural) steps.
localFlow	Holds if data flows from `source` to `sink` in zero or more local (intra-procedural) steps.
localInstructionFlow	Holds if data can flow from `i1` to `i2` in zero or more local (intra-procedural) steps.
operandNode	Gets the node corresponding to `operand`.
parameterNode	Gets the `Node` corresponding to the value of `p` at function entry.
repeatStars	Gets a string consisting of `n` star characters (“*”), where n >= 0. This is used to represent indirection.
stripPointer	INTERNAL: Do not use.
uninitializedNode	DEPRECATED: See UninitializedNode.
variableNode	Gets the `VariableNode` corresponding to the variable `v`.

Classes

AdditionalCallTarget	A unit class for adding additional call steps.
BodyLessParameterNodeImpl	INTERNAL: do not use.
Content	A description of the way data may be stored inside an object. Examples include instance fields, the contents of a collection object, or the contents of an array.
ContentSet	An entity that represents a set of `Content`s.
DefinitionByReferenceNode	A node that represents the value of a variable after a function call that may have changed the variable because it’s passed by reference.
DirectParameterNode	An explicit positional parameter, including `this`, but not `...`.
ElementContent	A `Content` that represents one of the elements of a container (e.g., `std::vector`).
ExplicitParameterNode
FieldAddress	An operand that is defined by a `FieldAddressInstruction`.
FieldContent	A `Content` that references a `Field`. This may be a field of a `struct`, `class`, or `union`. In the case of a `union` there may be multiple fields associated with the same `Content`.
FinalGlobalValue	INTERNAL: do not use.
FinalParameterNode	INTERNAL: do not use.
FlowSummaryNode	A data-flow node used to model flow summaries. That is, a dataflow node that is synthesized to represent a parameter, return value, or other part of a models-as-data modeled function.
IndirectArgumentOutNode	INTERNAL: do not use.
IndirectParameterNode	INTERNAL: do not use.
IndirectReturnNode	INTERNAL: do not use.
IndirectReturnOutNode	INTERNAL: do not use.
InitialGlobalValue	INTERNAL: do not use.
InstructionDirectParameterNode	INTERNAL: Do not use.
InstructionNode	An instruction, viewed as a node in a data flow graph.
Node	A node in a data flow graph.
NonUnionFieldContent	A reference through a non-union instance field.
OperandNode	An operand, viewed as a node in a data flow graph.
ParameterNode	The value of a parameter at function entry, viewed as a node in a data flow graph. This includes both explicit parameters such as `x` in `f(x)` and implicit parameters such as `this` in `x.f()`.
PostFieldUpdateNode	INTERNAL: do not use.
PostUpdateNode	A node associated with an object after an operation that might have changed its state.
PostUpdateNodeImpl	INTERNAL: Do not use.
SideEffectOperandNode	INTERNAL: do not use.
SsaIteratorNode	INTERNAL: do not use.
SsaSynthNode	INTERNAL: do not use.
SummaryParameterNode	A parameter node that is part of a summary.
SummaryPostUpdateNode	A `PostUpdateNode` that is part of a flow summary. These are synthesized, for example, when a models-as-data summary models a write to a field since the write needs to target a `PostUpdateNode`.
ThisParameterInstructionNode	An implicit `this` parameter.
UninitializedNode	The value of an uninitialized local variable, viewed as a node in a data flow graph.
UnionContent	A reference through an instance field of a union.
VariableNode	A `Node` corresponding to a global (or `static` local) variable in the program, as opposed to the value of that variable at some particular point. This is used to model flow through global variables (and `static` local variables).

Modules

BarrierGuard	Provides a set of barrier nodes for a guard that validates an expression.
ExprFlowCached	INTERNAL: Do not use.
InstructionBarrierGuard	Provides a set of barrier nodes for a guard that validates an instruction.
Ssa	A module that provides static single assignment (SSA) information.

Predicate signatures

guardChecksSig	Holds if the guard `g` validates the expression `e` upon evaluating to `branch`.
instructionGuardChecksSig	Holds if the guard `g` validates the instruction `instr` upon evaluating to `branch`.