Package ghidra.trace.database.data

Class DBTraceDataTypeManager

java.lang.Object

ghidra.program.database.data.DataTypeManagerDB

ghidra.program.database.data.ProgramBasedDataTypeManagerDB

ghidra.trace.database.data.DBTraceDataTypeManager

All Implemented Interfaces:

ErrorHandler, DataTypeManager, DomainFileBasedDataTypeManager, FileBasedDataTypeManager, ProgramBasedDataTypeManager, DBTraceManager, TraceBasedDataTypeManager

public class DBTraceDataTypeManager
extends ProgramBasedDataTypeManagerDB
implements TraceBasedDataTypeManager, DBTraceManager

Field Summary

Fields

Modifier and Type	Field	Description
protected final ReadWriteLock	lock	NOTE: This "read-write" lock is actually just a compatibility wrapper around the Lock for the entire trace database.
protected final InternalTracePlatform	platform
protected final DBTrace	trace

Fields inherited from class ghidra.program.database.data.DataTypeManagerDB

addrMap, dbHandle, DEFAULT_CALLING_CONVENTION_ID, defaultListener, errHandler, readOnlyMode, sourceArchiveAdapter, tablePrefix, universalID, UNKNOWN_CALLING_CONVENTION_ID

Fields inherited from interface ghidra.program.model.data.DataTypeManager

BAD_DATATYPE_ID, BUILT_IN_ARCHIVE_KEY, BUILT_IN_ARCHIVE_UNIVERSAL_ID, BUILT_IN_DATA_TYPES_NAME, DEFAULT_DATATYPE_ID, LOCAL_ARCHIVE_KEY, LOCAL_ARCHIVE_UNIVERSAL_ID, NULL_DATATYPE_ID

Constructor Summary

Constructors

Constructor	Description
DBTraceDataTypeManager(DBHandle dbh, OpenMode openMode, ReadWriteLock lock, TaskMonitor monitor, DBTrace trace, InternalTracePlatform platform)

Method Summary

Modifier and Type	Method	Description
boolean	allowsDefaultBuiltInSettings()	Determine if settings are supported for BuiltIn datatypes within this datatype manager.
protected void	categoryCreated(Category createdCategory)
protected void	categoryMoved(CategoryPath oldPath, Category category)
protected void	categoryRemoved(Category parent, String name, long deletedID)
protected void	categoryRenamed(CategoryPath oldPath, Category category)
void	close()	Closes this dataType manager
protected void	dataSettingChanged(Address address)	Provides notification when a data instance setting has changed at a specific address.
protected void	dataTypeAdded(DataType addedType, DataType sourceType)
void	dataTypeChanged(DataType dataType, boolean isAutoChange)	Notification when data type is changed.
protected void	dataTypeDeleted(long deletedID, DataTypePath deletedPath)
protected void	dataTypeMoved(DataType type, DataTypePath oldPath, DataTypePath newPath)
protected void	dataTypeNameChanged(DataType type, String oldName)
protected void	dataTypeReplaced(long replacedID, DataTypePath replacedPath, DataType replacementType)
protected void	deleteDataTypesUsed(Set<Long> deletedIds)	Allow extensions to perform any necessary fixups for all datatype removals listed.
boolean	endTransaction(int transactionID, boolean commit)	Ends the current transaction.
void	flushEvents()	Force all pending notification events to be flushed
DomainFile	getDomainFile()
protected String	getDomainFileID()
String	getName()	Returns this data type manager's name
String	getPath()
InternalTracePlatform	getPlatform()	Get the platform for which this data type manager is provided
DBTrace	getTrace()	Get the trace of which this data type manager is a part
ArchiveType	getType()	Returns this manager's archive type
void	invalidateCache(boolean all)	Invalidate this manager's caches
boolean	isUpdatable()	Returns true if this DataTypeManager can be modified.
Transaction	openTransaction(String description)	Open new transaction.
protected void	replaceDataTypesUsed(Map<Long,Long> dataTypeReplacementMap)	Allow extensions to perform any neccessary fixups to address all datatype replacements.
void	setName(String name)	Sets this data type manager's name
protected void	sourceArchiveAdded(UniversalID sourceArchiveID)
void	sourceArchiveChanged(UniversalID sourceArchiveID)
int	startTransaction(String description)	Starts a transaction for making changes in this data type manager.

Methods inherited from class ghidra.program.database.data.ProgramBasedDataTypeManagerDB

