Package ghidra.trace.database.module

Class DBTraceStaticMapping

java.lang.Object

ghidra.program.database.DatabaseObject

ghidra.util.database.DBAnnotatedObject

ghidra.trace.database.module.DBTraceStaticMapping

All Implemented Interfaces:

DBTraceOverlaySpaceAdapter.DecodesAddresses, TraceStaticMapping, TraceUniqueObject

public class DBTraceStaticMapping
extends DBAnnotatedObject
implements TraceStaticMapping, DBTraceOverlaySpaceAdapter.DecodesAddresses

The implementation of a static mapping, directly via a database object

Version history:

• 1: Change traceAddress to 10-byte fixed encoding
• 0: Initial version and previous unversioned implementation

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TABLE_NAME

Fields inherited from class ghidra.program.database.DatabaseObject

key

Constructor Summary

Constructors

Constructor	Description
DBTraceStaticMapping(DBTraceStaticMappingManager manager, DBCachedObjectStore<?> store, DBRecord record)

Method Summary

Modifier and Type	Method	Description
boolean	conflictsWith(AddressRange range, Lifespan lifespan, URL toProgramURL, String toAddress)	Check if this mapping would conflict with the given prospective mapping
void	delete()	Remove this mapping from the "from" trace
protected void	fresh(boolean created)	Extension point: Called when the object's fields are populated.
long	getEndSnap()	Get the ending snap of the lifespan
long	getLength()	Get the length of the mapping, i.e., the length of the range
Lifespan	getLifespan()	Get the span of time of the mapping
Address	getMaxTraceAddress()	Get the "from" range's maximum address
Address	getMinTraceAddress()	Get the "from" range's minimum address
DBTraceOverlaySpaceAdapter	getOverlaySpaceAdapter()	Get the space adapter for the trace containing the object
long	getShift()	Get the shift in offset from static program to dynamic trace
long	getStartSnap()	Get the starting snap of the lifespan
String	getStaticAddress()	Get the "to" address range's minimum address, as a string
URL	getStaticProgramURL()	Get the Ghidra URL of the "to" Program, i.e., static image
Trace	getTrace()	Get the "from" trace, i.e., the trace containing this mapping
AddressRange	getTraceAddressRange()	Get the "from" range
protected static long	parseOffset(String addrStr)
protected static String	parseSpace(String addrStr)
String	toString()

Methods inherited from class ghidra.util.database.DBAnnotatedObject

doRefresh, doUpdateAll, doUpdated, doWrite, getObjectKey, getTableName, isDeleted, refresh, refresh, update, update, update, update

Methods inherited from class ghidra.program.database.DatabaseObject

checkDeleted, checkIsValid, checkIsValid, getKey, isDeleted, isInvalid, keyChanged, setDeleted, setInvalid, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface ghidra.trace.model.TraceUniqueObject

getObjectKey, isDeleted

Field Details

TABLE_NAME

public static final String TABLE_NAME

See Also:

• Constant Field Values

Constructor Details

DBTraceStaticMapping

public DBTraceStaticMapping(DBTraceStaticMappingManager manager,
 DBCachedObjectStore<?> store,
 DBRecord record)

Method Details

parseSpace

protected static String parseSpace(String addrStr)

parseOffset

protected static long parseOffset(String addrStr)

toString

public String toString()

Overrides:

toString in class Object

fresh

protected void fresh(boolean created)
              throws IOException

Description copied from class: DBAnnotatedObject

Extension point: Called when the object's fields are populated.

This provides an opportunity for the object to initialize any non-database-backed fields that depend on the database-backed fields. Note that its use may indicate a situation better solved by a custom DBCachedObjectStoreFactory.DBFieldCodec. If both the database-backed and non-database-backed fields are used frequently, then a codec may not be indicated. If the database-backed fields are only used in this method or to encode another frequently-used field, then a codec is likely better.

For a new object, the database-backed fields remain at their initial values. They will be saved after this method returns, so they may be further initialized with custom logic.

