Type Members

1.  case class CallAlias(identifier: String, receiverName: Option[String] = None) extends LocalKey with Product with Serializable

   A name that refers to some kind of callee.

2.  case class CollectionVar(identifier: String, idx: String) extends LocalKey with Product with Serializable

   A collection object that can be accessed with potentially dynamic keys and values.

3.  case class FieldVar(compUnitFullName: String, identifier: String) extends GlobalKey with Product with Serializable

   Represents a field identifier at its declared computational unit.

   Represents a field identifier at its declared computational unit.

   compUnitFullName

   the computational unit's full name.

   identifier

   the canonical name.

4.  sealed class GlobalKey extends SBKey

   Represents an identifier of some AST node at an interprocedural scope.

5.  class JavascriptCallLinker extends CpgPass

   The Javascript specific call linker links static call sites (by full name) and call sites to methods in the same file (by name).

6.  sealed class LocalKey extends SBKey

   Represents an identifier of some AST node at an intraprocedural scope.

7.  case class LocalVar(identifier: String) extends LocalKey with Product with Serializable

   A variable that holds data within an intraprocedural scope.

8.  class MetaDataPass extends CpgPass

   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.

9.  abstract class RecoverForXCompilationUnit[CompilationUnitType <: AstNode] extends RecursiveTask[Unit]

   Performs type recovery from the root of a compilation unit level

   Performs type recovery from the root of a compilation unit level

   CompilationUnitType

   the AstNode type used to represent a compilation unit of the language.

10.  abstract class SBKey extends AnyRef

    Represents an identifier of some AST node at a specific scope.

11.  class SymbolTable[K <: SBKey] extends AnyRef

    A thread-safe symbol table that can represent multiple types per symbol.

    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.

12.  class TypeNodePass extends CpgPass

    Creates a TYPE node for each type in usedTypes

13.  abstract class XTypeHintCallLinker extends CpgPass

    Attempts to set the methodFullName and link to callees using the recovered type information from XTypeRecovery.

    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.

14.  abstract class XTypeRecovery[CompilationUnitType <: AstNode] extends CpgPass

    Based on a flow-insensitive symbol-table-style approach.

    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 compilation 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 compilation 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.

    CompilationUnitType

    the AstNode type used to represent a compilation unit of the language.