Package ghidra.trace.database.module

Class DBTraceModuleManager

java.lang.Object

ghidra.trace.database.module.DBTraceModuleManager

All Implemented Interfaces:

ErrorHandler, DBTraceManager, TraceModuleManager, TraceModuleOperations

public class DBTraceModuleManager
extends Object
implements TraceModuleManager, DBTraceManager

Field Summary

Fields

Modifier and Type	Field	Description
protected final ReadWriteLock	lock
protected final DBTraceObjectManager	objectManager
protected final DBTrace	trace

Constructor Summary

Constructors

Constructor	Description
DBTraceModuleManager(DBHandle dbh, OpenMode openMode, ReadWriteLock lock, TaskMonitor monitor, DBTrace trace, DBTraceObjectManager objectManager)

Method Summary

Modifier and Type	Method	Description
TraceModule	addModule(String modulePath, String moduleName, AddressRange range, Lifespan lifespan)	Add a module
void	dbError(IOException e)	Notification that an IO exception occurred.
protected TraceModule	doAddModule(String modulePath, String moduleName, AddressRange range, Lifespan lifespan)
protected Collection<? extends TraceModule>	doGetModulesByPath(String modulePath)
protected Collection<? extends TraceSection>	doGetSectionsByPath(String sectionPath)
Collection<? extends TraceModule>	getAllModules()	Get all modules
Collection<? extends TraceSection>	getAllSections()	Get all sections
TraceModule	getLoadedModuleByPath(long snap, String modulePath)	Get the module loaded at the given snap having the given path
Collection<? extends TraceModule>	getLoadedModules(long snap)	Get all modules loaded at the given snap
TraceSection	getLoadedSectionByPath(long snap, String sectionPath)	Get the section loaded at the given snap having the given path
Collection<? extends TraceModule>	getModulesAt(long snap, Address address)	Get modules at the given snap and address
Collection<? extends TraceModule>	getModulesByPath(String modulePath)	Get modules by path
Collection<? extends TraceModule>	getModulesIntersecting(Lifespan lifespan, AddressRange range)	Get the modules loaded at the given snap intersecting the given address range
Collection<? extends TraceSection>	getSectionsAt(long snap, Address address)	Get sections at the given snap and address
Collection<? extends TraceSection>	getSectionsByPath(String sectionPath)	Get sections by path
Collection<? extends TraceSection>	getSectionsIntersecting(Lifespan lifespan, AddressRange range)	Get the sections loaded at the given snap intersecting the given address range
void	invalidateCache(boolean all)	Invalidate this manager's caches

Methods inherited from class java.lang.Object

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

Methods inherited from interface ghidra.trace.model.modules.TraceModuleManager

addLoadedModule

Field Details

lock

protected final ReadWriteLock lock

trace

protected final DBTrace trace

objectManager

protected final DBTraceObjectManager objectManager

Constructor Details

DBTraceModuleManager

public DBTraceModuleManager(DBHandle dbh,
 OpenMode openMode,
 ReadWriteLock lock,
 TaskMonitor monitor,
 DBTrace trace,
 DBTraceObjectManager objectManager)
                     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).

addModule

public TraceModule addModule(String modulePath,
 String moduleName,
 AddressRange range,
 Lifespan lifespan)
                      throws DuplicateNameException

Description copied from interface: TraceModuleManager

Add a module

Note that modules may overlap.

Specified by:

addModule in interface TraceModuleManager

Parameters:

modulePath - the "full name" of the module

moduleName - the "short name" of the module, usually its path on the file system

range - the address range of the module -- min should be the base address

lifespan - the span from load time to unload time

Returns:

the new module

Throws:

DuplicateNameException - if another module with the same name already exists for the desired lifespan

doAddModule

protected TraceModule doAddModule(String modulePath,
 String moduleName,
 AddressRange range,
 Lifespan lifespan)
                           throws DuplicateNameException

Throws:

DuplicateNameException

doGetModulesByPath

protected Collection<? extends TraceModule> doGetModulesByPath(String modulePath)

getModulesByPath

public Collection<? extends TraceModule> getModulesByPath(String modulePath)

Description copied from interface: TraceModuleManager

Get modules by path