For an object loaded from the database, the database-backed fields are already populated from the record when this method is called. They are not automatically saved after this method returns. This method should not further initialize database-backed fields in this case.

Overrides:

fresh in class DBAnnotatedObject

Parameters:

created - true when object is being created, or false when it is being loaded.

Throws:

IOException - if further initialization fails.

getOverlaySpaceAdapter

public DBTraceOverlaySpaceAdapter getOverlaySpaceAdapter()

Description copied from interface: DBTraceOverlaySpaceAdapter.DecodesAddresses

Get the space adapter for the trace containing the object

Specified by:

getOverlaySpaceAdapter in interface DBTraceOverlaySpaceAdapter.DecodesAddresses

Returns:

the adapter

getTrace

public Trace getTrace()

Description copied from interface: TraceStaticMapping

Get the "from" trace, i.e., the trace containing this mapping

Specified by:

getTrace in interface TraceStaticMapping

Returns:

the trace

getTraceAddressRange

public AddressRange getTraceAddressRange()

Description copied from interface: TraceStaticMapping

Get the "from" range

Specified by:

getTraceAddressRange in interface TraceStaticMapping

Returns:

the range

getMinTraceAddress

public Address getMinTraceAddress()

Description copied from interface: TraceStaticMapping

Get the "from" range's minimum address

Specified by:

getMinTraceAddress in interface TraceStaticMapping

Returns:

the minimum address

getMaxTraceAddress

public Address getMaxTraceAddress()

Description copied from interface: TraceStaticMapping

Get the "from" range's maximum address

Specified by:

getMaxTraceAddress in interface TraceStaticMapping

Returns:

the maximum address

getLength

public long getLength()

Description copied from interface: TraceStaticMapping

Get the length of the mapping, i.e., the length of the range

Specified by:

getLength in interface TraceStaticMapping

Returns:

the length, where 0 indicates 1 << 64

getShift

public long getShift()

Description copied from interface: TraceStaticMapping

Get the shift in offset from static program to dynamic trace

Specified by:

getShift in interface TraceStaticMapping

Returns:

the shift

getLifespan

public Lifespan getLifespan()

Description copied from interface: TraceStaticMapping

Get the span of time of the mapping

Specified by:

getLifespan in interface TraceStaticMapping

Returns:

the lifespan

getStartSnap

public long getStartSnap()

Description copied from interface: TraceStaticMapping

Get the starting snap of the lifespan

Specified by:

getStartSnap in interface TraceStaticMapping

Returns:

the start snap

getEndSnap

public long getEndSnap()

Description copied from interface: TraceStaticMapping

Get the ending snap of the lifespan

Specified by:

getEndSnap in interface TraceStaticMapping

Returns:

the end snap

getStaticProgramURL

public URL getStaticProgramURL()

Description copied from interface: TraceStaticMapping

Get the Ghidra URL of the "to" Program, i.e., static image

Specified by:

getStaticProgramURL in interface TraceStaticMapping

Returns:

the program URL

getStaticAddress

public String getStaticAddress()

Description copied from interface: TraceStaticMapping

Get the "to" address range's minimum address, as a string

Specified by:

getStaticAddress in interface TraceStaticMapping

Returns:

the address string

delete

public void delete()

Description copied from interface: TraceStaticMapping

Remove this mapping from the "from" trace

Specified by:

delete in interface TraceStaticMapping

conflictsWith

public boolean conflictsWith(AddressRange range,
 Lifespan lifespan,
 URL toProgramURL,
 String toAddress)

Description copied from interface: TraceStaticMapping

Check if this mapping would conflict with the given prospective mapping

Specified by:

conflictsWith in interface TraceStaticMapping

Parameters:

range - the range in the trace ("from")

lifespan - the span of time in the trace

toProgramURL - the (Ghidra) URL of the static image ("to")

toAddress - the starting address (in string form) in the staic image ("to")

Returns:

true if this mapping conflicts.

See Also:

• TraceStaticMappingManager.findAnyConflicting(AddressRange, Lifespan, URL, String)