Package ghidra.program.database.mem
Class MemoryMapDB
java.lang.Object
ghidra.program.database.mem.MemoryMapDB
- All Implemented Interfaces:
ManagerDB
,AddressSetView
,LiveMemoryListener
,Memory
,Iterable<AddressRange>
The database memory map manager.
-
Field Summary
Fields inherited from interface ghidra.program.model.mem.Memory
GBYTE, GBYTE_SHIFT_FACTOR, MAX_BINARY_SIZE, MAX_BINARY_SIZE_GB, MAX_BLOCK_SIZE, MAX_BLOCK_SIZE_GB
-
Constructor Summary
ConstructorDescriptionMemoryMapDB
(DBHandle handle, AddressMapDB addrMap, OpenMode openMode, boolean isBigEndian, Lock lock, TaskMonitor monitor) Constructs a new MemoryMapDB -
Method Summary
Modifier and TypeMethodDescriptionboolean
Test if the address is contained within this set.boolean
Test if the given address range is contained in this set.boolean
Test if the given address set is a subset of this set.convertToInitialized
(MemoryBlock uninitializedBlock, byte initialValue) Convert an existing uninitialized block with an initialized block.convertToUninitialized
(MemoryBlock initializedBlock) createBitMappedBlock
(String name, Address start, Address mappedAddress, long length, boolean overlay) Create a bit-mapped overlay memory block and add it to this Memory.createBlock
(MemoryBlock block, String name, Address start, long length) Creates a MemoryBlock at the given address with the same properties as block, and adds it to this Memory.createByteMappedBlock
(String name, Address start, Address mappedAddress, long length, ByteMappingScheme byteMappingScheme, boolean overlay) Create a byte-mapped memory block and add it to this memory.createFileBytes
(String filename, long offset, long size, InputStream is, TaskMonitor monitor) Stores a sequence of bytes into the program.createInitializedBlock
(String name, Address start, long size, byte initialValue, TaskMonitor monitor, boolean overlay) Create an initialized memory block initialized and add it to this Memory.createInitializedBlock
(String name, Address start, FileBytes fileBytes, long offset, long length, boolean overlay) Create an initialized memory block using bytes from aFileBytes
object.createInitializedBlock
(String name, Address start, InputStream is, long length, TaskMonitor monitor, boolean overlay) Create an initialized memory block based upon a dataInputStream
and add it to this Memory.createUninitializedBlock
(String name, Address start, long size, boolean overlay) Create an uninitialized memory block and add it to this Memory.void
deleteAddressRange
(Address startAddr, Address endAddr, TaskMonitor monitor) Delete all objects which have been applied to the address range startAddr to endAddr and update the database accordingly.boolean
deleteFileBytes
(FileBytes fileBytes) Deletes a stored sequence of file bytes.boolean
findBytes
(Address addr, byte[] bytes, byte[] masks, boolean forward, TaskMonitor monitor) Finds a sequence of contiguous bytes that match the given byte array at all bit positions where the mask contains an "on" bit.findBytes
(Address startAddr, Address endAddr, byte[] bytes, byte[] masks, boolean forward, TaskMonitor monitor) Finds a sequence of contiguous bytes that match the given byte array at all bit positions where the mask contains an "on" bit.Finds the first address in this collection that is also in the given addressSet.getAddresses
(boolean forward) Returns an iterator over all addresses in this set.getAddresses
(Address start, boolean forward) Returns an iterator over the addresses in this address set starting at the start addressgetAddressRanges
(boolean forward) Returns an iterator over the ranges in the specified ordergetAddressRanges
(Address start, boolean forward) Returns an iterator of address ranges starting with the range that contains the given address.getAddressSourceInfo
(Address address) Returns information (AddressSourceInfo
) about the byte source at the given address.Returns a list of all the stored original file bytes objectsReturns the set of addresses which correspond to all memory blocks that have initialized data.Returns the Block which contains addr.Returns the Block with the specified blockNameReturns an array containing all the memory blocks.byte
Get byte at addr.int
Get dest.length number of bytes starting at the given address.int
Get size number of bytes starting at the given address and populates dest starting at dIndex.Returns the set of addresses which correspond to the executable memory.Returns the first range in this set or null if the set is empty;UseMemory.getLoadedAndInitializedAddressSet()
instead.int
Get the int at addr.int
Get the int at addr using the specified endian order.int
Get dest.length number of ints starting at the given address.int
Get dest.length number of ints starting at the given address.int
Get dest.length number of ints starting at the given address.Returns the last range in this set or null if the set is empty;Returns the live memory handler instance used by this memory.Returns the set of addresses which correspond to all the "loaded" memory blocks that have initialized data.long
Get the long at addr.long
Get the long at addr in the specified endian order.int
Get dest.length number of longs starting at the given address.int
Get dest.length number of longs starting at the given address.int
Get dest.length number of longs starting at the given address.Get the maximum address for this address set.Get the minimum address for this address set.long
int
Returns the program that this memory belongs to.getRangeContaining
(Address address) Returns the range that contains the given addressshort
Get the short at addr.short
Get the short at addr using the specified endian order.int
Get dest.length number of shorts starting at the given address.int
Get dest.length number of shorts starting at the given address.int
Get dest.length number of shorts starting at the given address.long
getSize()
Get the memory size in bytes.int
hashCode()
boolean
Returns true if the given address set contains the same set of addresses as this set.intersect
(AddressSetView set) Computes the intersection of this address set with the given address set.intersectRange
(Address start, Address end) Computes the intersection of this address set with the given address range.boolean
intersects
(Address start, Address end) Determine if the start and end range intersects with the specified address set.boolean
intersects
(AddressSetView set) Determine if this address set intersects with the specified address set.void
invalidateCache
(boolean all) Clears all data caches.boolean
Returns true if the memory is bigEndian, false otherwise.boolean
isEmpty()
boolean
Determine if the specified address is contained within the reserved EXTERNAL block (seeMemoryBlock.EXTERNAL_BLOCK_NAME
).iterator()
Returns an iterator over the address ranges in this address set.iterator
(boolean forward) Returns an iterator over the ranges in the specified orderReturns an iterator of address ranges starting with the range that contains the given address.join
(MemoryBlock blockOne, MemoryBlock blockTwo) Join the two blocks to create a single memory block.void
memoryChanged
(Address addr, int size) void
moveAddressRange
(Address fromAddr, Address toAddr, long length, TaskMonitor monitor) Move all objects within an address range to a new location.void
moveBlock
(MemoryBlock block, Address newStartAddr, TaskMonitor monitor) Move the memory block containing source address to the destination address.void
programReady
(OpenMode openMode, int currentRevision, TaskMonitor monitor) Callback from program made to each manager after the program has completed initialization.void
removeBlock
(MemoryBlock block, TaskMonitor monitor) Remove the memory block.void
Write byte at addr.void
Write size bytes from values at addr.void
Write an array of bytes.void
Write int at addr in the default endian order.void
Write int at addr in the specified endian order.void
setLanguage
(Language newLanguage) void
setLiveMemoryHandler
(LiveMemoryHandler handler) Sets the live memory handlervoid
Write long at addr in the default endian order.void
Write long at addr in the specified endian order.void
setProgram
(ProgramDB program) Set the program.void
Write short at addr in default endian order.void
Write short at addr in the specified endian order.void
split
(MemoryBlock block, Address addr) Split a block at the given addr and create a new block starting at addr.subtract
(AddressSetView set) Computes the difference of this address set with the given address set (this - set).final String
toString()
union
(AddressSetView set) Computes the union of this address set with the given address set.xor
(AddressSetView set) Computes the exclusive-or of this address set with the given set.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface ghidra.program.model.address.AddressSetView
getAddressCountBefore
Methods inherited from interface java.lang.Iterable
forEach, spliterator
Methods inherited from interface ghidra.program.model.mem.Memory
createByteMappedBlock, locateAddressesForFileBytesOffset, locateAddressesForFileOffset
-
Constructor Details
-
MemoryMapDB
public MemoryMapDB(DBHandle handle, AddressMapDB addrMap, OpenMode openMode, boolean isBigEndian, Lock lock, TaskMonitor monitor) throws IOException, VersionException Constructs a new MemoryMapDB- Parameters:
handle
- the open database handle.addrMap
- the address map.openMode
- the open mode for the program.isBigEndian
- endianness flaglock
- the program synchronization lockmonitor
- Task monitor for upgrading- Throws:
IOException
- if a database io error occurs.VersionException
- if the database version is different from the expected version
-
-
Method Details
-
getProgram
Description copied from interface:Memory
Returns the program that this memory belongs to.- Specified by:
getProgram
in interfaceMemory
-
invalidateCache
Description copied from interface:ManagerDB
Clears all data caches.- Specified by:
invalidateCache
in 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:
IOException
- if a database io error occurs.
-
setLanguage
-
setProgram
Set the program.- Specified by:
setProgram
in interfaceManagerDB
- Parameters:
program
- the program is set when all the initializations have been completed.
-
programReady
public void programReady(OpenMode openMode, int currentRevision, TaskMonitor monitor) throws IOException, CancelledException Description copied from interface:ManagerDB
Callback 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:
programReady
in 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:
IOException
- if a database io error occurs.CancelledException
- if the user cancelled the operation via the task monitor.
-
getInitializedAddressSet
Description copied from interface:Memory
UseMemory.getLoadedAndInitializedAddressSet()
instead.- Specified by:
getInitializedAddressSet
in interfaceMemory
-
getAllInitializedAddressSet
Description copied from interface:Memory
Returns the set of addresses which correspond to all memory blocks that have initialized data. This includes initialized memory blocks that contain data from the program's file header that are not actually in the running in memory image, such as debug sections. UseMemory.getLoadedAndInitializedAddressSet()
if you only want the addressed of the loaded in memory blocks.- Specified by:
getAllInitializedAddressSet
in interfaceMemory
-
getLoadedAndInitializedAddressSet
Description copied from interface:Memory
Returns the set of addresses which correspond to all the "loaded" memory blocks that have initialized data. This does not include initialized memory blocks that contain data from the program's file header such as debug sections.- Specified by:
getLoadedAndInitializedAddressSet
in interfaceMemory
-
isExternalBlockAddress
Description copied from interface:Memory
Determine if the specified address is contained within the reserved EXTERNAL block (seeMemoryBlock.EXTERNAL_BLOCK_NAME
). This artificial memory block has certain limitations that may require associated addresses to be properly identified. All data access/referencing has the biggest exposure since the importers generally allocate a fixed and possibly insufficient amount of memory to corresponding data symbols. Any pointer math performed based upon an EXTERNAL block symbol address is likely to produce an unuseable address that may collide with unrelated symbols stored within the memory block (e.g.,OffsetReference
is one such example).- Specified by:
isExternalBlockAddress
in interfaceMemory
- Parameters:
addr
- address- Returns:
- true if address is contained within EXTERNAL memory block, else false.
-
getExecuteSet
Description copied from interface:Memory
Returns the set of addresses which correspond to the executable memory.- Specified by:
getExecuteSet
in interfaceMemory
-
getBlock
Description copied from interface:Memory
Returns the Block which contains addr. -
getBlock
Description copied from interface:Memory
Returns the Block with the specified blockName -
isBigEndian
public boolean isBigEndian()Description copied from interface:Memory
Returns true if the memory is bigEndian, false otherwise.- Specified by:
isBigEndian
in interfaceMemory
-
setLiveMemoryHandler
Description copied from interface:Memory
Sets the live memory handler- Specified by:
setLiveMemoryHandler
in interfaceMemory
- Parameters:
handler
- the live memory handler
-
getLiveMemoryHandler
Description copied from interface:Memory
Returns the live memory handler instance used by this memory.- Specified by:
getLiveMemoryHandler
in interfaceMemory
- Returns:
- the live memory handler
-
createInitializedBlock
public MemoryBlock createInitializedBlock(String name, Address start, long size, byte initialValue, TaskMonitor monitor, boolean overlay) throws LockException, MemoryConflictException, AddressOverflowException, CancelledException Description copied from interface:Memory
Create an initialized memory block initialized and add it to this Memory. All bytes will be initialized to the specified value (NOTE: use of zero as the initial value is encouraged for reduced storage).Overlay Blocks: An overlay memory block may be created in two ways:
- Specifying a
start
address within an existing overlay address space (overlay
parameter is ignored), or - Specifying a
start
address within a physical memory address space and passingoverlay=true
. This use case will force the creation of a new unique overlay address space.
- Specified by:
createInitializedBlock
in interfaceMemory
- Parameters:
name
- block name (SeeMemory.isValidMemoryBlockName(String)
for naming rules)start
- start of the blocksize
- block length (positive non-zero value required)initialValue
- initialization value for every byte in the block.monitor
- progress monitor, may be null.overlay
- if true, the block will be created as an OVERLAY block. If thestart
address is a non-overlay memory address a new overlay address space will be created and the block will have a starting address at the same offset within the new overlay space. If the specifiedstart
address is an overlay address an overlay block will be created at that overlay address.- Returns:
- new Initialized Memory Block
- Throws:
LockException
- if exclusive lock not in place (see haveLock())MemoryConflictException
- if the new block overlaps with a previous blockAddressOverflowException
- if block specification exceeds bounds of address spaceCancelledException
- user cancelled operation
- Specifying a
-
createInitializedBlock
public MemoryBlock createInitializedBlock(String name, Address start, InputStream is, long length, TaskMonitor monitor, boolean overlay) throws MemoryConflictException, AddressOverflowException, CancelledException, LockException Description copied from interface:Memory
Create an initialized memory block based upon a dataInputStream
and add it to this Memory.Overlay Blocks: An overlay memory block may be created in two ways:
- Specifying a
start
address within an existing overlay address space (overlay
parameter is ignored), or - Specifying a
start
address within a physical memory address space and passingoverlay=true
. This use case will force the creation of a new unique overlay address space.
- Specified by:
createInitializedBlock
in interfaceMemory
- Parameters:
name
- block name (SeeMemory.isValidMemoryBlockName(String)
for naming rules)start
- start address of the blockis
- source of the data used to fill the block or null for zero initialization.length
- the size of the blockmonitor
- task monitoroverlay
- if true, the block will be created as an OVERLAY block. If thestart
address is a non-overlay memory address a new overlay address space will be created and the block will have a starting address at the same offset within the new overlay space. If the specifiedstart
address is an overlay address an overlay block will be created at that overlay address.- Returns:
- new Initialized Memory Block
- Throws:
MemoryConflictException
- if the new block overlaps with a previous blockAddressOverflowException
- if block specification exceeds bounds of address spaceCancelledException
- user cancelled operationLockException
- if exclusive lock not in place (see haveLock())
- Specifying a
-
createInitializedBlock
public MemoryBlock createInitializedBlock(String name, Address start, FileBytes fileBytes, long offset, long length, boolean overlay) throws LockException, MemoryConflictException, AddressOverflowException, IndexOutOfBoundsException Description copied from interface:Memory
Create an initialized memory block using bytes from aFileBytes
object.Overlay Blocks: An overlay memory block may be created in two ways:
- Specifying a
start
address within an existing overlay address space (overlay
parameter is ignored), or - Specifying a
start
address within a physical memory address space and passingoverlay=true
. This use case will force the creation of a new unique overlay address space.
- Specified by:
createInitializedBlock
in interfaceMemory
- Parameters:
name
- block name (SeeMemory.isValidMemoryBlockName(String)
for naming rules)start
- starting address of the blockfileBytes
- theFileBytes
object to use as the underlying source of bytes.offset
- the offset into the FileBytes for the first byte of this memory block.length
- block length (positive non-zero value required)overlay
- if true, the block will be created as an OVERLAY block. If thestart
address is a non-overlay memory address a new overlay address space will be created and the block will have a starting address at the same offset within the new overlay space. If the specifiedstart
address is an overlay address an overlay block will be created at that overlay address.- Returns:
- new Initialized Memory Block
- Throws:
LockException
- if exclusive lock not in place (see haveLock())MemoryConflictException
- if the new block overlaps with a previous blockAddressOverflowException
- if block specification exceeds bounds of address spaceIndexOutOfBoundsException
- if file bytes range specified by offset and size is out of bounds for the specified fileBytes.
- Specifying a
-
createUninitializedBlock
public MemoryBlock createUninitializedBlock(String name, Address start, long size, boolean overlay) throws MemoryConflictException, AddressOverflowException, LockException Description copied from interface:Memory
Create an uninitialized memory block and add it to this Memory.Overlay Blocks: An overlay memory block may be created in two ways:
- Specifying a
start
address within an existing overlay address space (overlay
parameter is ignored), or - Specifying a
start
address within a physical memory address space and passingoverlay=true
. This use case will force the creation of a new unique overlay address space.
- Specified by:
createUninitializedBlock
in interfaceMemory
- Parameters:
name
- block name (SeeMemory.isValidMemoryBlockName(String)
for naming rules)start
- start of the blocksize
- block lengthoverlay
- if true, the block will be created as an OVERLAY block. If thestart
address is a non-overlay memory address a new overlay address space will be created and the block will have a starting address at the same offset within the new overlay space. If the specifiedstart
address is an overlay address an overlay block will be created at that overlay address.- Returns:
- new Uninitialized Memory Block
- Throws:
MemoryConflictException
- if the new block overlaps with a previous blockAddressOverflowException
- if block specification exceeds bounds of address spaceLockException
- if exclusive lock not in place (see haveLock())
- Specifying a
-
createBitMappedBlock
public MemoryBlock createBitMappedBlock(String name, Address start, Address mappedAddress, long length, boolean overlay) throws MemoryConflictException, AddressOverflowException, LockException, IllegalArgumentException Description copied from interface:Memory
Create a bit-mapped overlay memory block and add it to this Memory. Each byte address within the resulting memory block will correspond to a single bit location within the mapped region specified bymappedAddress
.Overlay Blocks: An overlay memory block may be created in two ways:
- Specifying a
start
address within an existing overlay address space (overlay
parameter is ignored), or - Specifying a
start
address within a physical memory address space and passingoverlay=true
. This use case will force the creation of a new unique overlay address space.
- Specified by:
createBitMappedBlock
in interfaceMemory
- Parameters:
name
- block name (SeeMemory.isValidMemoryBlockName(String)
for naming rules)start
- start of the blockmappedAddress
- start address in the source block for the beginning of this blocklength
- block lengthoverlay
- if true, the block will be created as an OVERLAY block. If thestart
address is a non-overlay memory address a new overlay address space will be created and the block will have a starting address at the same offset within the new overlay space. If the specifiedstart
address is an overlay address an overlay block will be created at that overlay address.- Returns:
- new Bit Memory Block
- Throws:
MemoryConflictException
- if the new block overlaps with a previous blockMemoryConflictException
- if the new block overlaps with a previous blockAddressOverflowException
- if block specification exceeds bounds of address spaceLockException
- if exclusive lock not in place (see haveLock())IllegalArgumentException
- if invalid block name specified
- Specifying a
-
createByteMappedBlock
public MemoryBlock createByteMappedBlock(String name, Address start, Address mappedAddress, long length, ByteMappingScheme byteMappingScheme, boolean overlay) throws MemoryConflictException, AddressOverflowException, LockException Description copied from interface:Memory
Create a byte-mapped memory block and add it to this memory. Each byte address within the resulting memory block will correspond to a byte within the mapped region specified bymappedAddress
. While a 1:1 byte-mapping is the default, a specific byte-mapping ratio may be specified.Overlay Blocks: An overlay memory block may be created in two ways:
- Specifying a
start
address within an existing overlay address space (overlay
parameter is ignored), or - Specifying a
start
address within a physical memory address space and passingoverlay=true
. This use case will force the creation of a new unique overlay address space.
- Specified by:
createByteMappedBlock
in interfaceMemory
- Parameters:
name
- block name (SeeMemory.isValidMemoryBlockName(String)
for naming rules)start
- start of the blockmappedAddress
- start address in the source block for the beginning of this blocklength
- block lengthbyteMappingScheme
- byte mapping scheme (may be null for 1:1 mapping)overlay
- if true, the block will be created as an OVERLAY block. If thestart
address is a non-overlay memory address a new overlay address space will be created and the block will have a starting address at the same offset within the new overlay space. If the specifiedstart
address is an overlay address an overlay block will be created at that overlay address.- Returns:
- new Bit Memory Block
- Throws:
MemoryConflictException
- if the new block overlaps with a previous blockAddressOverflowException
- if block specification exceeds bounds of address spaceLockException
- if exclusive lock not in place (see haveLock())
- Specifying a
-
createBlock
public MemoryBlock createBlock(MemoryBlock block, String name, Address start, long length) throws MemoryConflictException, AddressOverflowException, LockException Description copied from interface:Memory
Creates a MemoryBlock at the given address with the same properties as block, and adds it to this Memory. Initialized Default blocks will have block filled with 0's. Method will only create physical space blocks and will not create an overlay block.- Specified by:
createBlock
in interfaceMemory
- Parameters:
block
- source blockname
- block name (SeeMemory.isValidMemoryBlockName(String)
for naming rules).start
- start of the blocklength
- the size of the new block.- Returns:
- new block
- Throws:
MemoryConflictException
- if block specification conflicts with an existing blockAddressOverflowException
- if block specification exceeds bounds of address spaceLockException
- if exclusive lock not in place (see haveLock())
-
getSize
public long getSize()Description copied from interface:Memory
Get the memory size in bytes. -
getBlocks
Description copied from interface:Memory
Returns an array containing all the memory blocks. -
moveBlock
public void moveBlock(MemoryBlock block, Address newStartAddr, TaskMonitor monitor) throws MemoryBlockException, MemoryConflictException, AddressOverflowException, NotFoundException, LockException Description copied from interface:Memory
Move the memory block containing source address to the destination address.- Specified by:
moveBlock
in interfaceMemory
- Parameters:
block
- block to be movednewStartAddr
- new start address for blockmonitor
- task monitor so the move block can be canceled- Throws:
MemoryBlockException
- if block movement is not permittedMemoryConflictException
- if move would cause blocks to overlap.AddressOverflowException
- if block movement would violate bounds of address spaceNotFoundException
- if memoryBlock does not exist in this memory.LockException
- if exclusive lock not in place (see haveLock())
-
split
public void split(MemoryBlock block, Address addr) throws MemoryBlockException, NotFoundException, LockException Description copied from interface:Memory
Split a block at the given addr and create a new block starting at addr.- Specified by:
split
in interfaceMemory
- Parameters:
block
- block to be split into twoaddr
- address (within block) that will be the start of new block- Throws:
MemoryBlockException
- memory split not permittedNotFoundException
- thrown if block does not exist in memoryLockException
- if exclusive lock not in place (see haveLock())
-
join
public MemoryBlock join(MemoryBlock blockOne, MemoryBlock blockTwo) throws MemoryBlockException, NotFoundException, LockException Description copied from interface:Memory
Join the two blocks to create a single memory block. IMPORTANT! When done, both blockOne and blockTwo should no longer be used.- Specified by:
join
in interfaceMemory
- Parameters:
blockOne
- block to be combined with blockTwoblockTwo
- block to be combined with blockOne- Returns:
- new block
- Throws:
MemoryBlockException
- thrown if the blocks are not contiguous in the address space,LockException
- if exclusive lock not in place (see haveLock())NotFoundException
-
convertToInitialized
public MemoryBlock convertToInitialized(MemoryBlock uninitializedBlock, byte initialValue) throws MemoryBlockException, NotFoundException, LockException Description copied from interface:Memory
Convert an existing uninitialized block with an initialized block.- Specified by:
convertToInitialized
in interfaceMemory
- Parameters:
uninitializedBlock
- uninitialized block to convertinitialValue
- initial value for the bytes- Throws:
MemoryBlockException
- if there is no block in memory at the same address as block or if the block lengths are not the same.LockException
- if exclusive lock not in place (see haveLock())NotFoundException
-
convertToUninitialized
public MemoryBlock convertToUninitialized(MemoryBlock initializedBlock) throws MemoryBlockException, NotFoundException, LockException - Specified by:
convertToUninitialized
in interfaceMemory
- Throws:
MemoryBlockException
NotFoundException
LockException
-
findBytes
public Address findBytes(Address addr, byte[] bytes, byte[] masks, boolean forward, TaskMonitor monitor) Description copied from interface:Memory
Finds a sequence of contiguous bytes that match the given byte array at all bit positions where the mask contains an "on" bit. Search is performed over loaded memory only.- Specified by:
findBytes
in interfaceMemory
- Parameters:
addr
- The beginning address in memory to search.bytes
- the array of bytes to search for.masks
- the array of masks. (One for each byte in the byte array) if all bits of each byte is to be checked (ie: all mask bytes are 0xff), then pass a null for masks.forward
- if true, search in the forward direction.- Returns:
- The address of where the first match is found. Null is returned if there is no match.
-
findBytes
public Address findBytes(Address startAddr, Address endAddr, byte[] bytes, byte[] masks, boolean forward, TaskMonitor monitor) Description copied from interface:Memory
Finds a sequence of contiguous bytes that match the given byte array at all bit positions where the mask contains an "on" bit. Starts at startAddr and ends at endAddr. If forward is true, search starts at startAddr and will end if startAddr ">" endAddr. If forward is false, search starts at start addr and will end if startAddr "<" endAddr.- Specified by:
findBytes
in interfaceMemory
- Parameters:
startAddr
- The beginning address in memory to search.endAddr
- The ending address in memory to search (inclusive).bytes
- the array of bytes to search for.masks
- the array of masks. (One for each byte in the byte array) if all bits of each byte is to be checked (ie: all mask bytes are 0xff), then pass a null for masks.forward
- if true, search in the forward direction.- Returns:
- The address of where the first match is found. Null is returned if there is no match.
-
getByte
Description copied from interface:Memory
Get byte at addr.- Specified by:
getByte
in interfaceMemory
- Parameters:
addr
- the Address of the byte.- Returns:
- the byte.
- Throws:
MemoryAccessException
- if the address is not contained in any memory block.
-
getBytes
Description copied from interface:Memory
Get dest.length number of bytes starting at the given address.- Specified by:
getBytes
in interfaceMemory
- Parameters:
addr
- the starting Address.dest
- the byte array to populate.- Returns:
- the number of bytes put into dest. May be less than dest.length if the requested number extends beyond available memory.
- Throws:
MemoryAccessException
- if the starting address is not contained in any memory block.
-
getBytes
Description copied from interface:Memory
Get size number of bytes starting at the given address and populates dest starting at dIndex.- Specified by:
getBytes
in interfaceMemory
- Parameters:
addr
- the starting Address.dest
- the byte array to populate.dIndex
- the offset into dest to place the bytes.size
- the number of bytes to get.- Returns:
- the number of bytes put into dest. May be less than size if the requested number extends beyond initialized / available memory.
- Throws:
MemoryAccessException
- if the starting address is not contained in any memory block or is an uninitialized location.
-
getShort
Description copied from interface:Memory
Get the short at addr.- Specified by:
getShort
in interfaceMemory
- Parameters:
addr
- the Address where the short starts.- Returns:
- the short.
- Throws:
MemoryAccessException
- if not all needed bytes are contained in initialized memory.
-
getShort
Description copied from interface:Memory
Get the short at addr using the specified endian order.- Specified by:
getShort
in interfaceMemory
- Parameters:
addr
- the Address where the short starts.isBigEndian
- true means to get the short in bigEndian order- Returns:
- the short.
- Throws:
MemoryAccessException
- if not all needed bytes are contained in initialized memory.
-
getShorts
Description copied from interface:Memory
Get dest.length number of shorts starting at the given address.- Specified by:
getShorts
in interfaceMemory
- Parameters:
addr
- the starting Address.dest
- the short array to populate.- Returns:
- the number of shorts put into dest. May be less than dest.length if the requested number extends beyond available memory. If the number of retrievable bytes is odd, the final byte will be discarded.
- Throws:
MemoryAccessException
- if not all needed bytes are contained in initialized memory.
-
getShorts
public int getShorts(Address addr, short[] dest, int dIndex, int nElem) throws MemoryAccessException Description copied from interface:Memory
Get dest.length number of shorts starting at the given address.- Specified by:
getShorts
in interfaceMemory
- Parameters:
addr
- the starting Address.dest
- the short array to populate.dIndex
- the offset into dest to place the shorts.nElem
- the number of shorts to get.- Returns:
- the number of shorts put into dest. May be less than dest.length if the requested number extends beyond available memory. If the number of retrievable bytes is odd, the final byte will be discarded.
- Throws:
MemoryAccessException
- if not all needed bytes are contained in initialized memory.
-
getShorts
public int getShorts(Address addr, short[] dest, int dIndex, int nElem, boolean isBigEndian) throws MemoryAccessException Description copied from interface:Memory
Get dest.length number of shorts starting at the given address.- Specified by:
getShorts
in interfaceMemory
- Parameters:
addr
- the starting Address.dest
- the short array to populate.dIndex
- the offset into dest to place the shorts.nElem
- the number of shorts to get.isBigEndian
- true means to get the shorts in bigEndian order- Returns:
- the number of shorts put into dest. May be less than dest.length if the requested number extends beyond available memory. If the number of retrievable bytes is odd, the final byte will be discarded.
- Throws:
MemoryAccessException
- if not all needed bytes are contained in initialized memory.
-
getInt
Description copied from interface:Memory
Get the int at addr.- Specified by:
getInt
in interfaceMemory
- Parameters:
addr
- the Address where the int starts.- Returns:
- the int.
- Throws:
MemoryAccessException
- if not all needed bytes are contained in initialized memory.
-
getInt
Description copied from interface:Memory
Get the int at addr using the specified endian order.- Specified by:
getInt
in interfaceMemory
- Parameters:
addr
- the Address where the int starts.isBigEndian
- true means to get the int in big endian order- Returns:
- the int.
- Throws:
MemoryAccessException
- if not all needed bytes are contained in initialized memory.
-
getInts
Description copied from interface:Memory
Get dest.length number of ints starting at the given address.- Specified by:
getInts
in interfaceMemory
- Parameters:
addr
- the starting Address.dest
- the int array to populate.- Returns:
- the number of ints put into dest. May be less than dest.length if the requested number extends beyond available memory. If the number of retrievable bytes is not 0 mod 4, the final byte(s) will be discarded.
- Throws:
MemoryAccessException
- if the starting address is not contained in any memory block.
-
getInts
Description copied from interface:Memory
Get dest.length number of ints starting at the given address.- Specified by:
getInts
in interfaceMemory
- Parameters:
addr
- the starting Address.dest
- the int array to populate.dIndex
- the offset into dest to place the ints.nElem
- the number of ints to get.- Returns:
- the number of ints put into dest. May be less than dest.length if the requested number extends beyond available memory. If the number of retrievable bytes is not 0 mod 4, the final byte(s) will be discarded.
- Throws:
MemoryAccessException
- if not all needed bytes are contained in initialized memory.
-
getInts
public int getInts(Address addr, int[] dest, int dIndex, int nElem, boolean isBigEndian) throws MemoryAccessException Description copied from interface:Memory
Get dest.length number of ints starting at the given address.- Specified by:
getInts
in interfaceMemory
- Parameters:
addr
- the starting Address.dest
- the int array to populate.dIndex
- the offset into dest to place the ints.nElem
- the number of ints to get.isBigEndian
- true means to get the ints in bigEndian order- Returns:
- the number of ints put into dest. May be less than dest.length if the requested number extends beyond available memory. If the number of retrievable bytes is not 0 mod 4, the final byte(s) will be discarded.
- Throws:
MemoryAccessException
- if not all needed bytes are contained in initialized memory.
-
getLong
Description copied from interface:Memory
Get the long at addr.- Specified by:
getLong
in interfaceMemory
- Parameters:
addr
- the Address where the long starts.- Returns:
- the long.
- Throws:
MemoryAccessException
- if not all needed bytes are contained in initialized memory.
-
getLong
Description copied from interface:Memory
Get the long at addr in the specified endian order.- Specified by:
getLong
in interfaceMemory
- Parameters:
addr
- the Address where the long starts.isBigEndian
- true means to get the long in big endian order- Returns:
- the long.
- Throws:
MemoryAccessException
- if not all needed bytes are contained in initialized memory.
-
getLongs
Description copied from interface:Memory
Get dest.length number of longs starting at the given address.- Specified by:
getLongs
in interfaceMemory
- Parameters:
addr
- the starting Address.dest
- the long array to populate.- Returns:
- the number of longs put into dest. May be less than dest.length if the requested number extends beyond available memory. If the number of retrievable bytes is not 0 mod 8, the final byte(s) will be discarded.
- Throws:
MemoryAccessException
- if not all needed bytes are contained in initialized memory.
-
getLongs
Description copied from interface:Memory
Get dest.length number of longs starting at the given address.- Specified by:
getLongs
in interfaceMemory
- Parameters:
addr
- the starting Address.dest
- the long array to populate.dIndex
- the offset into dest to place the longs.nElem
- the number of longs to get.- Returns:
- the number of longs put into dest. May be less than dest.length if the requested number extends beyond available memory. If the number of retrievable bytes is not 0 mod 8, the final byte(s) will be discarded.
- Throws:
MemoryAccessException
- if not all needed bytes are contained in initialized memory.
-
getLongs
public int getLongs(Address addr, long[] dest, int dIndex, int nElem, boolean isBigEndian) throws MemoryAccessException Description copied from interface:Memory
Get dest.length number of longs starting at the given address.- Specified by:
getLongs
in interfaceMemory
- Parameters:
addr
- the starting Address.dest
- the long array to populate.dIndex
- the offset into dest to place the longs.nElem
- the number of longs to get.isBigEndian
- true means to get the longs in bigEndian order- Returns:
- the number of longs put into dest. May be less than dest.length if the requested number extends beyond available memory. If the number of retrievable bytes is not 0 mod 8, the final byte(s) will be discarded.
- Throws:
MemoryAccessException
- if not all needed bytes are contained in initialized memory.
-
setByte
Description copied from interface:Memory
Write byte at addr.- Specified by:
setByte
in interfaceMemory
- Parameters:
addr
- the Address of the byte.value
- the data to write.- Throws:
MemoryAccessException
- if writing is not allowed.
-
setBytes
Description copied from interface:Memory
Write size bytes from values at addr.- Specified by:
setBytes
in interfaceMemory
- Parameters:
addr
- the starting Address.source
- the bytes to write.- Throws:
MemoryAccessException
- if writing is not allowed.
-
setBytes
public void setBytes(Address address, byte[] source, int sIndex, int size) throws MemoryAccessException Description copied from interface:Memory
Write an array of bytes. This should copy size bytes or fail!- Specified by:
setBytes
in interfaceMemory
- Parameters:
address
- the starting Address of the bytes.source
- an array to get bytes from.sIndex
- the starting source index.size
- the number of bytes to fill.- Throws:
MemoryAccessException
- if writing is not allowed.
-
setShort
Description copied from interface:Memory
Write short at addr in default endian order.- Specified by:
setShort
in interfaceMemory
- Parameters:
addr
- the Address of the short.value
- the data to write.- Throws:
MemoryAccessException
- if writing is not allowed.
-
setShort
Description copied from interface:Memory
Write short at addr in the specified endian order.- Specified by:
setShort
in interfaceMemory
- Parameters:
addr
- the Address of the short.value
- the data to write.isBigEndian
- true means to write short in big endian order- Throws:
MemoryAccessException
- if writing is not allowed.
-
setInt
Description copied from interface:Memory
Write int at addr in the default endian order.- Specified by:
setInt
in interfaceMemory
- Parameters:
addr
- the Address of the int.value
- the data to write.- Throws:
MemoryAccessException
- if writing is not allowed.
-
setInt
Description copied from interface:Memory
Write int at addr in the specified endian order.- Specified by:
setInt
in interfaceMemory
- Parameters:
addr
- the Address of the int.value
- the data to write.isBigEndian
- true means to write the short in bigEndian order- Throws:
MemoryAccessException
- if writing is not allowed.
-
setLong
Description copied from interface:Memory
Write long at addr in the default endian order.- Specified by:
setLong
in interfaceMemory
- Parameters:
addr
- the Address of the long.value
- the data to write.- Throws:
MemoryAccessException
- if writing is not allowed.
-
setLong
Description copied from interface:Memory
Write long at addr in the specified endian order.- Specified by:
setLong
in interfaceMemory
- Parameters:
addr
- the Address of the long.value
- the data to write.isBigEndian
- true means to write the long in bigEndian order- Throws:
MemoryAccessException
- if writing is not allowed.
-
contains
Description copied from interface:AddressSetView
Test if the address is contained within this set.- Specified by:
contains
in interfaceAddressSetView
- Parameters:
addr
- address to test.- Returns:
- true if addr exists in the set, false otherwise.
-
contains
Description copied from interface:AddressSetView
Test if the given address range is contained in this set. The specified start and end addresses must form a valid range within a singleAddressSpace
.- Specified by:
contains
in interfaceAddressSetView
- Parameters:
start
- the first address in the range.end
- the last address in the range.- Returns:
- true if entire range is contained within the set, false otherwise.
-
contains
Description copied from interface:AddressSetView
Test if the given address set is a subset of this set.- Specified by:
contains
in interfaceAddressSetView
- Parameters:
s
- the set to test.- Returns:
- true if the entire set is contained within this set, false otherwise.
-
isEmpty
public boolean isEmpty()- Specified by:
isEmpty
in interfaceAddressSetView
- Returns:
- true if this set is empty.
-
getMinAddress
Description copied from interface:AddressSetView
Get the minimum address for this address set. NOTE: AnAddressRange
should generally not be formed using this address andAddressSetView.getMaxAddress()
since it may span multipleAddressSpace
s.- Specified by:
getMinAddress
in interfaceAddressSetView
- Returns:
- the minimum address for this set. Returns null if the set is empty.
-
getMaxAddress
Description copied from interface:AddressSetView
Get the maximum address for this address set. NOTE: AnAddressRange
should generally not be formed using this address andAddressSetView.getMaxAddress()
since it may span multipleAddressSpace
s.- Specified by:
getMaxAddress
in interfaceAddressSetView
- Returns:
- the maximum address for this set. Returns null if the set is empty.
-
getNumAddressRanges
public int getNumAddressRanges()- Specified by:
getNumAddressRanges
in interfaceAddressSetView
- Returns:
- the number of address ranges in this set.
-
getAddressRanges
- Specified by:
getAddressRanges
in interfaceAddressSetView
- Returns:
- an iterator over the address ranges in this address set.
-
iterator
Description copied from interface:AddressSetView
Returns an iterator over the address ranges in this address set.- Specified by:
iterator
in interfaceAddressSetView
- Specified by:
iterator
in interfaceIterable<AddressRange>
-
getAddressRanges
Description copied from interface:AddressSetView
Returns an iterator over the ranges in the specified order- Specified by:
getAddressRanges
in interfaceAddressSetView
- Parameters:
forward
- the ranges are returned from lowest to highest, otherwise from highest to lowest- Returns:
- an iterator over all the addresse ranges in the set.
-
getNumAddresses
public long getNumAddresses()- Specified by:
getNumAddresses
in interfaceAddressSetView
- Returns:
- the number of addresses in this set.
-
getAddresses
Description copied from interface:AddressSetView
Returns an iterator over all addresses in this set.- Specified by:
getAddresses
in interfaceAddressSetView
- Parameters:
forward
- if true the address are return in increasing order, otherwise in decreasing order.- Returns:
- an iterator over all addresses in this set.
-
getAddresses
Description copied from interface:AddressSetView
Returns an iterator over the addresses in this address set starting at the start address- Specified by:
getAddresses
in interfaceAddressSetView
- Parameters:
start
- address to start iterating at in the address setforward
- if true address are return from lowest to highest, else from highest to lowest- Returns:
- an iterator over the addresses in this address set starting at the start address
-
intersects
Description copied from interface:AddressSetView
Determine if this address set intersects with the specified address set.- Specified by:
intersects
in interfaceAddressSetView
- Parameters:
set
- address set to check intersection with.- Returns:
- true if this set intersects the specified addrSet else false
-
intersects
Description copied from interface:AddressSetView
Determine if the start and end range intersects with the specified address set. The specified start and end addresses must form a valid range within a singleAddressSpace
.- Specified by:
intersects
in interfaceAddressSetView
- Parameters:
start
- start of rangeend
- end of range- Returns:
- true if the given range intersects this address set.
-
intersect
Description copied from interface:AddressSetView
Computes the intersection of this address set with the given address set. This method does not modify this address set.- Specified by:
intersect
in interfaceAddressSetView
- Parameters:
set
- the address set to intersect with.- Returns:
- AddressSet a new address set that contains all addresses that are contained in both this set and the given set.
-
intersectRange
Description copied from interface:AddressSetView
Computes the intersection of this address set with the given address range. This method does not modify this address set. The specified start and end addresses must form a valid range within a singleAddressSpace
.- Specified by:
intersectRange
in interfaceAddressSetView
- Parameters:
start
- start of rangeend
- end of range- Returns:
- AddressSet a new address set that contains all addresses that are contained in both this set and the given range.
-
union
Description copied from interface:AddressSetView
Computes the union of this address set with the given address set. This method does not change this address set.- Specified by:
union
in interfaceAddressSetView
- Parameters:
set
- The address set to be unioned with this address set.- Returns:
- AddressSet A new address set which contains all the addresses from both this set and the given set.
-
subtract
Description copied from interface:AddressSetView
Computes the difference of this address set with the given address set (this - set). Note that this is not the same as (set - this). This method does not change this address set.- Specified by:
subtract
in interfaceAddressSetView
- Parameters:
set
- the set to subtract from this set.- Returns:
- AddressSet a new address set which contains all the addresses that are in this set, but not in the given set.
-
xor
Description copied from interface:AddressSetView
Computes the exclusive-or of this address set with the given set. This method does not modify this address set.- Specified by:
xor
in interfaceAddressSetView
- Parameters:
set
- address set to exclusive-or with.- Returns:
- AddressSet a new address set containing all addresses that are in either this set or the given set, but not in both sets
-
hasSameAddresses
Description copied from interface:AddressSetView
Returns true if the given address set contains the same set of addresses as this set.- Specified by:
hasSameAddresses
in interfaceAddressSetView
- Parameters:
set
- the address set to compare.- Returns:
- true if the given set contains the same addresses as this set.
-
removeBlock
Description copied from interface:Memory
Remove the memory block.- Specified by:
removeBlock
in interfaceMemory
- Parameters:
block
- the block to be removed.monitor
- monitor that is used to cancel the remove operation- Throws:
LockException
- if exclusive lock not in place (see haveLock())
-
deleteAddressRange
public void deleteAddressRange(Address startAddr, Address endAddr, TaskMonitor monitor) throws CancelledException Description copied from interface:ManagerDB
Delete all objects which have been applied to the address range startAddr to endAddr and update the database accordingly. The specified start and end addresses must form a valid range within a singleAddressSpace
.- Specified by:
deleteAddressRange
in interfaceManagerDB
- Parameters:
startAddr
- the first address in the range.endAddr
- 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.
-
moveAddressRange
public void moveAddressRange(Address fromAddr, Address toAddr, long length, TaskMonitor monitor) throws CancelledException Description copied from interface:ManagerDB
Move all objects within an address range to a new location.- Specified by:
moveAddressRange
in 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.
-
toString
-
equals
-
hashCode
public int hashCode() -
memoryChanged
- Specified by:
memoryChanged
in interfaceLiveMemoryListener
-
getAddressRanges
Description copied from interface:AddressSetView
Returns an iterator of address ranges starting with the range that contains the given address. If there is no range containing the start address, then the the first range will be the next range greater than the start address if going forward, otherwise the range less than the start address- Specified by:
getAddressRanges
in interfaceAddressSetView
- Parameters:
start
- the address the the first range should contain.forward
- true iterators forward, false backwards- Returns:
- the AddressRange iterator
-
getFirstRange
Description copied from interface:AddressSetView
Returns the first range in this set or null if the set is empty;- Specified by:
getFirstRange
in interfaceAddressSetView
- Returns:
- the first range in this set or null if the set is empty;
-
getLastRange
Description copied from interface:AddressSetView
Returns the last range in this set or null if the set is empty;- Specified by:
getLastRange
in interfaceAddressSetView
- Returns:
- the last range in this set or null if the set is empty;
-
getRangeContaining
Description copied from interface:AddressSetView
Returns the range that contains the given address- Specified by:
getRangeContaining
in interfaceAddressSetView
- Parameters:
address
- the address for which to find a range.- Returns:
- the range that contains the given address.
-
iterator
Description copied from interface:AddressSetView
Returns an iterator over the ranges in the specified order- Specified by:
iterator
in interfaceAddressSetView
- Parameters:
forward
- the ranges are returned from lowest to highest, otherwise from highest to lowest- Returns:
- an iterator over all the addresse ranges in the set.
-
iterator
Description copied from interface:AddressSetView
Returns an iterator of address ranges starting with the range that contains the given address. If there is no range containing the start address, then the the first range will be the next range greater than the start address if going forward, otherwise the range less than the start address- Specified by:
iterator
in interfaceAddressSetView
- Parameters:
start
- the address the the first range should contain.forward
- true iterators forward, false backwards- Returns:
- the AddressRange iterator
-
findFirstAddressInCommon
Description copied from interface:AddressSetView
Finds the first address in this collection that is also in the given addressSet.- Specified by:
findFirstAddressInCommon
in interfaceAddressSetView
- Parameters:
set
- the addressSet to search for the first (lowest) common address.- Returns:
- the first address that is contained in this set and the given set.
-
getAddressSourceInfo
Description copied from interface:Memory
Returns information (AddressSourceInfo
) about the byte source at the given address.- Specified by:
getAddressSourceInfo
in interfaceMemory
- Parameters:
address
- the address to query. Returns null if the address is not in memory.- Returns:
- information (
AddressSourceInfo
) about the byte source at the given address or null if the address is not in memory.
-
createFileBytes
public FileBytes createFileBytes(String filename, long offset, long size, InputStream is, TaskMonitor monitor) throws IOException, CancelledException Description copied from interface:Memory
Stores a sequence of bytes into the program. Typically, this method is used by importers to store the original raw program bytes.- Specified by:
createFileBytes
in interfaceMemory
- Parameters:
filename
- the name of the file from where the bytes originatedoffset
- the offset into the file for the first byte in the input stream.size
- the number of bytes to store from the input stream.is
- the input stream that will supply the bytes to store in the program. Caller is responsible for closing input stream upon return.monitor
- task monitor- Returns:
- a FileBytes that was created to access the bytes.
- Throws:
IOException
- if there was an IOException saving the bytes to the program database.CancelledException
- if the user cancelled this operation. Note: the database will be stable, but the buffers may contain 0s instead of the actual bytes.
-
getAllFileBytes
Description copied from interface:Memory
Returns a list of all the stored original file bytes objects- Specified by:
getAllFileBytes
in interfaceMemory
- Returns:
- a list of all the stored original file bytes objects
-
deleteFileBytes
Description copied from interface:Memory
Deletes a stored sequence of file bytes. The file bytes can only be deleted if there are no memory block references to the file bytes.- Specified by:
deleteFileBytes
in interfaceMemory
- Parameters:
fileBytes
- the FileBytes for the file bytes to be deleted.- Returns:
- true if the FileBytes was deleted. If any memory blocks are referenced by this FileBytes or it is invalid then it will not be deleted and false will be returned.
- Throws:
IOException
- if there was an error updating the database.
-