Package ghidra.trace.database.time

Class DBTraceTimeManager

java.lang.Object

ghidra.trace.database.time.DBTraceTimeManager

All Implemented Interfaces:

ErrorHandler, DBTraceManager, TraceTimeManager

public class DBTraceTimeManager
extends Object
implements TraceTimeManager, DBTraceManager

Field Summary

Fields

Modifier and Type	Field	Description
protected final ReadWriteLock	lock
protected final DBCachedObjectIndex<String,DBTraceSnapshot>	snapshotsBySchedule
protected final DBCachedObjectStore<DBTraceSnapshot>	snapshotStore
protected final DBTraceThreadManager	threadManager
protected final DBTrace	trace

Fields inherited from interface ghidra.trace.model.time.TraceTimeManager

KEY_TIME_RADIX

Constructor Summary

Constructors

Constructor	Description
DBTraceTimeManager(DBHandle dbh, OpenMode openMode, ReadWriteLock lock, TaskMonitor monitor, DBTrace trace, DBTraceThreadManager threadManager)

Method Summary

Modifier and Type	Method	Description
DBTraceSnapshot	createSnapshot(String description)	Create a new snapshot after the latest
void	dbError(IOException e)	Notification that an IO exception occurred.
void	deleteSnapshot(DBTraceSnapshot snapshot)
TraceSnapshot	findScratchSnapshot(TraceSchedule schedule)	Find or create a the snapshot with the given schedule
Collection<? extends DBTraceSnapshot>	getAllSnapshots()	List all snapshots in the trace
Long	getMaxSnap()	Get maximum snapshot key that has ever existed, usually that of the latest snapshot Note, the corresponding snapshot need not exist, as it may have been deleted.
DBTraceSnapshot	getMostRecentSnapshot(long snap)	Get the most recent snapshot since a given key
DBTraceSnapshot	getSnapshot(long snap, boolean createIfAbsent)	Get the snapshot with the given key, optionally creating it
long	getSnapshotCount()	Get the number of snapshots
Collection<? extends DBTraceSnapshot>	getSnapshots(long fromSnap, boolean fromInclusive, long toSnap, boolean toInclusive)	List all snapshots between two given snaps in the trace
Collection<? extends TraceSnapshot>	getSnapshotsWithSchedule(TraceSchedule schedule)	Get all snapshots with the given schedule
TraceSchedule.TimeRadix	getTimeRadix()	Get the radix for displaying and parsing time (snapshots and step counts)
void	invalidateCache(boolean all)	Invalidate this manager's caches
protected void	notifySnapshotAdded(DBTraceSnapshot snapshot)
protected void	notifySnapshotChanged(DBTraceSnapshot snapshot)
protected void	notifySnapshotDeleted(DBTraceSnapshot snapshot)
void	setTimeRadix(TraceSchedule.TimeRadix radix)	Set the radix for displaying and parsing time (snapshots and step counts)

Methods inherited from class java.lang.Object

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

Field Details

lock

protected final ReadWriteLock lock

trace

protected final DBTrace trace

threadManager

protected final DBTraceThreadManager threadManager

snapshotStore

protected final DBCachedObjectStore<DBTraceSnapshot> snapshotStore

snapshotsBySchedule

protected final DBCachedObjectIndex<String,DBTraceSnapshot> snapshotsBySchedule

Constructor Details

DBTraceTimeManager

public DBTraceTimeManager(DBHandle dbh,
 OpenMode openMode,
 ReadWriteLock lock,
 TaskMonitor monitor,
 DBTrace trace,
 DBTraceThreadManager threadManager)
                   throws VersionException,
IOException

Throws:

VersionException

IOException

Method Details

dbError

public void dbError(IOException e)

Description copied from interface: ErrorHandler

Notification that an IO exception occurred.

Specified by:

dbError in interface ErrorHandler

Parameters:

e - IOException which was cause of error

invalidateCache

public void invalidateCache(boolean all)

Description copied from interface: DBTraceManager

Invalidate this manager's caches

Specified by:

invalidateCache in interface DBTraceManager

Parameters:

all - probably nothing. Check out implementations of ManagerDB.invalidateCache(boolean).

notifySnapshotAdded

protected void notifySnapshotAdded(DBTraceSnapshot snapshot)

notifySnapshotChanged

protected void notifySnapshotChanged(DBTraceSnapshot snapshot)

