Package ghidra.trace.database.map

Class AbstractDBTracePropertyMap<T,DR extends DBTraceAddressSnapRangePropertyMapTree.AbstractDBTraceAddressSnapRangePropertyMapData<T>>

java.lang.Object

ghidra.trace.database.space.AbstractDBTraceSpaceBasedManager<DBTraceAddressSnapRangePropertyMapSpace<T,DR>>

ghidra.trace.database.map.DBTraceAddressSnapRangePropertyMap<T,DR>

ghidra.trace.database.map.AbstractDBTracePropertyMap<T,DR>

All Implemented Interfaces:

ErrorHandler, DBTraceManager, DBTraceDelegatingManager<DBTraceAddressSnapRangePropertyMapSpace<T,DR>>, TraceAddressSnapRangePropertyMap<T>, TraceAddressSnapRangePropertyMapOperations<T>, TracePropertyMap<T>, TracePropertyMapOperations<T>, SpatialMap<TraceAddressSnapRange,T,DBTraceAddressSnapRangePropertyMapTree.TraceAddressSnapRangeQuery>

Direct Known Subclasses:

AbstractDBTracePropertyMap.DBTraceIntPropertyMap, AbstractDBTracePropertyMap.DBTraceLongPropertyMap, AbstractDBTracePropertyMap.DBTraceSaveablePropertyMap, AbstractDBTracePropertyMap.DBTraceStringPropertyMap, AbstractDBTracePropertyMap.DBTraceVoidPropertyMap

public abstract class AbstractDBTracePropertyMap<T,DR extends DBTraceAddressSnapRangePropertyMapTree.AbstractDBTraceAddressSnapRangePropertyMapData<T>>
extends DBTraceAddressSnapRangePropertyMap<T,DR>
implements TracePropertyMap<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractDBTracePropertyMap.DBTraceIntPropertyMap
static class	AbstractDBTracePropertyMap.DBTraceIntPropertyMapEntry
static class	AbstractDBTracePropertyMap.DBTraceLongPropertyMap
static class	AbstractDBTracePropertyMap.DBTraceLongPropertyMapEntry
class	AbstractDBTracePropertyMap.DBTracePropertyMapSpace
static class	AbstractDBTracePropertyMap.DBTraceSaveablePropertyMap<T extends Saveable>
static class	AbstractDBTracePropertyMap.DBTraceSaveablePropertyMapEntry<T extends Saveable>
static class	AbstractDBTracePropertyMap.DBTraceStringPropertyMap
static class	AbstractDBTracePropertyMap.DBTraceStringPropertyMapEntry
static class	AbstractDBTracePropertyMap.DBTraceVoidPropertyMap
static class	AbstractDBTracePropertyMap.DBTraceVoidPropertyMapEntry
static class	AbstractDBTracePropertyMap.SaveableDBFieldCodec

Nested classes/interfaces inherited from class ghidra.trace.database.map.DBTraceAddressSnapRangePropertyMap

DBTraceAddressSnapRangePropertyMap.DBTraceAddressSnapRangePropertyMapDataFactory<T,DR extends DBTraceAddressSnapRangePropertyMapTree.AbstractDBTraceAddressSnapRangePropertyMapData<T>>

Nested classes/interfaces inherited from class ghidra.trace.database.space.AbstractDBTraceSpaceBasedManager

AbstractDBTraceSpaceBasedManager.DBTraceSpaceEntry

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>

Nested classes/interfaces inherited from interface ghidra.util.database.spatial.SpatialMap

SpatialMap.EmptySpatialMap<DS extends BoundedShape<?>,T,Q>

Field Summary

Fields inherited from class ghidra.trace.database.map.DBTraceAddressSnapRangePropertyMap

dataFactory, dataType

Fields inherited from class ghidra.trace.database.space.AbstractDBTraceSpaceBasedManager

baseLanguage, dbh, lock, name, NO_ADDRESS_SPACE, regSpacesByContainer, spaces, spaceStore, spacesView, threadManager, trace

Fields inherited from interface ghidra.util.database.spatial.SpatialMap

EMPTY_MAP

Constructor Summary

Constructors

Constructor	Description
AbstractDBTracePropertyMap(String name, DBHandle dbh, OpenMode openMode, ReadWriteLock lock, TaskMonitor monitor, Language baseLanguage, DBTrace trace, DBTraceThreadManager threadManager, Class<DR> dataType, DBTraceAddressSnapRangePropertyMap.DBTraceAddressSnapRangePropertyMapDataFactory<T,DR> dataFactory)

Method Summary

