Package ghidra.trace.database.listing

Class DBTraceUndefinedDataView

java.lang.Object

ghidra.trace.database.listing.AbstractBaseDBTraceCodeUnitsView<UndefinedDBTraceData>

ghidra.trace.database.listing.AbstractSingleDBTraceCodeUnitsView<UndefinedDBTraceData>

ghidra.trace.database.listing.DBTraceUndefinedDataView

All Implemented Interfaces:

InternalBaseCodeUnitsView<TraceData>, TraceBaseCodeUnitsView<TraceData>, TraceUndefinedDataView

public class DBTraceUndefinedDataView
extends AbstractSingleDBTraceCodeUnitsView<UndefinedDBTraceData>
implements TraceUndefinedDataView, InternalBaseCodeUnitsView<TraceData>

The implementation of TraceCodeOperations.undefinedData()

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<Long,CachedAddressSetView>	cache
protected static final int	CACHE_MAX_SNAPS
protected final DBTraceCodeManager	manager

Fields inherited from class ghidra.trace.database.listing.AbstractBaseDBTraceCodeUnitsView

space

Constructor Summary

Constructors

Constructor	Description
DBTraceUndefinedDataView(DBTraceCodeSpace space)	Construct the view

Method Summary

Modifier and Type	Method	Description
boolean	containsAddress(long snap, Address address)	Check if the given address is contained by a live unit
boolean	coversRange(Lifespan lifespan, AddressRange range)	Check if the given span of snaps and range of addresses is covered by the units
protected UndefinedDBTraceData	doCreateUnit(long snap, Address address)	Generate an undefined data unit at the given point
protected AddressSetView	doGetAddressSetView(long snap)	Get an address set view for optimizing various queries
Iterable<? extends UndefinedDBTraceData>	get(long snap, Address min, Address max, boolean forward)	Get the live units whose start addresses are within the specified range
AddressSetView	getAddressSetView(long snap, AddressRange within)	Get all addresses contained by live units at the given snap, within a restricted range
UndefinedDBTraceData	getAt(long snap, Address address)	Get the unit starting at exactly this address Note that the unit need only contain the given snap
UndefinedDBTraceData	getCeiling(long snap, Address address)	Get the nearest live unit whose start address is at or after the given address
UndefinedDBTraceData	getContaining(long snap, Address address)	Get the live unit containing the given address
UndefinedDBTraceData	getFloor(long snap, Address address)	Get the nearest live unit whose start address is at or before the given address
Iterable<? extends UndefinedDBTraceData>	getIntersecting(TraceAddressSnapRange tasr)	Get the units which intersect the given box, in no particular order
boolean	intersectsRange(Lifespan lifespan, AddressRange range)	Check if the given span of snaps and range of addresses intersects any unit
void	invalidateCache()	Invalidate the cache of generated undefined units
int	size()	Get the total number of defined units in this view

Methods inherited from class ghidra.trace.database.listing.AbstractBaseDBTraceCodeUnitsView

coversRange, get, get, get, get, getAddressSetView, getAddressSpace, getAfter, getBefore, getSpace, getTrace, intersectsRange

Methods inherited from class java.lang.Object

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

Methods inherited from interface ghidra.trace.database.listing.InternalBaseCodeUnitsView

get, getContaining, getForRegister, getSpace

Methods inherited from interface ghidra.trace.model.listing.TraceBaseCodeUnitsView

coversRange, get, get, get, get, get, getAddressSetView, getAfter, getBefore, getContaining, getForRegister, getTrace, intersectsRange

Field Details

CACHE_MAX_SNAPS

protected static final int CACHE_MAX_SNAPS

See Also:

• Constant Field Values

manager

protected final DBTraceCodeManager manager

cache

protected final Map<Long,CachedAddressSetView> cache

Constructor Details

DBTraceUndefinedDataView

public DBTraceUndefinedDataView(DBTraceCodeSpace space)

