Package com.pnfsoftware.jeb.core.units.code.asm.memory

Class AbstractVirtualMemory

java.lang.Object

com.pnfsoftware.jeb.core.units.code.asm.memory.AbstractVirtualMemory

All Implemented Interfaces:

IVirtualMemory

@Ser
public abstract class AbstractVirtualMemory
extends Object
implements IVirtualMemory

A skeleton implementation for virtual memory classes. Most trivial methods are implemented here.

Field Summary

Fields inherited from interface com.pnfsoftware.jeb.core.units.code.asm.memory.IVirtualMemory

ACCESS_EXECUTE, ACCESS_NONE, ACCESS_READ, ACCESS_RW, ACCESS_RWX, ACCESS_RX, ACCESS_WRITE, AM_ARM64_48BIT

Constructor Summary

Constructors

Constructor	Description
AbstractVirtualMemory()

Method Summary

Modifier and Type	Method	Description
void	addAllocListener(IMemoryAllocListener listener)
void	addFreeListener(IMemoryFreeListener listener)
void	addPreWriteListener(IMemoryWriteListener listener)	Note: The callback is invoked before the write operation takes place.
void	addPropertyListener(IMemoryPropertyListener listener)
void	addProtectionListener(IMemoryProtectionListener listener)
void	addWriteListener(IMemoryWriteListener listener)
void	allocatePage(long address, int protection)	Allocate a single page.
void	freePage(long address)	Free a single page.
protected List<IMemoryAllocListener>	getAllocListeners()
int	getAproximateFootprint()	Determine the approximate memory footprint of this object, in kilobytes.
protected List<IMemoryFreeListener>	getFreeListeners()
protected List<IMemoryWriteListener>	getPreWriteListeners()
protected List<IMemoryPropertyListener>	getPropertyListeners()
protected List<IMemoryProtectionListener>	getProtectionListeners()
protected List<IMemoryWriteListener>	getWriteListeners()
int	readBEInt(long address)	Read a big-endian 32-bit integer.
long	readBELong(long address)	Read a big-endian 64-bit integer.
short	readBEShort(long address)	Read a big-endian 16-bit integer.
byte	readByte(long address)	Convenience method.
int	readInt(long address)	Read a 32-bit integer using the standard endianness.
int	readInt(long address, Endianness end)	Read a 32-bit integer.
int	readLEInt(long address)	Read a little-endian 32-bit integer.
long	readLELong(long address)	Read a little-endian 64-bit integer.
short	readLEShort(long address)	Read a little-endian 16-bit integer.
long	readLong(long address)	Read a 64-bit integer using the standard endianness.
long	readLong(long address, Endianness end)	Read a 64-bit integer.
long	readPointer(long address)
short	readShort(long address)	Read a 16-bit integer using the standard endianness.
short	readShort(long address, Endianness end)	Read a 16-bit integer.
void	removeAllocListener(IMemoryAllocListener listener)
void	removeFreeListener(IMemoryFreeListener listener)
void	removePreWriteListener(IMemoryWriteListener listener)
void	removePropertyListener(IMemoryPropertyListener listener)
void	removeProtectionListener(IMemoryProtectionListener listener)
void	removeWriteListener(IMemoryWriteListener listener)
long	roundToPage(long address)	Round an address to the page this address currently resides in, that is the highest page so that boundary ≤ address.
long	roundToSize(long address)	Round an address to the lowest page boundary so that address ≤ boundary.
void	setLazyMemoryProvider(ILazyMemoryProvider lazyMemoryProvider, boolean skipFailedAllocations)	Set a lazy memory provider.
void	writeBEInt(long address, int v)	Write a big-endian 32-bit integer.
void	writeBELong(long address, long v)	Write a big-endian 64-bit integer.
void	writeBEShort(long address, short v)	Write a big-endian 16-bit integer.
void	writeByte(long address, byte v)	Write a byte.
void	writeInt(long address, int v)	Write a 32-bit integer using the standard endianness.
void	writeInt(long address, int v, Endianness end)	Write a 32-bit integer.
void	writeLEInt(long address, int v)	Write a little-endian 32-bit integer.
void	writeLELong(long address, long v)	Write a little-endian 64-bit integer.
void	writeLEShort(long address, short v)	Write a little-endian 16-bit integer.
void	writeLong(long address, long v)	Write a 64-bit integer using the standard endianness.
void	writeLong(long address, long v, Endianness end)	Write a 64-bit integer.
void	writePointer(long address, long ptr)
void	writeShort(long address, short v)	Write a 16-bit integer using the standard endianness.
void	writeShort(long address, short v, Endianness end)	Write a 16-bit integer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pnfsoftware.jeb.core.units.code.asm.memory.IVirtualMemory

