ghidra2cpg
API
Generated with
ghidra2cpg/io.joern.ghidra2cpg/io.joern.ghidra2cpg.passes/FunctionPass

FunctionPass

io.joern.ghidra2cpg.passes.FunctionPass
abstract class FunctionPass(processor: Processor, currentProgram: Program, functions: List[Function], cpg: Cpg, decompiler: Decompiler) extends ConcurrentWriterCpgPass[Function]

Attributes

Graph
Supertypes
class ConcurrentWriterCpgPass[Function]
class NewStyleCpgPassBase[Function]
trait CpgPassBase
class Object
trait Matchable
class Any
Show all
Known subtypes

Members list

Type members

Inherited types

type DiffGraphBuilder = DiffGraphBuilder

Attributes

Inherited from:
NewStyleCpgPassBase

Value members

Concrete methods

def addCallOrReturnNode(instruction: Instruction): CfgNodeNew
def connectCallToArgument(diffGraphBuilder: DiffGraphBuilder, call: CfgNodeNew, argument: CfgNodeNew): Unit
override def generateParts(): Array[Function]

Attributes

Definition Classes
NewStyleCpgPassBase
def getHighFunction(function: Function): Option[HighFunction]
protected def getInstructions(function: Function): Seq[Instruction]
def handleArguments(diffGraphBuilder: DiffGraphBuilder, instruction: Instruction, callNode: CfgNodeNew, function: Function): Unit
def handleBody(diffGraphBuilder: DiffGraphBuilder, function: Function, methodNode: NewMethod, blockNode: NewBlock): Unit
def handleLocals(diffGraphBuilder: DiffGraphBuilder, function: Function, blockNode: NewBlock): Unit
def handleParameters(diffGraphBuilder: DiffGraphBuilder, function: Function, methodNode: NewMethod): Unit
def sanitizeMethodName(methodName: String): String

Inherited methods

override def createAndApply(): Unit

Attributes

Definition Classes
NewStyleCpgPassBase -> CpgPassBase
Inherited from:
NewStyleCpgPassBase
override def createApplySerializeAndStore(serializedCpg: SerializedCpg, inverse: Boolean, prefix: String): Unit

WARNING: runOnPart is executed in parallel to committing of graph modifications. The upshot is that it is unsafe to read ANY data from cpg, on pain of bad race conditions

WARNING: runOnPart is executed in parallel to committing of graph modifications. The upshot is that it is unsafe to read ANY data from cpg, on pain of bad race conditions

Only use ConcurrentWriterCpgPass if you are very sure that you avoid races.

E.g. adding a CFG edge to node X races with reading an AST edge of node X.

Attributes

Definition Classes
ConcurrentWriterCpgPass -> CpgPassBase
Inherited from:
ConcurrentWriterCpgPass
def finish(): Unit

Attributes

Inherited from:
NewStyleCpgPassBase
def init(): Unit

Attributes

Inherited from:
NewStyleCpgPassBase
def name: String

Name of the pass. By default it is inferred from the name of the class, override if needed.

Name of the pass. By default it is inferred from the name of the class, override if needed.

Attributes

Inherited from:
CpgPassBase
def runOnPart(builder: DiffGraphBuilder, part: Function): Unit

Attributes

Inherited from:
NewStyleCpgPassBase
override def runWithBuilder(externalBuilder: DiffGraphBuilder): Int

Runs the cpg pass, adding changes to the passed builder. Use with caution -- API is unstable. Returns max(nParts, 1), where nParts is either the number of parallel parts, or the number of iterarator elements in case of legacy passes. Includes init() and finish() logic.

Runs the cpg pass, adding changes to the passed builder. Use with caution -- API is unstable. Returns max(nParts, 1), where nParts is either the number of parallel parts, or the number of iterarator elements in case of legacy passes. Includes init() and finish() logic.

Attributes

Definition Classes
NewStyleCpgPassBase -> CpgPassBase
Inherited from:
NewStyleCpgPassBase
def runWithBuilderLogged(builder: DiffGraphBuilder): Int

Wraps runWithBuilder with logging, and swallows raised exceptions. Use with caution -- API is unstable. A return value of -1 indicates failure, otherwise the return value of runWithBuilder is passed through.

Wraps runWithBuilder with logging, and swallows raised exceptions. Use with caution -- API is unstable. A return value of -1 indicates failure, otherwise the return value of runWithBuilder is passed through.

Attributes

Inherited from:
CpgPassBase

Concrete fields

protected val codeUnitFormat: CodeUnitFormat
protected val functionByName: Map[String, Function]

Inherited fields

var nDiffT: Int

Attributes

Inherited from:
ConcurrentWriterCpgPass

Implicits

Implicits

implicit def intToIntegerOption(intOption: Option[Int]): Option[Integer]
Generated with