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
AByteProvider
implementation based onMemory
.
-
-
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 newMemoryByteProvider
relative to the specified base address.MemoryByteProvider(Memory memory, AddressSpace space)
Constructs a newMemoryByteProvider
for a specificAddressSpace
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
Releases any resources theByteProvider
may have occupiedstatic ByteProvider
createMemoryBlockByteProvider(Memory memory, MemoryBlock block)
Create aByteProvider
that is limited to the specifiedMemoryBlock
.java.lang.String
getAbsolutePath()
Returns the absolute path (similar to, but not a, URI) to theByteProvider
.Address
getAddress(long index)
Converts an index into this ByteProvider into anAddress
.java.io.File
getFile()
Returns the underlyingFile
for thisByteProvider
, or null if thisByteProvider
is not associated with aFile
.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 theByteProvider
.boolean
isValidIndex(long index)
Returns true if the specified index is valid.long
length()
Returns the length of theByteProvider
byte
readByte(long index)
Reads a byte at the specified indexbyte[]
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
-
-
-
-
Constructor Detail
-
MemoryByteProvider
public MemoryByteProvider(Memory memory, AddressSpace space)
Constructs a newMemoryByteProvider
for a specificAddressSpace
. Bytes will be provided starting at address 0 in the space.- Parameters:
memory
- theMemory
space
- theAddressSpace
-
MemoryByteProvider
public MemoryByteProvider(Memory memory, Address baseAddress)
Constructs a newMemoryByteProvider
relative to the specified base address.- Parameters:
memory
- theMemory
baseAddress
- the base address
-
-
Method Detail
-
createMemoryBlockByteProvider
public static ByteProvider createMemoryBlockByteProvider(Memory memory, MemoryBlock block)
Create aByteProvider
that is limited to the specifiedMemoryBlock
.- Parameters:
memory
-Memory
of the programblock
-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 anAddress
.- 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 interfaceByteProvider
- Parameters:
index
- where in theByteProvider
to start theInputStream
- 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 underlyingFile
for thisByteProvider
, or null if thisByteProvider
is not associated with aFile
.- Specified by:
getFile
in interfaceByteProvider
- Returns:
- the underlying file for this byte provider
-
getName
public java.lang.String getName()
Description copied from interface:ByteProvider
Returns the name of theByteProvider
. For example, the underlying file name.- Specified by:
getName
in interfaceByteProvider
- 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 theByteProvider
. For example, the complete path to the file.- Specified by:
getAbsolutePath
in interfaceByteProvider
- Returns:
- the absolute path to the
ByteProvider
or null if not associated with aFile
.
-
length
public long length() throws java.io.IOException
Description copied from interface:ByteProvider
Returns the length of theByteProvider
- Specified by:
length
in interfaceByteProvider
- 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 interfaceByteProvider
- 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 interfaceByteProvider
- 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 interfaceByteProvider
- Parameters:
index
- the index of the byte to readlength
- 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 theByteProvider
may have occupied- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfaceByteProvider
- Specified by:
close
in interfacejava.io.Closeable
-
-