allocate, check, duplicate, free, getAddressMassager, getAllocatedPageBases, getAllocatedPageCount, getPageBits, getPageProtection, getPageSize, getSpaceBits, getStandardEndianess, isAllocatedPage, isValidAddress, read, read, setAddressMassagerType, setPageProtection, setStandardEndianness, write, write

Constructor Details

AbstractVirtualMemory

public AbstractVirtualMemory()

Method Details

roundToPage

public long roundToPage(long address)

Description copied from interface: IVirtualMemory

Round an address to the page this address currently resides in, that is the highest page so that boundary ≤ address. This method does not raise, even if the address is invalid for this memory space.

Specified by:

roundToPage in interface IVirtualMemory

Parameters:

address - an address

Returns:

the containing page address

roundToSize

public long roundToSize(long address)

Description copied from interface: IVirtualMemory

Round an address to the lowest page boundary so that address ≤ boundary. This method does not raise, even if the address is invalid for this memory space.

Specified by:

roundToSize in interface IVirtualMemory

Parameters:

address - an address or a size

Returns:

allocatePage

public void allocatePage(long address,
 int protection)
                  throws MemoryException

Description copied from interface: IVirtualMemory

Allocate a single page. See IVirtualMemory.allocate(long, int, int).

Specified by:

allocatePage in interface IVirtualMemory

Throws:

MemoryException

freePage

public void freePage(long address)
              throws MemoryException

Description copied from interface: IVirtualMemory

Free a single page. See IVirtualMemory.free(long, int).

Specified by:

freePage in interface IVirtualMemory

Throws:

MemoryException

readByte

public byte readByte(long address)
              throws MemoryException

Description copied from interface: IVirtualMemory

Convenience method. Read a byte.

Specified by:

readByte in interface IVirtualMemory

Returns:

Throws:

MemoryException

writeByte

public void writeByte(long address,
 byte v)
               throws MemoryException

Description copied from interface: IVirtualMemory

Write a byte.

Specified by:

writeByte in interface IVirtualMemory

Throws:

MemoryException

readLEShort

public short readLEShort(long address)
                  throws MemoryException

Description copied from interface: IVirtualMemory

Read a little-endian 16-bit integer. This method does not do partial reads.

Specified by:

readLEShort in interface IVirtualMemory

Returns:

Throws:

MemoryException

writeLEShort

public void writeLEShort(long address,
 short v)
                  throws MemoryException

Description copied from interface: IVirtualMemory

Write a little-endian 16-bit integer. This method does not do partial writes.

Specified by:

writeLEShort in interface IVirtualMemory

Throws:

MemoryException

readLEInt

public int readLEInt(long address)
              throws MemoryException

Description copied from interface: IVirtualMemory

Read a little-endian 32-bit integer. This method does not do partial reads.

Specified by:

readLEInt in interface IVirtualMemory

Returns:

Throws:

MemoryException

writeLEInt

public void writeLEInt(long address,
 int v)
                throws MemoryException

Description copied from interface: IVirtualMemory

Write a little-endian 32-bit integer. This method does not do partial writes.

Specified by:

writeLEInt in interface IVirtualMemory

Throws:

MemoryException

readLELong

public long readLELong(long address)
                throws MemoryException

Description copied from interface: IVirtualMemory

Read a little-endian 64-bit integer. This method does not do partial reads.

Specified by:

readLELong in interface IVirtualMemory

Returns:

Throws:

MemoryException

writeLELong

public void writeLELong(long address,
 long v)
                 throws MemoryException

Description copied from interface: IVirtualMemory

Write a little-endian 64-bit integer. This method does not do partial writes.

Specified by:

writeLELong in interface IVirtualMemory

Throws:

MemoryException

readBEShort

public short readBEShort(long address)
                  throws MemoryException

Description copied from interface: IVirtualMemory

Read a big-endian 16-bit integer. This method does not do partial reads.

Specified by:

