io.joern.x2cpg.passes.frontend
Members list
Type members
Classlikes
Represents a field identifier at its declared computational unit.
The Javascript specific call linker links static call sites (by full name) and call sites to methods in the same file (by name).
The Javascript specific call linker links static call sites (by full name) and call sites to methods in the same file (by name).
Attributes
- Graph
- Supertypes
- class CpgPassclass ForkJoinParallelCpgPass[AnyRef]class NewStyleCpgPassBase[AnyRef]trait CpgPassBaseclass Objecttrait Matchableclass Any
Represents an identifier of some AST node at an intraprocedural scope.
Represents an identifier of some AST node at an intraprocedural scope.
Attributes
- Graph
- Supertypes
- Known subtypes
A pass that creates a MetaData node, specifying that this is a CPG for language, and a NamespaceBlock for anything that cannot be assigned to any other namespace.
A pass that creates a MetaData node, specifying that this is a CPG for language, and a NamespaceBlock for anything that cannot be assigned to any other namespace.
Attributes
- Companion:
- object
- Graph
- Supertypes
- class CpgPassclass ForkJoinParallelCpgPass[AnyRef]class NewStyleCpgPassBase[AnyRef]trait CpgPassBaseclass Objecttrait Matchableclass Any
Attributes
- Companion:
- class
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
- MetaDataPass.type
Performs type recovery from the root of a compilation unit level
Performs type recovery from the root of a compilation unit level
Attributes
- ComputationalUnit
the AstNode type used to represent a computational unit of the language.
- builder
the graph builder
- cpg
the graph.
- cu
a compilation unit, e.g. file, procedure, type, etc.
- globalTable
the global symbol table.
- Graph
- Supertypes
- class RecursiveTask[Unit]class ForkJoinTask[Unit]trait Serializabletrait Future[Unit]class Objecttrait Matchableclass Any
Represents an identifier of some AST node at a specific scope.
A thread-safe symbol table that can represent multiple types per symbol. Each node in an AST gets converted to an SBKey which gives contextual information to identify an AST entity. Each value in this table represents a set of types that the key could be in a flow-insensitive manner.
A thread-safe symbol table that can represent multiple types per symbol. Each node in an AST gets converted to an SBKey which gives contextual information to identify an AST entity. Each value in this table represents a set of types that the key could be in a flow-insensitive manner.
The SymbolTable operates like a map with a few convenient methods that are designed for this structure's purpose.
Attributes
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
Creates a TYPE
node for each type in usedTypes
Creates a TYPE
node for each type in usedTypes
Attributes
- Companion:
- object
- Graph
- Supertypes
- class CpgPassclass ForkJoinParallelCpgPass[AnyRef]class NewStyleCpgPassBase[AnyRef]trait CpgPassBaseclass Objecttrait Matchableclass Any
Attributes
- Companion:
- class
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
- TypeNodePass.type
Attempts to set the methodFullName
and link to callees using the recovered type information from
XTypeRecovery. Note that some methods may not be present as they could be external and have been dynamically
discovered, thus the io.joern.x2cpg.passes.base.MethodStubCreator would have missed it.
Attempts to set the methodFullName
and link to callees using the recovered type information from
XTypeRecovery. Note that some methods may not be present as they could be external and have been dynamically
discovered, thus the io.joern.x2cpg.passes.base.MethodStubCreator would have missed it.
Attributes
- cpg
the target code property graph.
- Graph
- Supertypes
- class CpgPassclass ForkJoinParallelCpgPass[AnyRef]class NewStyleCpgPassBase[AnyRef]trait CpgPassBaseclass Objecttrait Matchableclass Any
Based on a flow-insensitive symbol-table-style approach. This pass aims to be fast and deterministic and does not try to converge to some fixed point but rather iterates a fixed number of times. This will help recover:
Based on a flow-insensitive symbol-table-style approach. This pass aims to be fast and deterministic and does not try to converge to some fixed point but rather iterates a fixed number of times. This will help recover:
- Imported call signatures from external dependencies
- Dynamic type hints for mutable variables in a computational unit.
The algorithm flows roughly as follows:
- Scan for method signatures of methods for each compilation unit, either by internally defined methods or by reading import signatures. This includes looking for aliases, e.g. import foo as bar.
- (Optionally) Prune these method signatures by checking their validity against the CPG.
- Visit assignments to populate where variables are assigned a value to extrapolate its type. Store these values in a local symbol table. If a field is assigned a value, store this in the global table
- Find instances of where these fields and variables are used and update their type information.
- If this variable is the receiver of a call, make sure to set the type of the call accordingly.
In order to propagate types across computational units, but avoid the poor scalability of a fixed-point algorithm, the number of iterations can be configured using the iterations parameter. Note that iterations < 2 will not provide any interprocedural type recovery capabilities.
The symbol tables use the SymbolTable class to track possible type information.
Note: Local symbols
are cleared once a compilation unit is complete. This is to keep memory usage down while maximizing
concurrency.
Attributes
- ComputationalUnit
the AstNode type used to represent a computational unit of the language.
- cpg
the CPG to recovery types for.
- iterations
the total number of iterations through which types are to be propagated. At least 2 are recommended in order to propagate interprocedural types. Think of this as similar to the dataflowengineoss' 'maxCallDepth'.
- Companion:
- object
- Graph
- Supertypes
- class CpgPassclass ForkJoinParallelCpgPass[AnyRef]class NewStyleCpgPassBase[AnyRef]trait CpgPassBaseclass Objecttrait Matchableclass Any
Attributes
- Companion:
- class
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
- XTypeRecovery.type