Package ghidra.pcode.exec.trace.data

Class AbstractPcodeTraceDataAccess

java.lang.Object

ghidra.pcode.exec.trace.data.AbstractPcodeTraceDataAccess

All Implemented Interfaces:

InternalPcodeTraceDataAccess, PcodeTraceDataAccess

Direct Known Subclasses:

DefaultPcodeTraceMemoryAccess, DefaultPcodeTraceRegistersAccess

public abstract class AbstractPcodeTraceDataAccess
extends Object
implements InternalPcodeTraceDataAccess

An abstract data-access shim, for either memory or registers

Field Summary

Fields

Modifier and Type	Field	Description
protected final TraceMemoryManager	mm
protected final TracePlatform	platform
protected final long	snap
protected final TraceTimeViewport	viewport

Constructor Summary

Constructors

Constructor	Description
AbstractPcodeTraceDataAccess(TracePlatform platform, long snap, TraceTimeViewport viewport)	Construct a shim

Method Summary

Modifier and Type	Method	Description
int	getBytes(Address start, ByteBuffer buf)	Read bytes from the trace
Language	getLanguage()	Get the language of the associated platform
protected abstract TraceMemoryOperations	getMemoryOps(boolean createIfAbsent)	Get the interface for accessing trace memory or registers
TracePlatform	getPlatform()
<T> PcodeTracePropertyAccess<T>	getPropertyAccess(String name, Class<T> type)	Get a property-access shim for the named property
long	getSnap()
TraceTimeViewport	getViewport()
TraceMemoryState	getViewportState(AddressRange guestRange)	Get the composite state of an address range, using the snapshot's viewport
AddressSetView	intersectUnknown(AddressSetView guestView)	Compute the intersection of the given address set and the set of TraceMemoryState.UNKNOWN memory
AddressSetView	intersectViewKnown(AddressSetView guestView, boolean useFullSpans)	Compute the intersection of the given address set and the set of TraceMemoryState.KNOWN or (@link TraceMemoryState.ERROR memory
int	putBytes(Address start, ByteBuffer buf)	Write bytes into the trace
void	setState(AddressRange guestRange, TraceMemoryState state)	Set the memory state of an address range
protected abstract Address	toOverlay(Address address)	If this shim is associated with a (register) overlay space, translate the given address into it
protected abstract AddressRange	toOverlay(AddressRange range)
protected abstract AddressSetView	toOverlay(AddressSetView set)
Address	translate(Address address)	Translate the given emulator address to a host/overlay address

Methods inherited from class java.lang.Object

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

Methods inherited from interface ghidra.pcode.exec.trace.data.InternalPcodeTraceDataAccess

getPropertyOps

Field Details

platform

protected final TracePlatform platform

snap

protected final long snap

viewport

protected final TraceTimeViewport viewport

mm

protected final TraceMemoryManager mm

Constructor Details

AbstractPcodeTraceDataAccess

public AbstractPcodeTraceDataAccess(TracePlatform platform,
 long snap,
 TraceTimeViewport viewport)

Construct a shim

Parameters:

platform - the associated platform

snap - the associated snap

viewport - the viewport, set to the same snapshot

Method Details

getViewport

public TraceTimeViewport getViewport()

Specified by:

getViewport in interface InternalPcodeTraceDataAccess

getLanguage

public Language getLanguage()

Description copied from interface: PcodeTraceDataAccess

Get the language of the associated platform

Specified by:

getLanguage in interface PcodeTraceDataAccess

Returns:

the language

getPlatform

public TracePlatform getPlatform()

Specified by:

getPlatform in interface InternalPcodeTraceDataAccess

getSnap

public long getSnap()

Specified by:

getSnap in interface InternalPcodeTraceDataAccess

getMemoryOps

protected abstract TraceMemoryOperations getMemoryOps(boolean createIfAbsent)

Get the interface for accessing trace memory or registers

Parameters:

createIfAbsent - in the case of registers, whether to create the missing space

Returns:

the operations, or null

toOverlay

protected abstract Address toOverlay(Address address)

If this shim is associated with a (register) overlay space, translate the given address into it

Parameters:

address - the physical (register) address

Returns:

the overlay address

toOverlay

protected abstract AddressRange toOverlay(AddressRange range)

Parameters:

range - the physical range

Returns:

the overlay range

See Also:

• toOverlay(Address)

toOverlay

protected abstract AddressSetView toOverlay(AddressSetView set)

Parameters:

set -

Returns:

See Also:

• toOverlay(Address)

setState

public void setState(AddressRange guestRange,
 TraceMemoryState state)

Description copied from interface: PcodeTraceDataAccess

Set the memory state of an address range

The state is set only for the destination snapshot. It is not effective for the indefinite future.

Specified by:

setState in interface PcodeTraceDataAccess

Parameters:

guestRange - the range

state - the desired state

getViewportState

public TraceMemoryState getViewportState(AddressRange guestRange)

Description copied from interface: PcodeTraceDataAccess

Get the composite state of an address range, using the snapshot's viewport

Typically, the viewport is at most 2 snapshots deep. When reading from a captured snapshot, the viewport includes only the source snapshot. When reading from scratch snapshot (usually generated by emulation), the viewport includes that scratch snapshot and the original source snapshot. The TraceMemoryState.KNOWN address set is the union of known address sets among all snapshots in the viewport. If all addresses in the given range are TraceMemoryState.KNOWN, then the composite state is known. Otherwise, the composite state is TraceMemoryState.UNKNOWN.

Specified by:

getViewportState in interface PcodeTraceDataAccess

Parameters:

guestRange - the range to check

Returns:

the composite state of the range

intersectViewKnown

public AddressSetView intersectViewKnown(AddressSetView guestView,
 boolean useFullSpans)

Description copied from interface: PcodeTraceDataAccess

Compute the intersection of the given address set and the set of TraceMemoryState.KNOWN or (@link TraceMemoryState.ERROR memory

Specified by:

intersectViewKnown in interface PcodeTraceDataAccess

Parameters:

guestView - the address set

useFullSpans - how to treat the viewport; true for ever known, false for known now.

Returns:

the intersection

intersectUnknown

public AddressSetView intersectUnknown(AddressSetView guestView)

Description copied from interface: PcodeTraceDataAccess

Compute the intersection of the given address set and the set of TraceMemoryState.UNKNOWN memory

Specified by:

intersectUnknown in interface PcodeTraceDataAccess

Parameters:

guestView - the address set

Returns:

the intersection

putBytes

public int putBytes(Address start,
 ByteBuffer buf)

Description copied from interface: PcodeTraceDataAccess

Write bytes into the trace

Each written byte is effective for future snapshots up to but excluding the next snapshot where another byte is written at the same address.

Specified by:

putBytes in interface PcodeTraceDataAccess

Parameters:

start - the address of the first byte to write

buf - a buffer of bytes to write

Returns:

the number of bytes written

getBytes

public int getBytes(Address start,
 ByteBuffer buf)

Description copied from interface: PcodeTraceDataAccess

Read bytes from the trace

Specified by:

getBytes in interface PcodeTraceDataAccess

Parameters:

start - the address of the first byte to read

buf - a buffer to receive the bytes

Returns:

the number of bytes read

translate

public Address translate(Address address)

Description copied from interface: PcodeTraceDataAccess

Translate the given emulator address to a host/overlay address

Specified by:

translate in interface PcodeTraceDataAccess

Parameters:

address - the emulator address

Returns:

the host/overlay address

getPropertyAccess

public <T> PcodeTracePropertyAccess<T> getPropertyAccess(String name,
 Class<T> type)

Description copied from interface: PcodeTraceDataAccess

Get a property-access shim for the named property

Specified by:

getPropertyAccess in interface PcodeTraceDataAccess

Type Parameters:

T - the type of the property's values

Parameters:

name - the name of the property

type - the class of the property's values

Returns:

the access shim