notifySnapshotDeleted

protected void notifySnapshotDeleted(DBTraceSnapshot snapshot)

createSnapshot

public DBTraceSnapshot createSnapshot(String description)

Description copied from interface: TraceTimeManager

Create a new snapshot after the latest

Specified by:

createSnapshot in interface TraceTimeManager

Parameters:

description - a description of the new snapshot, i.e., the reason for advancing

Returns:

the created snapshot

getSnapshot

public DBTraceSnapshot getSnapshot(long snap,
 boolean createIfAbsent)

Description copied from interface: TraceTimeManager

Get the snapshot with the given key, optionally creating it

Specified by:

getSnapshot in interface TraceTimeManager

Parameters:

snap - the snapshot key

createIfAbsent - create the snapshot if it's missing

Returns:

the snapshot or null

getMostRecentSnapshot

public DBTraceSnapshot getMostRecentSnapshot(long snap)

Description copied from interface: TraceTimeManager

Get the most recent snapshot since a given key

Specified by:

getMostRecentSnapshot in interface TraceTimeManager

Parameters:

snap - the snapshot key

Returns:

the snapshot or null

getSnapshotsWithSchedule

public Collection<? extends TraceSnapshot> getSnapshotsWithSchedule(TraceSchedule schedule)

Description copied from interface: TraceTimeManager

Get all snapshots with the given schedule

Ideally, the snapshot schedules should be managed such that the returned collection contains at most one snapshot.

Specified by:

getSnapshotsWithSchedule in interface TraceTimeManager

Parameters:

schedule - the schedule to find

Returns:

the snapshots

findScratchSnapshot

public TraceSnapshot findScratchSnapshot(TraceSchedule schedule)

Description copied from interface: TraceTimeManager

Find or create a the snapshot with the given schedule

If a snapshot with the given schedule already exists, this returns the first such snapshot found. Ideally, there is exactly one. If this method is consistently used for creating scratch snapshots, then that should always be the case. If no such snapshot exists, this creates a snapshot with the minimum available negative snapshot key, that is starting at Long.MIN_VALUE and increasing from there.

Specified by:

findScratchSnapshot in interface TraceTimeManager

Parameters:

schedule - the schedule to find

Returns:

the snapshot

getAllSnapshots

public Collection<? extends DBTraceSnapshot> getAllSnapshots()

Description copied from interface: TraceTimeManager

List all snapshots in the trace

Specified by:

getAllSnapshots in interface TraceTimeManager

Returns:

the set of snapshots

getSnapshots

public Collection<? extends DBTraceSnapshot> getSnapshots(long fromSnap,
 boolean fromInclusive,
 long toSnap,
 boolean toInclusive)

Description copied from interface: TraceTimeManager

List all snapshots between two given snaps in the trace

Specified by:

getSnapshots in interface TraceTimeManager

Parameters:

fromSnap - the starting snap

fromInclusive - whether to include the from snap

toSnap - the ending snap

toInclusive - when to include the to snap

Returns:

the set of snapshots

getMaxSnap

public Long getMaxSnap()

Description copied from interface: TraceTimeManager

Get maximum snapshot key that has ever existed, usually that of the latest snapshot Note, the corresponding snapshot need not exist, as it may have been deleted.

Specified by:

getMaxSnap in interface TraceTimeManager

Returns:

the key, or null if no snapshots have existed

getSnapshotCount

public long getSnapshotCount()

Description copied from interface: TraceTimeManager

Get the number of snapshots

Specified by:

getSnapshotCount in interface TraceTimeManager

Returns:

the count

deleteSnapshot

public void deleteSnapshot(DBTraceSnapshot snapshot)

setTimeRadix

public void setTimeRadix(TraceSchedule.TimeRadix radix)

Description copied from interface: TraceTimeManager

Set the radix for displaying and parsing time (snapshots and step counts)

This only affects the GUI, but storing it in the trace gives the back end a means of controlling it.

Specified by:

setTimeRadix in interface TraceTimeManager

Parameters:

radix - the radix

getTimeRadix

public TraceSchedule.TimeRadix getTimeRadix()

Description copied from interface: TraceTimeManager

Get the radix for displaying and parsing time (snapshots and step counts)

Specified by:

getTimeRadix in interface TraceTimeManager

Returns:

radix the radix

See Also:

• TraceTimeManager.setTimeRadix(TimeRadix)