readBEShort in interface IVirtualMemory

Returns:

Throws:

MemoryException

writeBEShort

public void writeBEShort(long address,
 short v)
                  throws MemoryException

Description copied from interface: IVirtualMemory

Write a big-endian 16-bit integer. This method does not do partial writes.

Specified by:

writeBEShort in interface IVirtualMemory

Throws:

MemoryException

readBEInt

public int readBEInt(long address)
              throws MemoryException

Description copied from interface: IVirtualMemory

Read a big-endian 32-bit integer. This method does not do partial reads.

Specified by:

readBEInt in interface IVirtualMemory

Returns:

Throws:

MemoryException

writeBEInt

public void writeBEInt(long address,
 int v)
                throws MemoryException

Description copied from interface: IVirtualMemory

Write a big-endian 32-bit integer. This method does not do partial writes.

Specified by:

writeBEInt in interface IVirtualMemory

Throws:

MemoryException

readBELong

public long readBELong(long address)
                throws MemoryException

Description copied from interface: IVirtualMemory

Read a big-endian 64-bit integer. This method does not do partial reads.

Specified by:

readBELong in interface IVirtualMemory

Returns:

Throws:

MemoryException

writeBELong

public void writeBELong(long address,
 long v)
                 throws MemoryException

Description copied from interface: IVirtualMemory

Write a big-endian 64-bit integer. This method does not do partial writes.

Specified by:

writeBELong in interface IVirtualMemory

Throws:

MemoryException

readShort

public short readShort(long address)
                throws MemoryException

Description copied from interface: IVirtualMemory

Read a 16-bit integer using the standard endianness. This method does not do partial reads.

Specified by:

readShort in interface IVirtualMemory

Returns:

Throws:

MemoryException

writeShort

public void writeShort(long address,
 short v)
                throws MemoryException

Description copied from interface: IVirtualMemory

Write a 16-bit integer using the standard endianness. This method does not do partial writes.

Specified by:

writeShort in interface IVirtualMemory

Throws:

MemoryException

readInt

public int readInt(long address)
            throws MemoryException

Description copied from interface: IVirtualMemory

Read a 32-bit integer using the standard endianness. This method does not do partial reads.

Specified by:

readInt in interface IVirtualMemory

Returns:

Throws:

MemoryException

writeInt

public void writeInt(long address,
 int v)
              throws MemoryException

Description copied from interface: IVirtualMemory

Write a 32-bit integer using the standard endianness. This method does not do partial writes.

Specified by:

writeInt in interface IVirtualMemory

Throws:

MemoryException

readLong

public long readLong(long address)
              throws MemoryException

Description copied from interface: IVirtualMemory

Read a 64-bit integer using the standard endianness. This method does not do partial reads.

Specified by:

readLong in interface IVirtualMemory

Returns:

Throws:

MemoryException

writeLong

public void writeLong(long address,
 long v)
               throws MemoryException

Description copied from interface: IVirtualMemory

Write a 64-bit integer using the standard endianness. This method does not do partial writes.

Specified by:

writeLong in interface IVirtualMemory

Throws:

MemoryException

readShort

public short readShort(long address,
 Endianness end)
                throws MemoryException

Description copied from interface: IVirtualMemory

Read a 16-bit integer. This method does not do partial reads.

Specified by:

readShort in interface IVirtualMemory

Returns:

Throws:

MemoryException

writeShort

public void writeShort(long address,
 short v,
 Endianness end)
                throws MemoryException

Description copied from interface: IVirtualMemory

Write a 16-bit integer. This method does not do partial writes.

Specified by:

writeShort in interface IVirtualMemory

Throws:

MemoryException

readInt

public int readInt(long address,
 Endianness end)
            throws MemoryException

Description copied from interface: IVirtualMemory

Read a 32-bit integer. This method does not do partial reads.

Specified by:

readInt in interface IVirtualMemory

Returns:

Throws:

MemoryException

writeInt

public void writeInt(long address,
 int v,
 Endianness end)
              throws MemoryException

Description copied from interface: IVirtualMemory

Write a 32-bit integer. This method does not do partial writes.

Specified by:

writeInt in interface IVirtualMemory

Throws:

MemoryException

readLong

public long readLong(long address,
 Endianness end)
              throws MemoryException

Description copied from interface: IVirtualMemory

