Package ghidra.program.database.register
Class OldProgramContextDB
- java.lang.Object
-
- ghidra.program.database.register.OldProgramContextDB
-
- All Implemented Interfaces:
ManagerDB,DefaultProgramContext,ProgramContext
public class OldProgramContextDB extends java.lang.Object implements ProgramContext, DefaultProgramContext, ManagerDB
ProgramContextDBdefines a processor context over an address space using database range maps for storage.
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Map<Register,RegisterValueStore>defaultRegisterValueMap
-
Constructor Summary
Constructors Constructor Description OldProgramContextDB(DBHandle dbHandle, ErrorHandler errHandler, Language language, AddressMap addrMap, Lock lock)Constructs a new ProgramContextDB object
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.longget(Address addr, Register reg)RegistergetBaseContextRegister()Returns the base context register.RegisterValuegetDefaultDisassemblyContext()AddressRangeIteratorgetDefaultRegisterValueAddressRanges(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.RegisterValuegetDisassemblyContext(Address address)Get the disassembly context for a specified address.RegisterValuegetFlowValue(RegisterValue value)Modify register value to eliminate non-flowing bitsRegisterValuegetNonDefaultValue(Register register, Address address)Returns the (non-default)value assigned to a register at a given address.RegisterValuegetNonFlowValue(RegisterValue value)Modify register value to only include non-flowing bitsRegister[]getProcessorStateRegisters()Gets the registers for this context that are used for processor context states.RegistergetRegister(java.lang.String name)Get a Register object given the name of a registerjava.lang.String[]getRegisterNames()Returns the list of register namesRegister[]getRegisters()Get all the register descriptions defined for this program context.Register[]getRegistersWithValues()Returns an array of all registers that at least one value associated with an address.RegisterValuegetRegisterValue(Register register, Address address)Returns a register value and mask for the given register.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.ghidra.program.database.register.RegisterValueRange[]getRegisterValues(Register reg, Address start, Address end)longgetSigned(Address addr, Register reg)java.math.BigIntegergetValue(Register register, Address address, boolean signed)Returns the value assigned to a register at a given address.booleanhasNonFlowingContext()booleanhasValueOverRange(Register reg, java.math.BigInteger value, AddressSetView addrSet)Returns true if the given register has the value over the addressSetvoidinvalidateCache(boolean all)Clears all data caches.voidmoveAddressRange(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.voidset(Address start, Address end, Register reg, long value)voidsetDefaultDisassemblyContext(RegisterValue newContext)Set the initial disassembly context to be used when initiating disassmblyvoidsetDefaultValue(RegisterValue registerValue, Address start, Address end)Associates a default value with the given register over the given range.voidsetProgram(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.
-
-
-
Field Detail
-
defaultRegisterValueMap
protected java.util.Map<Register,RegisterValueStore> defaultRegisterValueMap
-
-
Constructor Detail
-
OldProgramContextDB
public OldProgramContextDB(DBHandle dbHandle, ErrorHandler errHandler, Language language, AddressMap addrMap, Lock lock)
Constructs a new ProgramContextDB object- Parameters:
dbHandle- the handle to the database.openMode- the mode that the program is opened.errHandler- the error handlerlanguage- the processor languageaddrMap- the address map.lock- the program synchronization lockmonitor- the taskmonitor used if upgrading.- Throws:
VersionException- thrown if the database is the save version as this class.CancelledException- thrown if the user cancels the upgrade.java.io.IOException- thrown if a database io error occurs.
-
-
Method Detail
-
deleteAddressRange
public void deleteAddressRange(Address start, Address end, TaskMonitor monitor) throws CancelledException
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- 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.- Throws:
CancelledException- if the user cancelled the operation via the task monitor.
-
getBaseContextRegister
public Register getBaseContextRegister()
Description copied from interface:ProgramContextReturns the base context register.- Specified by:
getBaseContextRegisterin interfaceProgramContext- Returns:
- the base context 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- 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- 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.
-
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- 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- 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.
-
getProcessorStateRegisters
public Register[] getProcessorStateRegisters()
Description copied from interface:ProgramContextGets the registers for this context that are used for processor context states.- Specified by:
getProcessorStateRegistersin interfaceProgramContext- Returns:
- all processor context registers
-
getRegister
public Register getRegister(java.lang.String name)
Description copied from interface:ProgramContextGet a Register object given the name of a register- Specified by:
getRegisterin interfaceProgramContext- Parameters:
name- the name of the register.- Returns:
- The register with the given name or null if no register has that name.
-
getRegisterNames
public java.lang.String[] getRegisterNames()
Description copied from interface:ProgramContextReturns the list of register names- Specified by:
getRegisterNamesin interfaceProgramContext
-
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- Parameters:
register- the register for which to get set value ranges.- Returns:
- An AddressRangeIterator over all address that have values for the given register.
-
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- 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.
-
getRegisterValues
public ghidra.program.database.register.RegisterValueRange[] getRegisterValues(Register reg, Address start, Address end)
-
getRegisters
public Register[] getRegisters()
Description copied from interface:ProgramContextGet all the register descriptions defined for this program context.- Specified by:
getRegistersin interfaceProgramContext- Returns:
- array of defined register descriptions
-
getSigned
public long getSigned(Address addr, Register reg) throws java.lang.UnsupportedOperationException
- Throws:
java.lang.UnsupportedOperationException
-
getRegisterValue
public RegisterValue getRegisterValue(Register register, Address address)
Description copied from interface:ProgramContextReturns a register value and mask for the given register.- Specified by:
getRegisterValuein interfaceProgramContext- Parameters:
register- the registeraddress- the address of the value- Returns:
- a register value and mask for the given register
-
getValue
public java.math.BigInteger getValue(Register register, Address address, boolean signed)
Description copied from interface:ProgramContextReturns the value assigned to a register at a given address. This method will return any default value assigned to the register at the given address if no explicit value has been set at that address.- Specified by:
getValuein interfaceProgramContext- Parameters:
register- the register for which to get its value.address- the address at which to get a value.signed- if true, interprets the fix-bit size register value as a signed value.- Returns:
- a BigInteger object containing the value of the registe at the given address or null if no value has been assigned.
-
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- 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.
-
remove
public void remove(Address start, Address end, Register register)
Description copied from interface:ProgramContextRemove (unset) the register values for a given address range.- Specified by:
removein interfaceProgramContext- Parameters:
start- starting address.end- ending adddress.register- handle to the register to be set.
-
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- Parameters:
registerValue- the register for which to associate a default value.start- the start address.end- the end address (inclusive)
-
setValue
public void setValue(Register register, Address start, Address end, java.math.BigInteger value)
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- 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.
-
setRegisterValue
public void setRegisterValue(Address start, Address end, RegisterValue value)
Description copied from interface:ProgramContextSets the register context over the given range to the given value.- Specified by:
setRegisterValuein interfaceProgramContext- Parameters:
start- the start address to set valuesend- the end address to set valuesvalue- the actual values to store at address
-
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- 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.
-
getDefaultDisassemblyContext
public RegisterValue getDefaultDisassemblyContext()
- Specified by:
getDefaultDisassemblyContextin interfaceProgramContext- Returns:
- Get the current default disassembly context to be used when initiating disassmbly
-
setDefaultDisassemblyContext
public void setDefaultDisassemblyContext(RegisterValue newContext)
Description copied from interface:ProgramContextSet the initial disassembly context to be used when initiating disassmbly- Specified by:
setDefaultDisassemblyContextin interfaceProgramContext- Parameters:
newContext- context register value
-
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- Returns:
- a array of all registers that at least one value associated with an address.
-
getDisassemblyContext
public RegisterValue getDisassemblyContext(Address address)
Description copied from interface:ProgramContextGet the disassembly context for a specified address. This context is formed from the default disassembly context and the context register value stored at the specified address. Those bits specified by the stored context value take precedence.- Specified by:
getDisassemblyContextin interfaceProgramContext- Returns:
- disassembly context register value
-
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- Returns:
- single register-value address-range containing addr
-
hasNonFlowingContext
public boolean hasNonFlowingContext()
- Specified by:
hasNonFlowingContextin interfaceProgramContext- Returns:
- true if one or more non-flowing context registers fields have been defined within the base processor context register.
-
getFlowValue
public RegisterValue getFlowValue(RegisterValue value)
Description copied from interface:ProgramContextModify register value to eliminate non-flowing bits- Specified by:
getFlowValuein interfaceProgramContext- Returns:
- value suitable for flowing
-
getNonFlowValue
public RegisterValue getNonFlowValue(RegisterValue value)
Description copied from interface:ProgramContextModify register value to only include non-flowing bits- Specified by:
getNonFlowValuein interfaceProgramContext- Returns:
- new value or null
-
-