Construct the view

Parameters:

space - the space, bound to an address space

Method Details

doCreateUnit

protected UndefinedDBTraceData doCreateUnit(long snap,
 Address address)

Generate an undefined data unit at the given point

Parameters:

snap - the snap of the unit

address - the address of the unit

Returns:

the unit

size

public int size()

Description copied from interface: TraceBaseCodeUnitsView

Get the total number of defined units in this view

Specified by:

size in interface TraceBaseCodeUnitsView<TraceData>

Specified by:

size in class AbstractBaseDBTraceCodeUnitsView<UndefinedDBTraceData>

Returns:

the size

See Also:

• TraceBaseCodeUnitsView.size()

doGetAddressSetView

protected AddressSetView doGetAddressSetView(long snap)

Get an address set view for optimizing various queries

As its code may suggest, this creates the lazy address set view all - definedUnits, and wraps it in a cached address set view.

Parameters:

snap - the snapshot key for the address set

Returns:

the address set

containsAddress

public boolean containsAddress(long snap,
 Address address)

Description copied from interface: TraceBaseCodeUnitsView

Check if the given address is contained by a live unit

Specified by:

containsAddress in interface TraceBaseCodeUnitsView<TraceData>

Specified by:

containsAddress in class AbstractBaseDBTraceCodeUnitsView<UndefinedDBTraceData>

Parameters:

snap - the snap during which the unit must be alive

address - the address to check

Returns:

true if it is contained, false if not

See Also:

• TraceBaseCodeUnitsView.containsAddress(long, Address)

coversRange

public boolean coversRange(Lifespan lifespan,
 AddressRange range)

Description copied from interface: TraceBaseCodeUnitsView

Check if the given span of snaps and range of addresses is covered by the units

This checks if every (snap, address) point within the given box is contained within some code unit in this view.

Specified by:

coversRange in interface TraceBaseCodeUnitsView<TraceData>

Specified by:

coversRange in class AbstractBaseDBTraceCodeUnitsView<UndefinedDBTraceData>

Parameters:

lifespan - the span of snaps

range - the address range

Returns:

true if covered, false otherwise

See Also:

• TraceBaseCodeUnitsView.coversRange(Lifespan, AddressRange)

intersectsRange

public boolean intersectsRange(Lifespan lifespan,
 AddressRange range)

Description copied from interface: TraceBaseCodeUnitsView

Check if the given span of snaps and range of addresses intersects any unit

This checks if any (snap, address) point within the given box is contained within some code unit in this view.

Specified by:

intersectsRange in interface TraceBaseCodeUnitsView<TraceData>

Specified by:

intersectsRange in class AbstractBaseDBTraceCodeUnitsView<UndefinedDBTraceData>

Parameters:

lifespan - the span of snaps

range - the address range

Returns:

true if intersecting, false otherwise

See Also:

• TraceBaseCodeUnitsView.intersectsRange(Lifespan, AddressRange)

getFloor

public UndefinedDBTraceData getFloor(long snap,
 Address address)

Description copied from interface: TraceBaseCodeUnitsView

Get the nearest live unit whose start address is at or before the given address

Specified by:

getFloor in interface TraceBaseCodeUnitsView<TraceData>

Specified by:

getFloor in class AbstractBaseDBTraceCodeUnitsView<UndefinedDBTraceData>

Parameters:

snap - the snap during which the unit must be alive

address - the address which the unit's start must equal or precede

Returns:

the code unit, or null if it doesn't exist

See Also:

• TraceBaseCodeUnitsView.getFloor(long, Address)

getContaining

public UndefinedDBTraceData getContaining(long snap,
 Address address)

Description copied from interface: TraceBaseCodeUnitsView

Get the live unit containing the given address

Specified by:

getContaining in interface TraceBaseCodeUnitsView<TraceData>

Specified by:

