Class AnnotatedEmuSyscallUseropLibrary<T>

java.lang.Object

ghidra.pcode.exec.DefaultPcodeUseropLibrary<T>

ghidra.pcode.exec.AnnotatedPcodeUseropLibrary<T>

ghidra.pcode.emu.sys.AnnotatedEmuSyscallUseropLibrary<T>

Type Parameters:

T - the type of data processed by the library, typically byte[]

All Implemented Interfaces:

EmuSyscallLibrary<T>, PcodeUseropLibrary<T>

Direct Known Subclasses:

AbstractEmuUnixSyscallUseropLibrary

public abstract class AnnotatedEmuSyscallUseropLibrary<T>
extends AnnotatedPcodeUseropLibrary<T>
implements EmuSyscallLibrary<T>

A syscall library wherein Java methods are exported via a special annotated

This library is both a system call and a sleigh userop library. To export a system call, it must also be exported as a sleigh userop. This is more conventional, as the system call dispatcher does not require it, however, this library uses a wrapping technique that does require it. In general, exporting system calls as userops will make developers and users lives easier. To avoid naming collisions, system calls can be exported with customized names.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	AnnotatedEmuSyscallUseropLibrary.EmuSyscall	An annotation to export a method as a system call in the library.
protected class	AnnotatedEmuSyscallUseropLibrary.StructuredPart

Nested classes/interfaces inherited from class AnnotatedPcodeUseropLibrary

AnnotatedPcodeUseropLibrary.AnnotatedPcodeUseropDefinition<T>, AnnotatedPcodeUseropLibrary.FixedArgsAnnotatedPcodeUseropDefinition<T>, AnnotatedPcodeUseropLibrary.OpExecutor, AnnotatedPcodeUseropLibrary.OpInput, AnnotatedPcodeUseropLibrary.OpLibrary, AnnotatedPcodeUseropLibrary.OpOp, AnnotatedPcodeUseropLibrary.OpOutput, AnnotatedPcodeUseropLibrary.OpState, AnnotatedPcodeUseropLibrary.PcodeUserop, AnnotatedPcodeUseropLibrary.VariadicAnnotatedPcodeUseropDefinition<T>

Nested classes/interfaces inherited from interface EmuSyscallLibrary

EmuSyscallLibrary.EmuSyscallDefinition<T>

Nested classes/interfaces inherited from interface PcodeUseropLibrary

PcodeUseropLibrary.EmptyPcodeUseropLibrary, PcodeUseropLibrary.PcodeUseropDefinition<T>, PcodeUseropLibrary.PcodeUseropSymbolMap

Field Summary

Fields

Modifier and Type	Field	Description
protected final Collection<DataTypeManager>	additionalArchives
protected static final Map<Class<?>, Set<Method>>	CACHE_BY_CLASS
protected final CompilerSpec	cSpec
protected final DataType	dtMachineWord
protected final PcodeMachine<T>	machine
protected final Program	program
static final String	SYSCALL_SPACE_NAME
protected final Map<Long, EmuSyscallLibrary.EmuSyscallDefinition<T>>	syscallMap

Fields inherited from class DefaultPcodeUseropLibrary

ops

Fields inherited from interface EmuSyscallLibrary

FALLBACK_EMU_SYSCALL, SYSCALL_CONVENTION_NAME

Fields inherited from interface PcodeUseropLibrary

NIL, SYMBOL_CACHE

Constructor Summary

Constructors

Constructor	Description
AnnotatedEmuSyscallUseropLibrary(PcodeMachine<T> machine, Program program)	Construct a new library including the "emu_syscall" userop

Method Summary

Modifier and Type	Method	Description
protected void	disposeAdditionalArchives()
protected Collection<DataTypeManager>	getAdditionalArchives()
Map<Long, EmuSyscallLibrary.EmuSyscallDefinition<T>>	getSyscalls()	Get the map of syscalls by number
protected void	mapAndBindSyscalls()
protected void	mapAndBindSyscalls(Class<?> cls)
protected UseropEmuSyscallDefinition<T>	newBoundSyscall(long number, PcodeUseropLibrary.PcodeUseropDefinition<T> opdef, PrototypeModel convention)	Export a userop as a system call
protected AnnotatedEmuSyscallUseropLibrary<T>.StructuredPart	newStructuredPart()	Create the structured-sleigh part of this library

Methods inherited from class AnnotatedPcodeUseropLibrary

getMethodLookup, getOperandType

Methods inherited from class DefaultPcodeUseropLibrary

getUserops, putOp

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface EmuSyscallLibrary

emu_rt_syscall, emu_syscall

Methods inherited from interface PcodeUseropLibrary

compose, compose, getSymbols, getUserops

Field Details

SYSCALL_SPACE_NAME

public static final String SYSCALL_SPACE_NAME

See Also:

• Constant Field Values

CACHE_BY_CLASS

protected static final Map<Class<?>, Set<Method>> CACHE_BY_CLASS

machine

protected final PcodeMachine<T> machine

cSpec

protected final CompilerSpec cSpec

program

protected final Program program

dtMachineWord

protected final DataType dtMachineWord

syscallMap

protected final Map<Long, EmuSyscallLibrary.EmuSyscallDefinition<T>> syscallMap

additionalArchives

protected final Collection<DataTypeManager> additionalArchives

Constructor Details

AnnotatedEmuSyscallUseropLibrary

public AnnotatedEmuSyscallUseropLibrary(PcodeMachine<T> machine,
 Program program)

Construct a new library including the "emu_syscall" userop

Note that the final library must export the system call entry point. Often, this is the "syscall" userop. That userop must read the system call number, pass it as an argument to "emu_syscall," and store the result according to the ABI of the target platform.

Parameters:

machine - the machine using this library

program - a program from which to derive syscall configuration, conventions, etc.

Method Details

getAdditionalArchives

protected Collection<DataTypeManager> getAdditionalArchives()

disposeAdditionalArchives

protected void disposeAdditionalArchives()

newStructuredPart

protected AnnotatedEmuSyscallUseropLibrary<T>.StructuredPart newStructuredPart()

Create the structured-sleigh part of this library

Returns:

the structured part

newBoundSyscall

protected UseropEmuSyscallDefinition<T> newBoundSyscall(long number,
 PcodeUseropLibrary.PcodeUseropDefinition<T> opdef,
 PrototypeModel convention)

Export a userop as a system call

Parameters:

number - the syscall number

opdef - the userop

convention - the syscall calling convention for the emulated platform

Returns:

the syscall definition

mapAndBindSyscalls

protected void mapAndBindSyscalls(Class<?> cls)

mapAndBindSyscalls

protected void mapAndBindSyscalls()

getSyscalls

public Map<Long, EmuSyscallLibrary.EmuSyscallDefinition<T>> getSyscalls()

Description copied from interface: EmuSyscallLibrary

Get the map of syscalls by number

Note this method will be invoked for every interpreted syscall, so it should be a simple accessor. Any computations needed to create the map should be done ahead of time.

Specified by:

getSyscalls in interface EmuSyscallLibrary<T>

Returns:

the system call map