Package ghidra.app.util.bin

Class MemoryByteProvider

java.lang.Object

ghidra.app.util.bin.MemoryByteProvider

All Implemented Interfaces:

ByteProvider, java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

MemoryMutableByteProvider

public class MemoryByteProvider
extends java.lang.Object
implements ByteProvider

A ByteProvider implementation based on Memory.

Field Summary

Fields

Modifier and Type	Field	Description
protected Address	baseAddress
protected Memory	memory

Fields inherited from interface ghidra.app.util.bin.ByteProvider

EMPTY_BYTEPROVIDER

Constructor Summary

Constructors

Constructor	Description
MemoryByteProvider(Memory memory, Address baseAddress)	Constructs a new MemoryByteProvider relative to the specified base address.
MemoryByteProvider(Memory memory, AddressSpace space)	Constructs a new MemoryByteProvider for a specific AddressSpace.

Method Summary

Modifier and Type	Method	Description
void	close()	Releases any resources the ByteProvider may have occupied
static ByteProvider	createMemoryBlockByteProvider(Memory memory, MemoryBlock block)	Create a ByteProvider that is limited to the specified MemoryBlock.
java.lang.String	getAbsolutePath()	Returns the absolute path (similar to, but not a, URI) to the ByteProvider.
Address	getAddress(long index)	Converts an index into this ByteProvider into an Address.
java.io.File	getFile()	Returns the underlying File for this ByteProvider, or null if this ByteProvider is not associated with a File.
java.io.InputStream	getInputStream(long index)	Returns an input stream to the underlying byte provider starting at the specified index.
java.lang.String	getName()	Returns the name of the ByteProvider.
boolean	isValidIndex(long index)	Returns true if the specified index is valid.
long	length()	Returns the length of the ByteProvider
byte	readByte(long index)	Reads a byte at the specified index
byte[]	readBytes(long index, long length)	Reads a byte array at the specified index

Methods inherited from class java.lang.Object

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

Methods inherited from interface ghidra.app.util.bin.ByteProvider

getFSRL

Field Detail

memory

protected Memory memory

baseAddress

protected Address baseAddress

Constructor Detail

MemoryByteProvider

public MemoryByteProvider(Memory memory,
                          AddressSpace space)

Constructs a new MemoryByteProvider for a specific AddressSpace. Bytes will be provided starting at address 0 in the space.

Parameters:

memory - the Memory

space - the AddressSpace

MemoryByteProvider

public MemoryByteProvider(Memory memory,
                          Address baseAddress)

Constructs a new MemoryByteProvider relative to the specified base address.

Parameters:

memory - the Memory

baseAddress - the base address

Method Detail

createMemoryBlockByteProvider

public static ByteProvider createMemoryBlockByteProvider(Memory memory,
                                                         MemoryBlock block)

Create a ByteProvider that is limited to the specified MemoryBlock.

Parameters:

memory - Memory of the program

block - MemoryBlock to read from

Returns:

new ByteProvider that contains the bytes of the specified MemoryBlock

getAddress

public Address getAddress(long index)

Converts an index into this ByteProvider into an Address.

Parameters:

index - absolute index in this ByteProvider to convert into an Address

Returns:

Address

Throws:

AddressOutOfBoundsException - if wrapping is not supported by the corresponding address space and the addition causes an out-of-bounds error

getInputStream

public java.io.InputStream getInputStream(long index)
                                   throws java.io.IOException

Description copied from interface: ByteProvider

Returns an input stream to the underlying byte provider starting at the specified index.

The caller is responsible for closing the returned InputStream instance.

If you need to override this default implementation, please document why your inputstream is needed.

Specified by:

getInputStream in interface ByteProvider

Parameters:

index - where in the ByteProvider to start the InputStream

Returns:

the InputStream

Throws:

java.io.IOException - if an I/O error occurs

getFile

public java.io.File getFile()

Description copied from interface: ByteProvider

Returns the underlying File for this ByteProvider, or null if this ByteProvider is not associated with a File.

Specified by:

getFile in interface ByteProvider

Returns:

the underlying file for this byte provider

getName

public java.lang.String getName()

Description copied from interface: ByteProvider

Returns the name of the ByteProvider. For example, the underlying file name.

Specified by:

getName in interface ByteProvider

Returns:

the name of the ByteProvider or null if there is no name

getAbsolutePath

public java.lang.String getAbsolutePath()

Description copied from interface: ByteProvider

Returns the absolute path (similar to, but not a, URI) to the ByteProvider. For example, the complete path to the file.

Specified by:

getAbsolutePath in interface ByteProvider

Returns:

the absolute path to the ByteProvider or null if not associated with a File.

length

public long length()
            throws java.io.IOException

Description copied from interface: ByteProvider

Returns the length of the ByteProvider

Specified by:

length in interface ByteProvider

Returns:

the length of the ByteProvider

Throws:

java.io.IOException - if an I/O error occurs

isValidIndex

public boolean isValidIndex(long index)

Description copied from interface: ByteProvider

Returns true if the specified index is valid.

Specified by:

isValidIndex in interface ByteProvider

Parameters:

index - the index in the byte provider to check

Returns:

true if the specified index is valid

readByte

public byte readByte(long index)
              throws java.io.IOException

Description copied from interface: ByteProvider

Reads a byte at the specified index

Specified by:

readByte in interface ByteProvider

Parameters:

index - the index of the byte to read

Returns:

the byte read from the specified index

Throws:

java.io.IOException - if an I/O error occurs

readBytes

public byte[] readBytes(long index,
                        long length)
                 throws java.io.IOException

Description copied from interface: ByteProvider

Reads a byte array at the specified index

Specified by:

readBytes in interface ByteProvider

Parameters:

index - the index of the byte to read

length - the number of bytes to read

Returns:

the byte array read from the specified index

Throws:

java.io.IOException - if an I/O error occurs

close

public void close()

Description copied from interface: ByteProvider

Releases any resources the ByteProvider may have occupied

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface ByteProvider

Specified by:

close in interface java.io.Closeable