Modifier and Type	Method	Description
boolean	clear(Lifespan span, AddressRange range)	Remove or truncate entries so that the given box contains no entries
protected AbstractDBTracePropertyMap<T,DR>.DBTracePropertyMapSpace	createSpace(AddressSpace space, AbstractDBTraceSpaceBasedManager.DBTraceSpaceEntry ent)
void	delete()	Delete this property and remove all of its maps
T	get(long snap, Address address)	Get the value at the given address-snap pair
Collection<Map.Entry<TraceAddressSnapRange,T>>	getEntries(Lifespan lifespan, AddressRange range)	Get the entries intersecting the given bounds
Map.Entry<TraceAddressSnapRange,T>	getEntry(long snap, Address address)	Get the entry at the given address-snap pair
TracePropertyMapSpace<T>	getPropertyMapRegisterSpace(TraceThread thread, int frameLevel, boolean createIfAbsent)	Get the map space for the registers of a given thread and frame
TracePropertyMapSpace<T>	getPropertyMapSpace(AddressSpace space, boolean createIfAbsent)	Get the map space for the given address space
protected void	makeWay(DR data, Lifespan span)
protected void	makeWay(Map.Entry<TraceAddressSnapRange,T> entry, Lifespan span)
T	put(TraceAddressSnapRange shape, T value)	Put an entry into the map
void	set(Lifespan lifespan, AddressRange range, T value)	Set a value over the given ranges
void	set(Lifespan lifespan, Address address, T value)	Set a value at the given address over the given lifespan

Methods inherited from class ghidra.trace.database.map.DBTraceAddressSnapRangePropertyMap

clear, deleteData, deleteValue, entries, firstEntry, firstKey, firstValue, getAddressSetView, getAddressSetView, getForSpace, getName, getRegisterSpace, getRegisterSpace, isEmpty, keys, orderedEntries, orderedKeys, orderedValues, readLock, reduce, remove, remove, size, values, writeLock

Methods inherited from class ghidra.trace.database.space.AbstractDBTraceSpaceBasedManager

dbError, get, getActiveSpaces, getBaseLanguage, getForRegisterSpace, getForRegisterSpace, getForRegisterSpace, getLock, getSpaceByName, getTabledSpaces, getTrace, invalidateCache, loadSpaces, tableName

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

Methods inherited from interface ghidra.trace.model.map.TraceAddressSnapRangePropertyMapOperations

put, put, put, put

Methods inherited from interface ghidra.trace.model.property.TracePropertyMap

getPropertyMapRegisterSpace

Methods inherited from interface ghidra.trace.model.property.TracePropertyMapOperations

getAddressSetView, getValueClass

Constructor Details

AbstractDBTracePropertyMap

public AbstractDBTracePropertyMap(String name,
 DBHandle dbh,
 OpenMode openMode,
 ReadWriteLock lock,
 TaskMonitor monitor,
 Language baseLanguage,
 DBTrace trace,
 DBTraceThreadManager threadManager,
 Class<DR> dataType,
 DBTraceAddressSnapRangePropertyMap.DBTraceAddressSnapRangePropertyMapDataFactory<T,DR> dataFactory)
                           throws IOException,
VersionException

Throws:

IOException

VersionException

Method Details

makeWay

protected void makeWay(Map.Entry<TraceAddressSnapRange,T> entry,
 Lifespan span)

makeWay

protected void makeWay(DR data,
 Lifespan span)

set

public void set(Lifespan lifespan,
 Address address,
 T value)

Description copied from interface: TracePropertyMapOperations

Set a value at the given address over the given lifespan

Specified by:

set in interface TracePropertyMapOperations<T>

Parameters:

lifespan - the lifespan

address - the address

value - the value

See Also:

• TracePropertyMapOperations.set(Lifespan, AddressRange, Object)

set

public void set(Lifespan lifespan,
 AddressRange range,
 T value)

Description copied from interface: TracePropertyMapOperations

Set a value over the given ranges

Setting a value of null still creates an entry, so that Void-typed maps function.

When setting an overlapping value, existing entries are deleted or truncated to make space for the new entry. If an existing entry overlaps and its starting snap is contained in the new entry's span, the existing entry is deleted, regardless of whether or not its ending snap is also contained in the new entry's span. If the starting snap of the existing entry precedes the span of the new entry, the existing entry is truncated -- its ending snap is set to one less than the new entry's starting snap. Address ranges are never truncated.

Specified by:

set in interface TracePropertyMapOperations<T>

Parameters:

lifespan - the lifespan

range - the address range

value - the value

get

public T get(long snap,
 Address address)

Description copied from interface: TracePropertyMapOperations

Get the value at the given address-snap pair

Specified by:

get in interface TracePropertyMapOperations<T>

Parameters:

snap - the snap

address - the address

Returns:

the value

getEntry

public Map.Entry<TraceAddressSnapRange,T> getEntry(long snap,
 Address address)

Description copied from interface: TracePropertyMapOperations

Get the entry at the given address-snap pair

Specified by:

getEntry in interface TracePropertyMapOperations<T>

Parameters:

snap - the snap

address - the address

Returns:

the entry, which includes the ranges and the value

getEntries

public Collection<Map.Entry<TraceAddressSnapRange,T>> getEntries(Lifespan lifespan,
 AddressRange range)

Description copied from interface: TracePropertyMapOperations

Get the entries intersecting the given bounds

Specified by:

getEntries in interface TracePropertyMapOperations<T>

Parameters:

lifespan - the range of snaps

range - the range of addresses

Returns:

the entries

clear

public boolean clear(Lifespan span,
 AddressRange range)

Description copied from interface: TracePropertyMapOperations

Remove or truncate entries so that the given box contains no entries

This applies the same truncation rule as in TracePropertyMapOperations.set(Lifespan, AddressRange, Object), except that no replacement entry is created.

Specified by:

clear in interface TracePropertyMapOperations<T>

Parameters:

span - the range of snaps

range - the address range

Returns:

true if any entry was affected

put

public T put(TraceAddressSnapRange shape,
 T value)

Description copied from interface: SpatialMap

Put an entry into the map

Note that the map may copy, and possibly modify, the given value. The value returned is the value actually stored by the map. This may be useful when the map's values are identical to its records. This allows the creation of a "blank" entry with a given shape. The entry is then populated by the user.

 class MyDBDataRecord extends DBTreeDataRecord<MyShape, MyNodeShape, MyDBDataRecord> {
 	&#64;Override
 	protected void setValue(MyDBDataRecord value) {
 		// Do nothing: value ought to be null. Map will create and return "blank" record
 	}
 
 	protected MyDBDataRecord getValue() {
 		return this; // The record is the value
 	}
 }
 
 MyDBDataRecord rec = map.put(MyShape.create(args), null);
 rec.setSomething(6);
 rec.setAnother("My user data");
 

This practice is preferred when the values are not simple, and/or when the shape is a property of the value. In other cases, e.g., when the value is an enum or a Color, then DBTreeDataRecord.setRecordValue(Object) and DBTreeDataRecord.getRecordValue() should be implemented as field accessors.

Specified by:

put in interface SpatialMap<TraceAddressSnapRange,T,DBTraceAddressSnapRangePropertyMapTree.TraceAddressSnapRangeQuery>

Overrides:

put in class DBTraceAddressSnapRangePropertyMap<T,DR extends DBTraceAddressSnapRangePropertyMapTree.AbstractDBTraceAddressSnapRangePropertyMapData<T>>

Parameters:

shape - the shape of the entry

value - the value for the entry

Returns:

the value as stored in the map

createSpace

protected AbstractDBTracePropertyMap<T,DR>.DBTracePropertyMapSpace createSpace(AddressSpace space,
 AbstractDBTraceSpaceBasedManager.DBTraceSpaceEntry ent)
                                                                        throws VersionException,
IOException

Overrides:

createSpace in class DBTraceAddressSnapRangePropertyMap<T,DR extends DBTraceAddressSnapRangePropertyMapTree.AbstractDBTraceAddressSnapRangePropertyMapData<T>>

Throws:

VersionException

IOException

getPropertyMapSpace

public TracePropertyMapSpace<T> getPropertyMapSpace(AddressSpace space,
 boolean createIfAbsent)

Description copied from interface: TracePropertyMap

Get the map space for the given address space

Specified by:

getPropertyMapSpace in interface TracePropertyMap<T>

Parameters:

space - the address space

createIfAbsent - true to create the map space if it doesn't already exist

Returns:

the space, or null

getPropertyMapRegisterSpace

public TracePropertyMapSpace<T> getPropertyMapRegisterSpace(TraceThread thread,
 int frameLevel,
 boolean createIfAbsent)

Description copied from interface: TracePropertyMap

Get the map space for the registers of a given thread and frame

Specified by:

getPropertyMapRegisterSpace in interface TracePropertyMap<T>

Parameters:

thread - the thread

frameLevel - the frame level, 0 being the innermost

createIfAbsent - true to create the map space if it doesn't already exist

Returns:

the space, or null

delete

public void delete()

Description copied from interface: TracePropertyMap

Delete this property and remove all of its maps

The property can be re-created with the same or different value type.

Specified by:

delete in interface TracePropertyMap<T>