Note it is possible the same module was loaded and unloaded multiple times. In that case, each load will have an separate record. It is also possible it was loaded at a different address, or that it's an entirely different module which happens to have the same path.

Note that the "module path" in this case is not necessarily path of the module's image on the target file system, though this name often contains it. Rather, this is typically the full path to the module in the target debugger's object model. Likely, the "short name" is the file system path of the module's image.

Specified by:

getModulesByPath in interface TraceModuleManager

Parameters:

modulePath - the "full name" of the module

Returns:

the collection of modules having the given path

getLoadedModuleByPath

public TraceModule getLoadedModuleByPath(long snap,
 String modulePath)

Description copied from interface: TraceModuleManager

Get the module loaded at the given snap having the given path

Specified by:

getLoadedModuleByPath in interface TraceModuleManager

Parameters:

snap - the snap which the module's lifespan must contain

modulePath - the module's "full name"

Returns:

the module, or null if no module matches

getAllModules

public Collection<? extends TraceModule> getAllModules()

Description copied from interface: TraceModuleOperations

Get all modules

Specified by:

getAllModules in interface TraceModuleOperations

Returns:

the (possibly empty) collection of modules

getLoadedModules

public Collection<? extends TraceModule> getLoadedModules(long snap)

Description copied from interface: TraceModuleOperations

Get all modules loaded at the given snap

Specified by:

getLoadedModules in interface TraceModuleOperations

Parameters:

snap - the snapshot key

Returns:

the collection of loaded modules

getModulesAt

public Collection<? extends TraceModule> getModulesAt(long snap,
 Address address)

Description copied from interface: TraceModuleOperations

Get modules at the given snap and address

Specified by:

getModulesAt in interface TraceModuleOperations

Parameters:

snap - the snap

address - the address

Returns:

the (possibly empty) collection of modules

getModulesIntersecting

public Collection<? extends TraceModule> getModulesIntersecting(Lifespan lifespan,
 AddressRange range)

Description copied from interface: TraceModuleOperations

Get the modules loaded at the given snap intersecting the given address range

Specified by:

getModulesIntersecting in interface TraceModuleOperations

Parameters:

lifespan - the span which the module must intersect

range - the range of memory the module must intersect

Returns:

the collection of sections

getSectionsAt

public Collection<? extends TraceSection> getSectionsAt(long snap,
 Address address)

Description copied from interface: TraceModuleOperations

Get sections at the given snap and address

Specified by:

getSectionsAt in interface TraceModuleOperations

Parameters:

snap - the snap

address - the address

Returns:

the (possibly empty) collection of sections

getSectionsIntersecting

public Collection<? extends TraceSection> getSectionsIntersecting(Lifespan lifespan,
 AddressRange range)

Description copied from interface: TraceModuleOperations

Get the sections loaded at the given snap intersecting the given address range

Specified by:

getSectionsIntersecting in interface TraceModuleOperations

Parameters:

lifespan - the span which the section's (module's) lifespan must intersect

range - the range of memory each loaded section must intersect

Returns:

the collection of sections

getAllSections

public Collection<? extends TraceSection> getAllSections()

Description copied from interface: TraceModuleOperations

Get all sections

Specified by:

getAllSections in interface TraceModuleOperations

Returns:

the (possibly empty) collection of sections

doGetSectionsByPath

protected Collection<? extends TraceSection> doGetSectionsByPath(String sectionPath)

getSectionsByPath

public Collection<? extends TraceSection> getSectionsByPath(String sectionPath)

Description copied from interface: TraceModuleManager

Get sections by path

Note because it's possible for a module path to be duplicated (but not within any overlapping snap), it is also possible for a section path to be duplicated.

Specified by:

getSectionsByPath in interface TraceModuleManager

Parameters:

sectionPath - the "full name" of the section

Returns:

the collection of sections having the given path

getLoadedSectionByPath

public TraceSection getLoadedSectionByPath(long snap,
 String sectionPath)

Description copied from interface: TraceModuleManager

Get the section loaded at the given snap having the given path

Specified by:

getLoadedSectionByPath in interface TraceModuleManager

Parameters:

snap - the snap which the section's (module's) lifespan must contain

sectionPath - the section's "full name"

Returns:

the section, or null if no section matches