getContaining in class AbstractBaseDBTraceCodeUnitsView<UndefinedDBTraceData>

Parameters:

snap - the snap during which the unit must be alive

address - the address which the unit must contain

Returns:

the code unit, or null if it doesn't exist

See Also:

• TraceBaseCodeUnitsView.getContaining(long, Address)

getAt

public UndefinedDBTraceData getAt(long snap,
 Address address)

Description copied from interface: TraceBaseCodeUnitsView

Get the unit starting at exactly this address Note that the unit need only contain the given snap

Specified by:

getAt in interface TraceBaseCodeUnitsView<TraceData>

Specified by:

getAt in class AbstractBaseDBTraceCodeUnitsView<UndefinedDBTraceData>

Parameters:

snap - the snap during which the unit must be alive

address - the unit's start address

Returns:

the code unit, or null if it doesn't exist

See Also:

• TraceBaseCodeUnitsView.getAt(long, Address)

getCeiling

public UndefinedDBTraceData getCeiling(long snap,
 Address address)

Description copied from interface: TraceBaseCodeUnitsView

Get the nearest live unit whose start address is at or after the given address

Specified by:

getCeiling in interface TraceBaseCodeUnitsView<TraceData>

Specified by:

getCeiling in class AbstractBaseDBTraceCodeUnitsView<UndefinedDBTraceData>

Parameters:

snap - the snap during which the unit must be alive

address - the address which the unit's start must equal or follow

Returns:

the code unit, or null if it doesn't exist

See Also:

• TraceBaseCodeUnitsView.getCeiling(long, Address)

get

public Iterable<? extends UndefinedDBTraceData> get(long snap,
 Address min,
 Address max,
 boolean forward)

Description copied from interface: TraceBaseCodeUnitsView

Get the live units whose start addresses are within the specified range

Specified by:

get in interface TraceBaseCodeUnitsView<TraceData>

Specified by:

get in class AbstractBaseDBTraceCodeUnitsView<UndefinedDBTraceData>

Parameters:

snap - the snap during which the units must be alive

min - the minimum start address, inclusive

max - the maximum start address, inclusive

forward - true to order the units by increasing address, false for descending

Returns:

the iterable of units

See Also:

• TraceBaseCodeUnitsView.get(long, Address, Address, boolean)

getIntersecting

public Iterable<? extends UndefinedDBTraceData> getIntersecting(TraceAddressSnapRange tasr)

Description copied from interface: TraceBaseCodeUnitsView

Get the units which intersect the given box, in no particular order

Specified by:

getIntersecting in interface TraceBaseCodeUnitsView<TraceData>

Specified by:

getIntersecting in class AbstractBaseDBTraceCodeUnitsView<UndefinedDBTraceData>

Parameters:

tasr - the box (snap range by address range)

Returns:

an iterable over the intersecting units

See Also:

• TraceBaseCodeUnitsView.getIntersecting(TraceAddressSnapRange)

getAddressSetView

public AddressSetView getAddressSetView(long snap,
 AddressRange within)

Description copied from interface: TraceBaseCodeUnitsView

Get all addresses contained by live units at the given snap, within a restricted range

Note that the ranges in this set may not be coalesced. If a coalesced set is required, wrap it with UnionAddressSetView. The returned ranges are not necessarily enclosed by within, but they will intersect it. If strict enclosure is required, wrap the set with IntersectionAddressSetView.

Specified by:

getAddressSetView in interface TraceBaseCodeUnitsView<TraceData>

Specified by:

getAddressSetView in class AbstractBaseDBTraceCodeUnitsView<UndefinedDBTraceData>

Parameters:

snap - the snap during which the units must be alive

within - the range to restrict the view

Returns:

a (lazy) view of the address set

See Also:

• TraceBaseCodeUnitsView.getAddressSetView(long, AddressRange)

invalidateCache

public void invalidateCache()

Invalidate the cache of generated undefined units