clearAllSettings, clearSetting, deleteAddressRange, getDataSettingsAddress, getInstanceSettingsNames, getLongSettingsValue, getSettings, getStringSettingsValue, initializeOtherAdapters, invalidateCache, isChangeAllowed, isEmptySetting, moveAddressRange, setLongSettingsValue, setSettings, setStringSettingsValue

Methods inherited from class ghidra.program.database.data.DataTypeManagerDB

addDataType, addDataTypeManagerListener, addDataTypes, addDataTypeToDelete, addDataTypeToReplace, addInvalidatedListener, allowsDefaultComponentSettings, associateDataTypeWithArchive, compilerSpecChanged, contains, containsCategory, createCategory, dataTypeSettingsChanged, dbError, dedupeAllConflicts, dedupeConflicts, disassociate, dispose, doSourceArchiveUpdates, favoritesChanged, findDataType, findDataTypeForID, findDataTypes, findDataTypes, findEnumValueNames, fixupComposites, getAddressMap, getAllComposites, getAllDataTypes, getAllDataTypes, getAllFunctionDefinitions, getAllStructures, getCallingConvention, getCallingConventionID, getCallingConventionName, getCategory, getCategory, getCategoryCount, getChildIds, getDataMap, getDataOrganization, getDataType, getDataType, getDataType, getDataType, getDataType, getDataTypeCount, getDataTypes, getDataTypes, getDataTypesContaining, getDefaultCallingConvention, getDefinedCallingConventionNames, getFavorites, getID, getKnownCallingConventionNames, getLastChangeTimeForMyManager, getLocalSourceArchive, getPointer, getPointer, getProgramArchitecture, getProgramArchitectureSummary, getProgramArchitectureSummary, getResolvedID, getRootCategory, getSourceArchive, getSourceArchive, getSourceArchives, getUniqueName, getUniversalID, getUnusedConflictName, getUnusedConflictName, getVariableStorageManager, handleDataOrganizationChange, hasDataOrganizationChange, hasParent, isChanged, isCreatingDataType, isFavorite, isTransactionActive, migrateOldFlexArrayComponentsIfRequired, notifyRestored, readDataOrganization, remove, remove, removeDataTypeManagerListener, removeInvalidatedListener, removeParentChildRecord, removeSourceArchive, replaceDataType, replaceSourceArchive, resolve, resolveSourceArchive, saveDataOrganization, setFavorite, setProgramArchitecture, updateID, updateLastChangeTime, updateSourceArchiveName, updateSourceArchiveName

Methods inherited from class java.lang.Object

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

Methods inherited from interface ghidra.program.model.data.DataTypeManager

addDataType, addDataTypeManagerListener, addDataTypes, addInvalidatedListener, allowsDefaultComponentSettings, associateDataTypeWithArchive, contains, containsCategory, createCategory, disassociate, findDataType, findDataTypeForID, findDataTypes, findDataTypes, findEnumValueNames, getAddressMap, getAllComposites, getAllDataTypes, getAllDataTypes, getAllFunctionDefinitions, getAllStructures, getCallingConvention, getCategory, getCategory, getCategoryCount, getDataOrganization, getDataType, getDataType, getDataType, getDataType, getDataType, getDataTypeCount, getDataTypes, getDataTypesContaining, getDefaultCallingConvention, getDefinedCallingConventionNames, getFavorites, getID, getKnownCallingConventionNames, getLastChangeTimeForMyManager, getLocalSourceArchive, getPointer, getPointer, getProgramArchitecture, getProgramArchitectureSummary, getResolvedID, getRootCategory, getSourceArchive, getSourceArchives, getUniqueName, getUniversalID, isFavorite, remove, remove, remove, removeDataTypeManagerListener, removeInvalidatedListener, removeSourceArchive, replaceDataType, resolve, resolveSourceArchive, setFavorite, updateSourceArchiveName, updateSourceArchiveName, withTransaction, withTransaction

Methods inherited from interface db.util.ErrorHandler

dbError

Methods inherited from interface ghidra.program.model.data.ProgramBasedDataTypeManager

clearAllSettings, clearSetting, deleteAddressRange, getInstanceSettingsNames, getLongSettingsValue, getSettings, getStringSettingsValue, isChangeAllowed, isEmptySetting, moveAddressRange, setLongSettingsValue, setSettings, setStringSettingsValue

