Package ghidra.trace.database.guest

Interface InternalTracePlatform

All Superinterfaces:

ProgramArchitecture, TracePlatform

All Known Implementing Classes:

DBTraceGuestPlatform, DBTracePlatformManager.DBTraceHostPlatform

public interface InternalTracePlatform
extends TracePlatform, ProgramArchitecture

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REG_MAP_BE
static final String	REG_MAP_LE

Method Summary

Modifier and Type	Method	Description
default TraceLabelSymbol	addRegisterMapOverride(Register register, String objectName)	Add a label the conventionally maps the value of a TraceRegister in the object manager to a register from this platform
default AddressFactory	getAddressFactory()	Get the address factory of the guest platform
default Collection<String>	getConventionalRegisterObjectNames(Register register)	Get the names or indices of the register object for the given platform register
default PathFilter	getConventionalRegisterPath(AddressSpace space, Register register)	Get the expected path where an object defining the register value would be
default PathFilter	getConventionalRegisterPath(TraceObjectSchema schema, KeyPath path, Register register)	Get the expected path where an object defining the register value would be
default PathFilter	getConventionalRegisterPath(TraceObjectSchema schema, KeyPath path, Collection<String> names)	Get the expected path where an object defining the register value would be
default PathFilter	getConventionalRegisterPath(TraceObject container, Register register)	Get the expected path where an object defining the register value would be
default AddressRange	getConventionalRegisterRange(AddressSpace space, Register register)	Translate the given platform register to the given host overlay space
int	getIntKey()	Get the entry's key in the table as an integer
DBTraceGuestPlatform.DBTraceGuestLanguage	getLanguageEntry()
default AddressRange	getRegistersRange()
default List<String>	listRegNames(Register register)
static String	regMap(Register register)

Methods inherited from interface ghidra.program.model.lang.ProgramArchitecture

getCompilerSpec, getLanguage, getLanguageCompilerSpecPair

Methods inherited from interface ghidra.trace.model.guest.TracePlatform

getCompilerSpec, getDataTypeManager, getGuestAddressSet, getHostAddressSet, getLanguage, getMappedMemBuffer, getTrace, isGuest, isHost, mapGuestInstructionAddressesToHost, mapGuestToHost, mapGuestToHost, mapGuestToHost, mapHostToGuest, mapHostToGuest, mapHostToGuest

Field Details

REG_MAP_BE

static final String REG_MAP_BE

See Also:

• Constant Field Values

REG_MAP_LE

static final String REG_MAP_LE

See Also:

• Constant Field Values

Method Details

regMap

static String regMap(Register register)

getIntKey

int getIntKey()

Get the entry's key in the table as an integer

Returns:

the key

getLanguageEntry

DBTraceGuestPlatform.DBTraceGuestLanguage getLanguageEntry()

getAddressFactory

default AddressFactory getAddressFactory()

Description copied from interface: TracePlatform

Get the address factory of the guest platform

Specified by:

getAddressFactory in interface ProgramArchitecture

Specified by:

getAddressFactory in interface TracePlatform

Returns:

the factory

getConventionalRegisterRange

default AddressRange getConventionalRegisterRange(AddressSpace space,
 Register register)

Description copied from interface: TracePlatform

Translate the given platform register to the given host overlay space

Specified by:

getConventionalRegisterRange in interface TracePlatform

Parameters:

space - the overlay space, usually that allocated for a thread or frame

register - the platform register

Returns:

the host range

listRegNames

default List<String> listRegNames(Register register)

getConventionalRegisterObjectNames

default Collection<String> getConventionalRegisterObjectNames(Register register)

Description copied from interface: TracePlatform

Get the names or indices of the register object for the given platform register

This will check for a label in the host physical space, allowing a mapper to specify an alternative register object name. See TracePlatform.addRegisterMapOverride(Register, String). If one exists, then only that name is returned. Otherwise, the given register's names and aliases are all returned as defined and in all-upper and all-lower case.

Specified by:

getConventionalRegisterObjectNames in interface TracePlatform

Parameters:

register - the platform register

Returns:

the mapped name

getConventionalRegisterPath

default PathFilter getConventionalRegisterPath(TraceObjectSchema schema,
 KeyPath path,
 Collection<String> names)

Description copied from interface: TracePlatform

Get the expected path where an object defining the register value would be

Specified by:

getConventionalRegisterPath in interface TracePlatform

Parameters:

schema - the schema of the register container

path - the path to the register container

names - the possible names of the register on the target

Returns:

the path matcher, possibly empty

getConventionalRegisterPath

default PathFilter getConventionalRegisterPath(TraceObjectSchema schema,
 KeyPath path,
 Register register)

Description copied from interface: TracePlatform

Get the expected path where an object defining the register value would be

This will check for a label in the host physical space, allowing a mapper to specify an alternative register object name. See TracePlatform.addRegisterMapOverride(Register, String).

Specified by:

getConventionalRegisterPath in interface TracePlatform

Parameters:

schema - the schema of the register container

path - the path to the register container

register - the platform register

Returns:

the path matcher, possibly empty

getConventionalRegisterPath

default PathFilter getConventionalRegisterPath(TraceObject container,
 Register register)

Description copied from interface: TracePlatform

Get the expected path where an object defining the register value would be

Specified by:

getConventionalRegisterPath in interface TracePlatform

Parameters:

container - the register container

register - the platform register

Returns:

that path matcher, possibly empty, or null if the trace has no root schema

See Also:

• TracePlatform.getConventionalRegisterPath(TraceObjectSchema, KeyPath, Register)

getConventionalRegisterPath

default PathFilter getConventionalRegisterPath(AddressSpace space,
 Register register)

Description copied from interface: TracePlatform

Get the expected path where an object defining the register value would be

Specified by:

getConventionalRegisterPath in interface TracePlatform

Parameters:

space - the overlay space allocated for a thread or frame

register - the platform register

Returns:

the path matcher, or null if there is no root schema

See Also:

• TracePlatform.getConventionalRegisterPath(TraceObjectSchema, KeyPath, Register)

addRegisterMapOverride

default TraceLabelSymbol addRegisterMapOverride(Register register,
 String objectName)

Description copied from interface: TracePlatform

Add a label the conventionally maps the value of a TraceRegister in the object manager to a register from this platform

Specified by:

addRegisterMapOverride in interface TracePlatform

Parameters:

register - the language register

objectName - the name of the TraceRegister in the object tree

Returns:

the label

getRegistersRange

default AddressRange getRegistersRange()