Package ghidra.trace.database.listing

Class AbstractBaseDBTraceCodeUnitsMemoryView<T extends DBTraceCodeUnitAdapter,M extends AbstractBaseDBTraceCodeUnitsView<T>>

java.lang.Object

ghidra.trace.database.listing.AbstractBaseDBTraceCodeUnitsMemoryView<T,M>

Type Parameters:

T - the implementation type of the units contained in the view

M - the implementation type of the views being composed

All Implemented Interfaces:

DBTraceDelegatingManager<M>

Direct Known Subclasses:

AbstractWithUndefinedDBTraceCodeUnitsMemoryView, DBTraceDefinedDataMemoryView, DBTraceDefinedUnitsMemoryView, DBTraceInstructionsMemoryView

public abstract class AbstractBaseDBTraceCodeUnitsMemoryView<T extends DBTraceCodeUnitAdapter,M extends AbstractBaseDBTraceCodeUnitsView<T>>
extends Object
implements DBTraceDelegatingManager<M>

An abstract implementation of TraceBaseCodeUnitsView for composing views of many address spaces

Nested Class Summary

Nested classes/interfaces inherited from interface ghidra.trace.database.space.DBTraceDelegatingManager

DBTraceDelegatingManager.ExcConsumer<T,E extends Throwable>, DBTraceDelegatingManager.ExcFunction<T,R,E extends Throwable>, DBTraceDelegatingManager.ExcPredicate<T,E extends Throwable>, DBTraceDelegatingManager.ExcSupplier<T,E extends Throwable>

Field Summary

Fields

Modifier and Type	Field	Description
protected final DBTraceCodeManager	manager

Constructor Summary

Constructors

Constructor	Description
AbstractBaseDBTraceCodeUnitsMemoryView(DBTraceCodeManager manager)	Construct a composite view

Method Summary

Modifier and Type	Method	Description
boolean	containsAddress(long snap, Address address)
boolean	coversRange(Lifespan span, AddressRange range)
boolean	coversRange(TraceAddressSnapRange range)
protected AddressSetView	emptyOrFullAddressSetUndefined(AddressRange within)	The address set when there is no view or space for the given range's space
Iterable<? extends T>	emptyOrFullIterableUndefined(long snap, AddressRange range, boolean forward)	The result of iteration when there is no view or space for the given range's space
Iterable<? extends T>	emptyOrFullIterableUndefined(TraceAddressSnapRange tasr)
protected boolean	falseOrTrueUndefined()	The result of contains, covers, or intersects when there is no view or space for an address space
Iterable<? extends T>	get(long snap, boolean forward)
Iterable<? extends T>	get(long snap, Address start, boolean forward)
Iterable<? extends T>	get(long snap, AddressRange range, boolean forward)
Iterable<? extends T>	get(long snap, Address min, Address max, boolean forward)
Iterable<? extends T>	get(long snap, AddressSetView set, boolean forward)
AddressSetView	getAddressSetView(long snap)
AddressSetView	getAddressSetView(long snap, AddressRange within)
T	getAfter(long snap, Address address)
T	getAt(long snap, Address address)
T	getBefore(long snap, Address address)
T	getCeiling(long snap, Address address)
T	getContaining(long snap, Address address)
T	getFloor(long snap, Address address)
M	getForSpace(AddressSpace space, boolean createIfAbsent)
Iterable<? extends T>	getIntersecting(TraceAddressSnapRange tasr)
AddressSpace	getSpace()
Trace	getTrace()
protected abstract M	getView(DBTraceCodeSpace space)	Get the individual view from the given space
boolean	intersectsRange(Lifespan span, AddressRange range)
boolean	intersectsRange(TraceAddressSnapRange range)
protected Address	nextAddress(Address address)	Compute the address following the given
protected T	nullOrUndefined(long snap, Address address)	Create the appropriate unit (possibly caching) when there is no view or space for the given address's space
protected Address	prevAddress(Address address)	Compute the address preceding the given
Lock	readLock()
int	size()
Lock	writeLock()

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.space.DBTraceDelegatingManager