Methods inherited from interface ghidra.trace.model.data.TraceBasedDataTypeManager

addType, getProgram, replaceType, resolveType

Field Details

lock

protected final ReadWriteLock lock

NOTE: This "read-write" lock is actually just a compatibility wrapper around the Lock for the entire trace database. There was a time when I dreamed of using an actual read-write lock (though it's not known if that'd actually achieve any appreciable speed up); however, inheriting the existing DataTypeManager implementation required its lock to be used throughout the database. Rather than convert all my code (and lose the distinction of where I need write vs. read locks), I just wrapped the API. So no, this code does not refer to the wrapper, but it does still use the lock. I keep a reference to it here in case I ever need it.

trace

protected final DBTrace trace

platform

protected final InternalTracePlatform platform

Constructor Details

DBTraceDataTypeManager

public DBTraceDataTypeManager(DBHandle dbh,
 OpenMode openMode,
 ReadWriteLock lock,
 TaskMonitor monitor,
 DBTrace trace,
 InternalTracePlatform platform)
                       throws CancelledException,
VersionException,
IOException

Throws:

CancelledException

VersionException

IOException

Method Details

dataSettingChanged

protected void dataSettingChanged(Address address)

Description copied from class: ProgramBasedDataTypeManagerDB

Provides notification when a data instance setting has changed at a specific address.

Specified by:

dataSettingChanged in class ProgramBasedDataTypeManagerDB

Parameters:

address - data address

allowsDefaultBuiltInSettings

public boolean allowsDefaultBuiltInSettings()

Description copied from interface: DataTypeManager

Determine if settings are supported for BuiltIn datatypes within this datatype manager.

Specified by:

allowsDefaultBuiltInSettings in interface DataTypeManager

Overrides:

allowsDefaultBuiltInSettings in class DataTypeManagerDB

Returns:

true if BuiltIn Settings are permitted

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).

getName

public String getName()

Description copied from interface: DataTypeManager

Returns this data type manager's name

Specified by:

getName in interface DataTypeManager

Returns:

the name

setName

public void setName(String name)
             throws InvalidNameException

Description copied from interface: DataTypeManager

Sets this data type manager's name

Specified by:

setName in interface DataTypeManager

Parameters:

name - the new name

Throws:

InvalidNameException - if the given name is invalid (such as when null or empty)

getPlatform

public InternalTracePlatform getPlatform()

Description copied from interface: TraceBasedDataTypeManager

Get the platform for which this data type manager is provided

Specified by:

getPlatform in interface TraceBasedDataTypeManager

Returns:

the platform

sourceArchiveChanged

public void sourceArchiveChanged(UniversalID sourceArchiveID)

Overrides:

sourceArchiveChanged in class DataTypeManagerDB

sourceArchiveAdded

protected void sourceArchiveAdded(UniversalID sourceArchiveID)

Overrides:

sourceArchiveAdded in class DataTypeManagerDB

dataTypeChanged

public void dataTypeChanged(DataType dataType,
 boolean isAutoChange)

Description copied from class: DataTypeManagerDB

Notification when data type is changed.

Overrides:

dataTypeChanged in class DataTypeManagerDB

Parameters:

dataType - data type that is changed

isAutoChange - true if change was an automatic change in response to another datatype's change (e.g., size, alignment).

dataTypeAdded

protected void dataTypeAdded(DataType addedType,
 DataType sourceType)

Overrides:

dataTypeAdded in class DataTypeManagerDB

dataTypeReplaced

protected void dataTypeReplaced(long replacedID,
 DataTypePath replacedPath,
 DataType replacementType)

Overrides:

dataTypeReplaced in class DataTypeManagerDB

dataTypeMoved

protected void dataTypeMoved(DataType type,
 DataTypePath oldPath,
 DataTypePath newPath)

Overrides:

dataTypeMoved in class DataTypeManagerDB

dataTypeNameChanged

protected void dataTypeNameChanged(DataType type,
 String oldName)

Overrides:

dataTypeNameChanged in class DataTypeManagerDB

dataTypeDeleted

protected void dataTypeDeleted(long deletedID,
 DataTypePath deletedPath)

Overrides:

dataTypeDeleted in class DataTypeManagerDB

categoryCreated

protected void categoryCreated(Category createdCategory)

Overrides:

categoryCreated in class DataTypeManagerDB

categoryMoved