Read a 64-bit integer. This method does not do partial reads.

Specified by:

readLong in interface IVirtualMemory

Returns:

Throws:

MemoryException

writeLong

public void writeLong(long address,
 long v,
 Endianness end)
               throws MemoryException

Description copied from interface: IVirtualMemory

Write a 64-bit integer. This method does not do partial writes.

Specified by:

writeLong in interface IVirtualMemory

Throws:

MemoryException

readPointer

public long readPointer(long address)
                 throws MemoryException

Specified by:

readPointer in interface IVirtualMemory

Returns:

Throws:

MemoryException

writePointer

public void writePointer(long address,
 long ptr)
                  throws MemoryException

Specified by:

writePointer in interface IVirtualMemory

Throws:

MemoryException

getPropertyListeners

protected List<IMemoryPropertyListener> getPropertyListeners()

getAllocListeners

protected List<IMemoryAllocListener> getAllocListeners()

getFreeListeners

protected List<IMemoryFreeListener> getFreeListeners()

getProtectionListeners

protected List<IMemoryProtectionListener> getProtectionListeners()

getPreWriteListeners

protected List<IMemoryWriteListener> getPreWriteListeners()

getWriteListeners

protected List<IMemoryWriteListener> getWriteListeners()

addPropertyListener

public void addPropertyListener(IMemoryPropertyListener listener)

Specified by:

addPropertyListener in interface IVirtualMemory

removePropertyListener

public void removePropertyListener(IMemoryPropertyListener listener)

Specified by:

removePropertyListener in interface IVirtualMemory

addAllocListener

public void addAllocListener(IMemoryAllocListener listener)

Specified by:

addAllocListener in interface IVirtualMemory

removeAllocListener

public void removeAllocListener(IMemoryAllocListener listener)

Specified by:

removeAllocListener in interface IVirtualMemory

addFreeListener

public void addFreeListener(IMemoryFreeListener listener)

Specified by:

addFreeListener in interface IVirtualMemory

removeFreeListener

public void removeFreeListener(IMemoryFreeListener listener)

Specified by:

removeFreeListener in interface IVirtualMemory

addProtectionListener

public void addProtectionListener(IMemoryProtectionListener listener)

Specified by:

addProtectionListener in interface IVirtualMemory

removeProtectionListener

public void removeProtectionListener(IMemoryProtectionListener listener)

Specified by:

removeProtectionListener in interface IVirtualMemory

addPreWriteListener

public void addPreWriteListener(IMemoryWriteListener listener)

Description copied from interface: IVirtualMemory

Note: The callback is invoked before the write operation takes place.

Specified by:

addPreWriteListener in interface IVirtualMemory

removePreWriteListener

public void removePreWriteListener(IMemoryWriteListener listener)

Specified by:

removePreWriteListener in interface IVirtualMemory

addWriteListener

public void addWriteListener(IMemoryWriteListener listener)

Specified by:

addWriteListener in interface IVirtualMemory

removeWriteListener

public void removeWriteListener(IMemoryWriteListener listener)

Specified by:

removeWriteListener in interface IVirtualMemory

setLazyMemoryProvider

public void setLazyMemoryProvider(ILazyMemoryProvider lazyMemoryProvider,
 boolean skipFailedAllocations)
                           throws MemoryException,
UnsupportedOperationException

Description copied from interface: IVirtualMemory

Set a lazy memory provider. This operation is optional. If the memory object supports it, the ILazyMemoryProvider.getRanges() method will be called to reserve the ranges of memory that the provider can provide. A lazy provider provides memory data on demand, i.e. when the data bytes are accessed (read or write).

Specified by:

setLazyMemoryProvider in interface IVirtualMemory

Parameters:

lazyMemoryProvider - a non-null lazy memory provider

skipFailedAllocations - if true, the provider will not hard-fail if it provides data for a range for which data already exists in the virtual memory; else, the method will throw

Throws:

MemoryException - if a page reservation failed and skipFailedAllocations is false (example: the memory provider requests to allocate an already allocated range)

UnsupportedOperationException - if the implementation does not support that feature

getAproximateFootprint

public int getAproximateFootprint()

Description copied from interface: IVirtualMemory

Determine the approximate memory footprint of this object, in kilobytes.

Specified by:

getAproximateFootprint in interface IVirtualMemory

Returns:

a size in Kb