Package ghidra.pcode.emu.jit.gen.op

Enum Class BranchOpGen

java.lang.Object

java.lang.Enum<BranchOpGen>

ghidra.pcode.emu.jit.gen.op.BranchOpGen

All Implemented Interfaces:

OpGen<JitBranchOp>, Serializable, Comparable<BranchOpGen>, Constable

public enum BranchOpGen
extends Enum<BranchOpGen>
implements OpGen<JitBranchOp>

The generator for a branch.

With an JitPassage.IntBranch record, this simply looks up the label for the target block and emits a block transition followed by a goto.

With an JitPassage.ExtBranch record, this emits code to retire the target to the program counter, along with the target context and live variables. It then emits code to request the chained entry point from the target's exit slot and return it. The thread can then immediately execute the chained passage entry.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface ghidra.pcode.emu.jit.gen.op.OpGen

OpGen.DeadOpResult, OpGen.LiveOpResult, OpGen.OpResult

Enum Constant Summary

Enum Constants

Enum Constant	Description
GEN	The generator singleton

Method Summary

Modifier and Type	Method	Description
<THIS extends JitCompiledPassage> OpGen.DeadOpResult	genRun(Emitter<Emitter.Bot> em, Local<Types.TRef<THIS>> localThis, Local<Types.TInt> localCtxmod, Methods.RetReq<Types.TRef<JitCompiledPassage.EntryPoint>> retReq, JitCodeGenerator<THIS> gen, JitBranchOp op, JitControlFlowModel.JitBlock block, Scope scope)	Emit bytecode into the run method.
static BranchOpGen	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BranchOpGen[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GEN

public static final BranchOpGen GEN

The generator singleton

Method Details

values

public static BranchOpGen[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static BranchOpGen valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

genRun

public <THIS extends JitCompiledPassage>
OpGen.DeadOpResult genRun(Emitter<Emitter.Bot> em,
 Local<Types.TRef<THIS>> localThis,
 Local<Types.TInt> localCtxmod,
 Methods.RetReq<Types.TRef<JitCompiledPassage.EntryPoint>> retReq,
 JitCodeGenerator<THIS> gen,
 JitBranchOp op,
 JitControlFlowModel.JitBlock block,
 Scope scope)

Description copied from interface: OpGen

Emit bytecode into the run method.

This method must emit the code needed to load any input operands, convert them to the appropriate type, perform the actual operation, and then if applicable, store the output operand. The implementations should delegate to JitCodeGenerator.genReadToStack(Emitter, Local, JitVal, ghidra.pcode.emu.jit.analysis.JitType.SimpleJitType, Ext), JitCodeGenerator.genWriteFromStack(Emitter, Local, JitVar, ghidra.pcode.emu.jit.analysis.JitType.SimpleJitType, Ext, Scope) or similar for mp-int types.

Specified by:

genRun in interface OpGen<JitBranchOp>

Type Parameters:

THIS - the type of the generated passage

Parameters:

em - the emitter typed with the empty stack

localThis - a handle to the local holding the this reference

localCtxmod - a handle to the local holding ctxmod

retReq - an indication of what must be returned by this JitCompiledPassage.run(int) method.

gen - the code generator

op - the p-code op (use-def node) to translate

block - the basic block containing the p-code op

scope - a scope for generating temporary local storage

Returns:

the result of emitting the p-code op's bytecode