protected void categoryMoved(CategoryPath oldPath,
 Category category)

Overrides:

categoryMoved in class DataTypeManagerDB

categoryRenamed

protected void categoryRenamed(CategoryPath oldPath,
 Category category)

Overrides:

categoryRenamed in class DataTypeManagerDB

categoryRemoved

protected void categoryRemoved(Category parent,
 String name,
 long deletedID)

Overrides:

categoryRemoved in class DataTypeManagerDB

replaceDataTypesUsed

protected void replaceDataTypesUsed(Map<Long,Long> dataTypeReplacementMap)

Description copied from class: DataTypeManagerDB

Allow extensions to perform any neccessary fixups to address all datatype replacements.

Specified by:

replaceDataTypesUsed in class DataTypeManagerDB

Parameters:

dataTypeReplacementMap - map of datatype replacements (oldID maps to replacementID).

deleteDataTypesUsed

protected void deleteDataTypesUsed(Set<Long> deletedIds)

Description copied from class: DataTypeManagerDB

Allow extensions to perform any necessary fixups for all datatype removals listed.

Specified by:

deleteDataTypesUsed in class DataTypeManagerDB

Parameters:

deletedIds - list of IDs for all datatypes which are getting removed.

isUpdatable

public boolean isUpdatable()

Description copied from interface: DataTypeManager

Returns true if this DataTypeManager can be modified.

Specified by:

isUpdatable in interface DataTypeManager

Overrides:

isUpdatable in class DataTypeManagerDB

Returns:

true if this DataTypeMangaer can be modified.

openTransaction

public Transaction openTransaction(String description)
                            throws IllegalStateException

Description copied from interface: DataTypeManager

Open new transaction. This should generally be done with a try-with-resources block:

 try (Transaction tx = dtm.openTransaction(description)) {
        // ... Do something
 }
 

Specified by:

openTransaction in interface DataTypeManager

Parameters:

description - a short description of the changes to be made.

Returns:

transaction object

Throws:

IllegalStateException - if this DataTypeManager has already been closed.

startTransaction

public int startTransaction(String description)

Description copied from interface: DataTypeManager

Starts a transaction for making changes in this data type manager.

Specified by:

startTransaction in interface DataTypeManager

Parameters:

description - a short description of the changes to be made.

Returns:

the transaction ID

flushEvents

public void flushEvents()

Description copied from interface: DataTypeManager

Force all pending notification events to be flushed

Specified by:

flushEvents in interface DataTypeManager

endTransaction

public boolean endTransaction(int transactionID,
 boolean commit)

Description copied from interface: DataTypeManager

Ends the current transaction.

NOTE: If multiple transactions are outstanding the full transaction will not be ended until all transactions have been ended. If any of the transactions indicate a false for commit the transaction will ultimately be rolled-back when the final transaction is ended.

NOTE: Use of rollback (commit=false should be avoided unless absolutely necessary since it will incur overhead to revert changes and may rollback multiple concurrent transactions if they exist.

NOTE: If this manager is part of a larger DomainObject its transactions may become entangled with other transactions at a higher level. In such cases, use of the DomainObject transaction interface is preferred. The return value from this method cannot be relied on in such cases.

Specified by:

endTransaction in interface DataTypeManager

Parameters:

transactionID - id of the transaction to end

commit - true if changes are committed, false if changes in transaction should be rolled back.

Returns:

true if this invocation was the final transaction and all changes were comitted.

close

public void close()

Description copied from interface: DataTypeManager

Closes this dataType manager

Specified by:

close in interface DataTypeManager

Overrides:

close in class DataTypeManagerDB

getTrace

public DBTrace getTrace()

Description copied from interface: TraceBasedDataTypeManager

Get the trace of which this data type manager is a part

Specified by:

getTrace in interface TraceBasedDataTypeManager

Returns:

the trace

getDomainFile

public DomainFile getDomainFile()

Specified by:

getDomainFile in interface DomainFileBasedDataTypeManager

getDomainFileID

protected String getDomainFileID()

Specified by:

getDomainFileID in class DataTypeManagerDB

getPath

public String getPath()

Specified by:

getPath in interface FileBasedDataTypeManager

Specified by:

getPath in class DataTypeManagerDB

getType

public ArchiveType getType()

Description copied from interface: DataTypeManager

Returns this manager's archive type

Specified by:

getType in interface DataTypeManager

Returns:

the type