checkIsInMemory, delegateAddressSet, delegateAny, delegateCollection, delegateDeleteB, delegateDeleteV, delegateFirst, delegateHashSet, delegateRead, delegateRead, delegateReadB, delegateReadI, delegateReadI, delegateReadOr, delegateWrite, delegateWriteAll, delegateWriteI, delegateWriteV

Field Details

manager

protected final DBTraceCodeManager manager

Constructor Details

AbstractBaseDBTraceCodeUnitsMemoryView

public AbstractBaseDBTraceCodeUnitsMemoryView(DBTraceCodeManager manager)

Construct a composite view

Parameters:

manager - the code manager, from which individual views are retrieved

Method Details

getSpace

public AddressSpace getSpace()

getTrace

public Trace getTrace()

Returns:

the trace

See Also:

• TraceBaseCodeUnitsView.getTrace()

getView

protected abstract M getView(DBTraceCodeSpace space)

Get the individual view from the given space

Parameters:

space - the space, bound to a specific address space

Returns:

the view

nullOrUndefined

protected T nullOrUndefined(long snap,
 Address address)

Create the appropriate unit (possibly caching) when there is no view or space for the given address's space

Views composing undefined units should generate (possibly delegating to a view) an undefined unit. Others should leave this null.

Parameters:

snap - the snap the client requested

address - the address the client requested

Returns:

the unit or null

emptyOrFullAddressSetUndefined

protected AddressSetView emptyOrFullAddressSetUndefined(AddressRange within)

The address set when there is no view or space for the given range's space

Views composing undefined units should return the whole range. Others should leave this empty.

Parameters:

within - the range the client requested

Returns:

the full range or empty

falseOrTrueUndefined

protected boolean falseOrTrueUndefined()

The result of contains, covers, or intersects when there is no view or space for an address space

Views composing undefined units should return true, since the address is known to be in an unpopulated space. Others should leave this false.

Returns:

true if an undefined unit implicitly contains the address, false otherwise.

emptyOrFullIterableUndefined

public Iterable<? extends T> emptyOrFullIterableUndefined(long snap,
 AddressRange range,
 boolean forward)

The result of iteration when there is no view or space for the given range's space

Views composing undefiend units should return an iterable that generates (possibly caching) undefined units. Others should leave this empty.

Parameters:

snap - the snap the client requested

range - the range of iteration

forward - true to iterate forward (min to max), false for backward (max to min)

Returns:

an iterable of units

emptyOrFullIterableUndefined

public Iterable<? extends T> emptyOrFullIterableUndefined(TraceAddressSnapRange tasr)

Parameters:

tasr - the range of space and time to cover

Returns:

the iterable

See Also:

• emptyOrFullIterableUndefined(long, AddressRange, boolean)

readLock

public Lock readLock()

Specified by:

readLock in interface DBTraceDelegatingManager<T extends DBTraceCodeUnitAdapter>

writeLock

public Lock writeLock()

Specified by:

writeLock in interface DBTraceDelegatingManager<T extends DBTraceCodeUnitAdapter>

getForSpace

public M getForSpace(AddressSpace space,
 boolean createIfAbsent)

Specified by:

getForSpace in interface DBTraceDelegatingManager<T extends DBTraceCodeUnitAdapter>

prevAddress

protected Address prevAddress(Address address)

Compute the address preceding the given

If this address is the minimum in its space, then this will choose the maximum address of the previous space, if it exists.

Parameters:

address - the address

Returns:

the previous address or null

nextAddress

protected Address nextAddress(Address address)

Compute the address following the given

If the address is the maximum in its space, then this will choose the minimum address of the next space, if it exists.

Returns:

the next address or null

size

public int size()

Returns:

the number of defined units

See Also:

• TraceBaseCodeUnitsView.size()

getBefore

public T getBefore(long snap,
 Address address)

Parameters:

snap - the snap

address - the address

Returns:

the unit or null

See Also:

• TraceBaseCodeUnitsView.getBefore(long, Address)

getFloor

public T getFloor(long snap,
 Address address)

Parameters:

snap - the snap

address - the address

