Package ghidra.program.database.register
Class ProgramRegisterContextDB
- java.lang.Object
-
- ghidra.program.util.AbstractProgramContext
-
- ghidra.program.util.AbstractStoredProgramContext
-
- ghidra.program.database.register.ProgramRegisterContextDB
-
- All Implemented Interfaces:
ManagerDB,DefaultProgramContext,ProgramContext
public class ProgramRegisterContextDB extends AbstractStoredProgramContext implements ManagerDB
-
-
Field Summary
-
Fields inherited from class ghidra.program.util.AbstractStoredProgramContext
defaultRegisterValueMap, registerValueMap
-
Fields inherited from class ghidra.program.util.AbstractProgramContext
baseContextRegister, defaultDisassemblyContext, registerNameMap, registers
-
-
Constructor Summary
Constructors Constructor Description ProgramRegisterContextDB(DBHandle dbHandle, ErrorHandler errHandler, Language lang, CompilerSpec compilerSpec, AddressMap addrMap, Lock lock, int openMode, CodeManager codeMgr, TaskMonitor monitor)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected RangeMapAdaptercreateNewRangeMapAdapter(Register baseRegister)voiddeleteAddressRange(Address start, Address end, TaskMonitor monitor)Delete all objects which have been applied to the address range startAddr to endAddr and update the database accordingly.voidflushProcessorContextWriteCache()Flush any cached context not yet written to databaseAddressRangeIteratorgetDefaultRegisterValueAddressRanges(Register register)Returns an AddressRangeIterator over all addresses that have an associated default value for the given register.AddressRangeIteratorgetDefaultRegisterValueAddressRanges(Register register, Address start, Address end)Returns an AddressRangeIterator over all addresses that have an associated default value within the given range for the given register.RegisterValuegetDefaultValue(Register register, Address address)Returns the default value of a register at a given address.RegisterValuegetNonDefaultValue(Register register, Address address)Returns the (non-default)value assigned to a register at a given address.Register[]getRegistersWithValues()Returns an array of all registers that at least one value associated with an address.AddressRangeIteratorgetRegisterValueAddressRanges(Register register)Returns an AddressRangeIterator over all addresses that have an associated value for the given register.AddressRangeIteratorgetRegisterValueAddressRanges(Register register, Address start, Address end)Returns an AddressRangeIterator over all addresses that have an associated value within the given range for the given register.AddressRangegetRegisterValueRangeContaining(Register register, Address addr)Returns the bounding address-range containing addr and the the same RegisterValue throughout.booleanhasValueOverRange(Register reg, java.math.BigInteger value, AddressSetView addrSet)Returns true if the given register has the value over the addressSetvoidinitializeDefaultValues(Language lang, CompilerSpec compilerSpec)Intialize context with default values defined by pspec and cspec.voidinvalidateCache(boolean all)Clears all data caches.voidinvalidateProcessorContextWriteCache()Flush any cached context not yet written to databasevoidmoveAddressRange(Address fromAddr, Address toAddr, long length, TaskMonitor monitor)Move all objects within an address range to a new location.voidprogramReady(int openMode, int currentRevision, TaskMonitor monitor)Callback from program made to each manager after the program has completed initialization.voidremove(Address start, Address end, Register register)Remove (unset) the register values for a given address range.voidsetDefaultValue(RegisterValue registerValue, Address start, Address end)Associates a default value with the given register over the given range.voidsetLanguage(LanguageTranslator translator, CompilerSpec newCompilerSpec, AddressSetView programMemory, TaskMonitor monitor)Perform context upgrade due to a language changevoidsetProgram(ProgramDB program)Callback from program used to indicate all manager have been created.voidsetRegisterValue(Address start, Address end, RegisterValue value)Sets the register context over the given range to the given value.voidsetValue(Register register, Address start, Address end, java.math.BigInteger value)Associates a value with a register over a given address range.-
Methods inherited from class ghidra.program.util.AbstractStoredProgramContext
createRegisterValueStore, getDisassemblyContext, getRegisterValue, getValue, invalidateReadCache, invalidateWriteCache
-
Methods inherited from class ghidra.program.util.AbstractProgramContext
getBaseContextRegister, getDefaultDisassemblyContext, getFlowValue, getNonFlowValue, getProcessorStateRegisters, getRegister, getRegisterNames, getRegisters, hasNonFlowingContext, initNameMap, setDefaultDisassemblyContext
-
-
-
-
Constructor Detail
-
ProgramRegisterContextDB
public ProgramRegisterContextDB(DBHandle dbHandle, ErrorHandler errHandler, Language lang, CompilerSpec compilerSpec, AddressMap addrMap, Lock lock, int openMode, CodeManager codeMgr, TaskMonitor monitor) throws VersionException, CancelledException
- Throws:
VersionExceptionCancelledException
-
-
Method Detail
-
initializeDefaultValues
public void initializeDefaultValues(Language lang, CompilerSpec compilerSpec)
Intialize context with default values defined by pspec and cspec. NOTE: cspec values take precedence- Parameters:
lang- processor languagecompilerSpec- compiler specification
-
invalidateCache
public void invalidateCache(boolean all) throws java.io.IOExceptionDescription copied from interface:ManagerDBClears all data caches.- Specified by:
invalidateCachein interfaceManagerDB- Parameters:
all- if false, some managers may not need to update their cache if they can tell that its not necessary. If this flag is true, then all managers should clear their cache no matter what.- Throws:
java.io.IOException- if a database io error occurs.
-
moveAddressRange
public void moveAddressRange(Address fromAddr, Address toAddr, long length, TaskMonitor monitor) throws CancelledException
Description copied from interface:ManagerDBMove all objects within an address range to a new location.- Specified by:
moveAddressRangein interfaceManagerDB- Overrides:
moveAddressRangein classAbstractStoredProgramContext- Parameters:
fromAddr- the first address of the range to be moved.toAddr- the address where to the range is to be moved.length- the number of addresses to move.monitor- the task monitor to use in any upgrade operations.- Throws:
CancelledException- if the user cancelled the operation via the task monitor.
-
programReady
public void programReady(int openMode, int currentRevision, TaskMonitor monitor) throws java.io.IOException, CancelledExceptionDescription copied from interface:ManagerDBCallback from program made to each manager after the program has completed initialization. This method may be used by managers to perform additional upgrading which may have been deferred.- Specified by:
programReadyin interfaceManagerDB- Parameters:
openMode- the mode that the program is being opened.currentRevision- current program revision. If openMode is UPGRADE, this value reflects the pre-upgrade value.monitor- the task monitor to use in any upgrade operations.- Throws:
java.io.IOException- if a database io error occurs.CancelledException- if the user cancelled the operation via the task monitor.
-
setProgram
public void setProgram(ProgramDB program)
Description copied from interface:ManagerDBCallback from program used to indicate all manager have been created. When this method is invoked, all managers have been instantiated but may not be fully initialized.- Specified by:
setProgramin interfaceManagerDB- Parameters:
program- the program is set when all the initializations have been completed.
-
createNewRangeMapAdapter
protected RangeMapAdapter createNewRangeMapAdapter(Register baseRegister)
- Specified by:
createNewRangeMapAdapterin classAbstractStoredProgramContext
-
deleteAddressRange
public void deleteAddressRange(Address start, Address end, TaskMonitor monitor)
Description copied from interface:ManagerDBDelete all objects which have been applied to the address range startAddr to endAddr and update the database accordingly.- Specified by:
deleteAddressRangein interfaceManagerDB- Overrides:
deleteAddressRangein classAbstractStoredProgramContext- Parameters:
start- the first address in the range.end- the last address in the range.monitor- the task monitor to use in any upgrade operations.
-
remove
public void remove(Address start, Address end, Register register) throws ContextChangeException
Description copied from interface:ProgramContextRemove (unset) the register values for a given address range.- Specified by:
removein interfaceProgramContext- Overrides:
removein classAbstractStoredProgramContext- Parameters:
start- starting address.end- ending adddress.register- handle to the register to be set.- Throws:
ContextChangeException
-
setValue
public void setValue(Register register, Address start, Address end, java.math.BigInteger value) throws ContextChangeException
Description copied from interface:ProgramContextAssociates a value with a register over a given address range. Any previous values will be overwritten.- Specified by:
setValuein interfaceProgramContext- Overrides:
setValuein classAbstractStoredProgramContext- Parameters:
register- the register for which to assign a value.start- the start address.end- the end address (inclusive).value- the value to assign. A value of null will effective clear any existing values.- Throws:
ContextChangeException
-
setRegisterValue
public void setRegisterValue(Address start, Address end, RegisterValue value) throws ContextChangeException
Description copied from interface:ProgramContextSets the register context over the given range to the given value.- Specified by:
setRegisterValuein interfaceProgramContext- Overrides:
setRegisterValuein classAbstractStoredProgramContext- Parameters:
start- the start address to set valuesend- the end address to set valuesvalue- the actual values to store at address- Throws:
ContextChangeException
-
setLanguage
public void setLanguage(LanguageTranslator translator, CompilerSpec newCompilerSpec, AddressSetView programMemory, TaskMonitor monitor) throws CancelledException
Perform context upgrade due to a language change- Parameters:
translator- language translator required by major upgrades (may be null)newCompilerSpec- new compiler specificationprogramMemory- program memorymonitor- task monitor- Throws:
CancelledException- thrown if monitor cancelled
-
flushProcessorContextWriteCache
public void flushProcessorContextWriteCache()
Description copied from class:AbstractStoredProgramContextFlush any cached context not yet written to database- Overrides:
flushProcessorContextWriteCachein classAbstractStoredProgramContext
-
invalidateProcessorContextWriteCache
public void invalidateProcessorContextWriteCache()
Description copied from class:AbstractStoredProgramContextFlush any cached context not yet written to database- Overrides:
invalidateProcessorContextWriteCachein classAbstractStoredProgramContext
-
getRegisterValueAddressRanges
public AddressRangeIterator getRegisterValueAddressRanges(Register register)
Description copied from interface:ProgramContextReturns an AddressRangeIterator over all addresses that have an associated value for the given register. Each range returned will have the same value associated with the register for all addresses in that range.- Specified by:
getRegisterValueAddressRangesin interfaceProgramContext- Overrides:
getRegisterValueAddressRangesin classAbstractStoredProgramContext- Parameters:
register- the register for which to get set value ranges.- Returns:
- An AddressRangeIterator over all address that have values for the given register.
-
getRegisterValueRangeContaining
public AddressRange getRegisterValueRangeContaining(Register register, Address addr)
Description copied from interface:ProgramContextReturns the bounding address-range containing addr and the the same RegisterValue throughout. The range returned may be limited by other value changes associated with register's base-register.- Specified by:
getRegisterValueRangeContainingin interfaceProgramContext- Overrides:
getRegisterValueRangeContainingin classAbstractStoredProgramContext- Returns:
- single register-value address-range containing addr
-
getRegisterValueAddressRanges
public AddressRangeIterator getRegisterValueAddressRanges(Register register, Address start, Address end)
Description copied from interface:ProgramContextReturns an AddressRangeIterator over all addresses that have an associated value within the given range for the given register. Each range returned will have the same value associated with the register for all addresses in that range.- Specified by:
getRegisterValueAddressRangesin interfaceProgramContext- Overrides:
getRegisterValueAddressRangesin classAbstractStoredProgramContext- Parameters:
register- the register for which to get set value ranges.- Returns:
- An AddressRangeIterator over all address within the given range that have values for the given register.
-
getDefaultRegisterValueAddressRanges
public AddressRangeIterator getDefaultRegisterValueAddressRanges(Register register)
Description copied from interface:ProgramContextReturns an AddressRangeIterator over all addresses that have an associated default value for the given register. Each range returned will have the same default value associated with the register for all addresses in that range.- Specified by:
getDefaultRegisterValueAddressRangesin interfaceProgramContext- Overrides:
getDefaultRegisterValueAddressRangesin classAbstractStoredProgramContext- Parameters:
register- the register for which to get set default value ranges.- Returns:
- An AddressRangeIterator over all address that have default values for the given register.
-
getDefaultRegisterValueAddressRanges
public AddressRangeIterator getDefaultRegisterValueAddressRanges(Register register, Address start, Address end)
Description copied from interface:ProgramContextReturns an AddressRangeIterator over all addresses that have an associated default value within the given range for the given register. Each range returned will have the same default value associated with the register for all addresses in that range.- Specified by:
getDefaultRegisterValueAddressRangesin interfaceProgramContext- Overrides:
getDefaultRegisterValueAddressRangesin classAbstractStoredProgramContext- Parameters:
register- the register for which to get default value ranges.- Returns:
- An AddressRangeIterator over all address within the given range that have default values for the given register.
-
getRegistersWithValues
public Register[] getRegistersWithValues()
Description copied from interface:ProgramContextReturns an array of all registers that at least one value associated with an address.- Specified by:
getRegistersWithValuesin interfaceProgramContext- Overrides:
getRegistersWithValuesin classAbstractStoredProgramContext- Returns:
- a array of all registers that at least one value associated with an address.
-
hasValueOverRange
public boolean hasValueOverRange(Register reg, java.math.BigInteger value, AddressSetView addrSet)
Description copied from interface:ProgramContextReturns true if the given register has the value over the addressSet- Specified by:
hasValueOverRangein interfaceProgramContext- Overrides:
hasValueOverRangein classAbstractStoredProgramContext- Parameters:
reg- the register whose value is to be tested.value- the value to test for.addrSet- the set of addresses to test- Returns:
- true if every address in the addrSet has the value.
-
setDefaultValue
public void setDefaultValue(RegisterValue registerValue, Address start, Address end)
Description copied from interface:DefaultProgramContextAssociates a default value with the given register over the given range.- Specified by:
setDefaultValuein interfaceDefaultProgramContext- Overrides:
setDefaultValuein classAbstractStoredProgramContext- Parameters:
registerValue- the register for which to associate a default value.start- the start address.end- the end address (inclusive)
-
getDefaultValue
public RegisterValue getDefaultValue(Register register, Address address)
Description copied from interface:ProgramContextReturns the default value of a register at a given address.- Specified by:
getDefaultValuein interfaceDefaultProgramContext- Specified by:
getDefaultValuein interfaceProgramContext- Overrides:
getDefaultValuein classAbstractStoredProgramContext- Parameters:
register- the register for which to get a default value.address- the address at which to get a default value.- Returns:
- the default value of the register at the given address or null if no default value has been assigned.
-
getNonDefaultValue
public RegisterValue getNonDefaultValue(Register register, Address address)
Description copied from interface:ProgramContextReturns the (non-default)value assigned to a register at a given address.- Specified by:
getNonDefaultValuein interfaceProgramContext- Overrides:
getNonDefaultValuein classAbstractStoredProgramContext- Parameters:
register- the register for which to get its value.address- the address at which to get a value.- Returns:
- a RegisterValue object containing the value of the register at the given address or possibly null if no value has been assigned.
-
-