Returns:

the unit or null

See Also:

• TraceBaseCodeUnitsView.getFloor(long, Address)

getContaining

public T getContaining(long snap,
 Address address)

Parameters:

snap - the snap

address - the address

Returns:

the unit or null

See Also:

• TraceBaseCodeUnitsView.getContaining(long, Address)

getAt

public T getAt(long snap,
 Address address)

Parameters:

snap - the snap

address - the address

Returns:

the unit or null

See Also:

• TraceBaseCodeUnitsView.getAt(long, Address)

getCeiling

public T getCeiling(long snap,
 Address address)

Parameters:

snap - the snap

address - the address

Returns:

the unit or null

See Also:

• TraceBaseCodeUnitsView.getCeiling(long, Address)

getAfter

public T getAfter(long snap,
 Address address)

Parameters:

snap - the snap

address - the address

Returns:

the unit or null

See Also:

• TraceBaseCodeUnitsView.getAfter(long, Address)

get

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

Parameters:

snap - the snap

min - the min address

max - the max address

forward - true to iterate forward

Returns:

an iterable of units

See Also:

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

get

public Iterable<? extends T> get(long snap,
 AddressSetView set,
 boolean forward)

Parameters:

snap - the snap

set - the address set

forward - true to iterate forward

Returns:

an iterable of units

See Also:

• TraceBaseCodeUnitsView.get(long, AddressSetView, boolean)

get

public Iterable<? extends T> get(long snap,
 AddressRange range,
 boolean forward)

Parameters:

snap - the snap

range - the address range

forward - true to iterate forward

Returns:

an iterable of units

See Also:

• TraceBaseCodeUnitsView.get(long, AddressRange, boolean)

get

public Iterable<? extends T> get(long snap,
 Address start,
 boolean forward)

Parameters:

snap - the snap

start - the start address

forward - true to iterate forward

Returns:

an iterable of units

See Also:

• TraceBaseCodeUnitsView.get(long, Address, boolean)

get

public Iterable<? extends T> get(long snap,
 boolean forward)

Parameters:

snap - the snap

forward - true to iterate forward

Returns:

an iterable of units

See Also:

• TraceBaseCodeUnitsView.get(long, boolean)

getIntersecting

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

Parameters:

tasr - the range in space and time to cover

Returns:

an iterable of units

See Also:

• TraceBaseCodeUnitsView.getIntersecting(TraceAddressSnapRange)

getAddressSetView

public AddressSetView getAddressSetView(long snap,
 AddressRange within)

Parameters:

snap - the snap

within - the range to consider

Returns:

the address set

See Also:

• TraceBaseCodeUnitsView.getAddressSetView(long, AddressRange)

getAddressSetView

public AddressSetView getAddressSetView(long snap)

Parameters:

snap - the snap

Returns:

the address set

See Also:

• TraceBaseCodeUnitsView.getAddressSetView(long)

containsAddress

public boolean containsAddress(long snap,
 Address address)

Parameters:

snap - the snap

address - the address

Returns:

true if contained

See Also:

• TraceBaseCodeUnitsView.containsAddress(long, Address)

coversRange

public boolean coversRange(Lifespan span,
 AddressRange range)

Parameters:

span - the span

range - the range

Returns:

true if covered

See Also:

• TraceBaseCodeUnitsView.coversRange(Lifespan, AddressRange)

coversRange

public boolean coversRange(TraceAddressSnapRange range)

Parameters:

range - the range in space and time

Returns:

true if covered

See Also:

• TraceBaseCodeUnitsView.coversRange(TraceAddressSnapRange)

intersectsRange

public boolean intersectsRange(Lifespan span,
 AddressRange range)

Parameters:

span - the span

range - the range

Returns:

true if intersected

See Also:

• TraceBaseCodeUnitsView.intersectsRange(Lifespan, AddressRange)

intersectsRange

public boolean intersectsRange(TraceAddressSnapRange range)

Parameters:

range - the range in space and time

Returns:

true if intersected

See Also:

• TraceBaseCodeUnitsView.intersectsRange(TraceAddressSnapRange)