net.openhft.chronicle.core

Interface Memory

All Known Implementing Classes:

UnsafeMemory

public interface Memory

The Memory interface provides low-level memory access methods.

Method Summary

Modifier and Type	Method and Description
int	addInt(long address, int increment) Adds the specified increment to the value at the given memory address and returns the updated value.
int	addInt(Object object, long offset, int increment) Adds the specified increment to the value at the given offset in the object and returns the updated value.
long	addLong(long address, long increment) Adds the specified increment to the value at the given memory address and returns the updated value.
long	addLong(Object object, long offset, long increment) Adds the specified increment to the value at the given offset in the object and returns the updated value.
long	address(ByteBuffer bb) Returns the memory address associated with the given ByteBuffer.
long	allocate(long capacity) Allocates memory and returns the low level base address of the newly allocated memory region.
<E> E	allocateInstance(Class<? extends E> clazz) Allocates and returns a new instance of the specified class.
int	arrayBaseOffset(Class<?> type) Returns the base offset of the elements in the specified array type.
boolean	compareAndSwapInt(long address, int expected, int value) Compares the value at the specified memory address with the expected value and, if equal, sets it to the new value.
boolean	compareAndSwapInt(Object object, long offset, int expected, int value) Compares the value at the specified offset in the object with the expected value and, if equal, sets it to the new value.
boolean	compareAndSwapLong(long address, long expected, long value) Compares the value at the specified memory address with the expected value and, if equal, sets it to the new value.
boolean	compareAndSwapLong(Object object, long offset, long expected, long value) Compares the value at the specified offset in the object with the expected value and, if equal, sets it to the new value.
void	copyMemory(byte[] bytes, int offset, long address, int length) Copies a range of bytes from the given byte array to the specified memory address.
void	copyMemory(long fromAddress, long address, long length) Copies a range of memory from one address to another.
void	copyMemory(long fromAddress, Object obj2, long offset2, int length) Copies a range of memory from the given memory address to the specified object at the given offset.
void	copyMemory(Object o, long offset, long toAddress, int length) Copies a range of memory from the given object to the specified memory address.
void	copyMemory(Object o, long offset, Object o2, long offset2, int length) Copies a range of memory from one object to another at the specified offsets.
void	freeMemory(long address, long size) Frees the memory block at the specified address with the given size.
int	getAndSetInt(long address, int value) Atomically sets the value at the specified address to the given value and returns the previous value
int	getAndSetInt(Object object, long offset, int value) Atomically sets the value at the specified offset in the object to the given value and returns the previous value.
long	getFieldOffset(Field field) Returns the offset of the specified field in its containing object.
<T> T	getObject(@NotNull Object o, long offset) Returns the value of the specified field in the given object.
boolean	is7Bit(byte[] bytes, int offset, int length) Checks if the bytes in the specified byte array are 7-bit ASCII characters.
boolean	is7Bit(char[] chars, int offset, int length) Checks if the characters in the specified char array are 7-bit ASCII characters.
boolean	is7Bit(long address, int length) Checks if the bytes in the memory at the given address are 7-bit ASCII characters.
void	loadFence() Ensures that all previous reads from memory are completed before any subsequent memory access instruction.
long	nativeMemoryUsed() Retrieves the amount of native memory currently used by the application.
long	objectFieldOffset(Field field) Returns the offset of the specified field in its containing object.
int	pageSize() Returns the page size of the underlying memory system.
long	partialRead(byte[] bytes, int offset, int length) Reads a partial value from the given byte array starting at the specified offset.
long	partialRead(long addr, int length) Reads a partial value from the memory at the given address.
void	partialWrite(byte[] bytes, int offset, long value, int length) Writes a partial value to the byte array at the specified offset.
void	partialWrite(long addr, long value, int length) Writes a partial value to the memory at the given address.
void	putObject(@NotNull Object o, long offset, Object value) Sets the value of the specified field in the given object.
byte	readByte(long address) Reads a byte value from the memory at the specified address.
byte	readByte(Object object, long offset) Reads a byte value from the memory at the specified offset within the given object.
void	readBytes(long address, byte[] b, long offset, int length) Reads an array of bytes from the memory at the specified address and stores it in the provided byte array.
double	readDouble(long address) Reads a double value from the memory at the specified address.
double	readDouble(Object object, long offset) Reads a double value from the memory at the specified offset within the given object.
float	readFloat(long address) Reads a float value from the memory at the specified address.
float	readFloat(Object object, long offset) Reads a float value from the memory at the specified offset within the given object.
int	readInt(long address) Reads an int value from the memory at the specified address.
int	readInt(Object object, long offset) Reads an int value from the memory at the specified offset within the given object.
long	readLong(long address) Reads a long value from the memory at the specified address.
long	readLong(Object object, long offset) Reads a long value from the memory at the specified offset within the given object.
short	readShort(long address) Reads a short value from the memory at the specified address.
short	readShort(Object object, long offset) Reads a short value from the memory at the specified offset within the given object.
byte	readVolatileByte(long address) Reads a volatile byte from the memory at the given address.
byte	readVolatileByte(Object object, long offset) Reads a volatile byte from the object at the given offset.
double	readVolatileDouble(long address) Reads a volatile double from the memory at the given address.
double	readVolatileDouble(Object object, long offset) Reads a volatile double from the object at the given offset.
float	readVolatileFloat(long address) Reads a volatile float from the memory at the given address.
float	readVolatileFloat(Object object, long offset) Reads a volatile float from the object at the given offset.
int	readVolatileInt(long address) Reads a volatile integer from the memory at the given address.
int	readVolatileInt(Object object, long offset) Reads a volatile integer from the object at the given offset.
long	readVolatileLong(long address) Reads a volatile long from the memory at the given address.
long	readVolatileLong(Object object, long offset) Reads a volatile long from the object at the given offset.
short	readVolatileShort(long address) Reads a volatile short from the memory at the given address.
short	readVolatileShort(Object object, long offset) Reads a volatile short from the object at the given offset.
boolean	safeAlignedInt(long addr) Returns if the provided addr would provide access to an int that would reside entirely within a distinct cache-line.
boolean	safeAlignedLong(long addr) Returns if the provided addr would provide access to a long that would reside entirely within a distinct cache-line.
void	setMemory(long address, long size, byte b) Sets the memory at the specified address with the given byte value.
void	setMemory(Object o, long offset, long size, byte b) Sets the memory at the specified offset within the given object with the given byte value.
static int	sizeOf(Class<?> type)
int	stopBitLength(int i) Returns the length in bytes required to encode an integer using stop-bit encoding.
int	stopBitLength(long l) Returns the length in bytes required to encode a long integer using stop-bit encoding.
void	storeFence() Ensures that all previous writes to memory are completed before any subsequent memory access instruction.
void	testAndSetInt(long address, long offset, int expected, int value) Atomically sets the value at the specified address to the given value if it equals the expected value.
void	testAndSetInt(Object object, long offset, int expected, int value) Atomically sets the value at the specified offset in the object to the given value if it equals the expected value.
void	writeByte(long address, byte i8) Writes a byte value to the memory at the specified address.
void	writeByte(Object object, long offset, byte b) Writes a byte value to the memory at the specified offset within the given object.
void	writeBytes(long address, byte[] b, int offset, int length) Writes an array of bytes to the memory at the specified address.
void	writeDouble(long address, double d) Writes a double value to the memory at the specified address.
void	writeDouble(Object object, long offset, double d) Writes a double value to the memory at the specified offset within the given object.
void	writeFloat(long address, float f) Writes a float value to the memory at the specified address.
void	writeFloat(Object object, long offset, float f) Writes a float value to the memory at the specified offset within the given object.
void	writeInt(long address, int i32) Writes an int value to the memory at the specified address.
void	writeInt(Object object, long offset, int i32) Writes an int value to the memory at the specified offset within the given object.
void	writeLong(long address, long i64) Writes a long value to the memory at the specified address.
void	writeLong(Object object, long offset, long i64) Writes a long value to the memory at the specified offset within the given object.
void	writeOrderedInt(long offset, int i32) Writes an int value to the memory at the specified offset within the given object in an ordered manner.
void	writeOrderedInt(Object object, long offset, int i32) Writes an int value to the memory at the specified offset within the given object in an ordered manner.
void	writeOrderedLong(long address, long i) Writes a long value to memory at the given address with ordered store semantics.
void	writeOrderedLong(Object object, long offset, long i) Writes a long value to the object at the given offset with ordered store semantics.
void	writeShort(long address, short i16) Writes a short value to the memory at the specified address.
void	writeShort(Object object, long offset, short i16) Writes a short value to the memory at the specified offset within the given object.
void	writeVolatileByte(long address, byte b) Writes a volatile byte to the memory at the given address.
void	writeVolatileByte(Object object, long offset, byte b) Writes a volatile byte to the object at the given offset.
void	writeVolatileDouble(long address, double d) Writes a volatile double to the memory at the given address.
void	writeVolatileDouble(Object object, long offset, double d) Writes a volatile double to the object at the given offset.
void	writeVolatileFloat(long address, float f) Writes a volatile float to the memory at the given address.
void	writeVolatileFloat(Object object, long offset, float f) Writes a volatile float to the object at the given offset.
void	writeVolatileInt(long address, int i32) Writes a volatile integer to the memory at the given address.
void	writeVolatileInt(Object object, long offset, int i32) Writes a volatile integer to the object at the given offset.
void	writeVolatileLong(long address, long i64) Writes a volatile long to the memory at the given address.
void	writeVolatileLong(Object object, long offset, long i64) Writes a volatile long to the object at the given offset.
void	writeVolatileShort(long address, short i16) Writes a volatile short to the memory at the given address.
void	writeVolatileShort(Object object, long offset, short i16) Writes a volatile short to the object at the given offset.

Method Detail

storeFence

void storeFence()

Ensures that all previous writes to memory are completed before any subsequent memory access instruction.

loadFence

void loadFence()

Ensures that all previous reads from memory are completed before any subsequent memory access instruction.

setMemory

void setMemory(long address,
               long size,
               byte b)

Sets the memory at the specified address with the given byte value.

Parameters:

address - The starting address of the memory block.

size - The size of the memory block in bytes.

b - The byte value to be set.

setMemory

void setMemory(Object o,
               long offset,
               long size,
               byte b)

Sets the memory at the specified offset within the given object with the given byte value.

Parameters:

o - The object containing the memory block.

offset - The offset within the object where the memory block starts.

size - The size of the memory block in bytes.

b - The byte value to be set.

freeMemory

void freeMemory(long address,
                long size)

Frees the memory block at the specified address with the given size.

Parameters:

address - The starting address of the memory block.

size - The size of the memory block in bytes.

allocate

long allocate(long capacity)

Allocates memory and returns the low level base address of the newly allocated memory region.

Parameters:

capacity - to allocate

Returns:

the low level base address of the newly allocated memory region

Throws:

IllegalArgumentException - If the capacity is non-positive

OutOfMemoryError - if there are not enough memory to allocate

nativeMemoryUsed

long nativeMemoryUsed()

Retrieves the amount of native memory currently used by the application.

Returns:

The number of bytes used in the native memory.

writeByte

void writeByte(long address,
               byte i8)

Writes a byte value to the memory at the specified address.

Parameters:

address - The address where the byte should be written.

i8 - The byte value to be written.

writeByte

void writeByte(Object object,
               long offset,
               byte b)

Writes a byte value to the memory at the specified offset within the given object.

Parameters:

object - The object containing the memory block.

offset - The offset within the object where the byte should be written.

b - The byte value to be written.

readByte

byte readByte(Object object,
              long offset)

Reads a byte value from the memory at the specified offset within the given object.

Parameters:

object - The object containing the memory block.

offset - The offset within the object where the byte should be read.

Returns:

The byte value read from memory.

writeBytes

void writeBytes(long address,
                byte[] b,
                int offset,
                int length)
         throws IllegalArgumentException

Writes an array of bytes to the memory at the specified address.

Parameters:

address - The address where the bytes should be written.

b - The byte array containing the bytes to be written.

offset - The starting offset within the array.

length - The number of bytes to be written.

Throws:

IllegalArgumentException - If the offset or length is invalid.

readBytes

void readBytes(long address,
               byte[] b,
               long offset,
               int length)
        throws IllegalArgumentException

Reads an array of bytes from the memory at the specified address and stores it in the provided byte array.

Parameters:

address - The address where the bytes should be read from.

b - The byte array to store the read bytes.

offset - The starting offset within the byte array.

length - The number of bytes to be read.

Throws:

IllegalArgumentException - If the offset or length is invalid.

readByte

byte readByte(long address)

Reads a byte value from the memory at the specified address.

Parameters:

address - The address where the byte should be read from.

Returns:

The byte value read from memory.

writeShort

void writeShort(long address,
                short i16)

Writes a short value to the memory at the specified address.

Parameters:

address - The address where the short should be written.

i16 - The short value to be written.

writeShort

void writeShort(Object object,
                long offset,
                short i16)

Writes a short value to the memory at the specified offset within the given object.

Parameters:

object - The object containing the memory block.

offset - The offset within the object where the short should be written.

i16 - The short value to be written.

readShort

short readShort(long address)

Reads a short value from the memory at the specified address.

Parameters:

address - The address where the short should be read from.

Returns:

The short value read from memory.

readShort

short readShort(Object object,
                long offset)

Reads a short value from the memory at the specified offset within the given object.

Parameters:

object - The object containing the memory block.

offset - The offset within the object where the short should be read.

Returns:

The short value read from memory.

writeInt

void writeInt(long address,
              int i32)

Writes an int value to the memory at the specified address.

Parameters:

address - The address where the int should be written.

i32 - The int value to be written.

writeInt

void writeInt(Object object,
              long offset,
              int i32)

Writes an int value to the memory at the specified offset within the given object.

Parameters:

object - The object containing the memory block.

offset - The offset within the object where the int should be written.

i32 - The int value to be written.

writeOrderedInt

void writeOrderedInt(long offset,
                     int i32)

Writes an int value to the memory at the specified offset within the given object in an ordered manner.

Parameters:

offset - The offset within the object where the int should be written.

i32 - The int value to be written.

writeOrderedInt

void writeOrderedInt(Object object,
                     long offset,
                     int i32)

Writes an int value to the memory at the specified offset within the given object in an ordered manner.

Parameters:

object - The object containing the memory block.

offset - The offset within the object where the int should be written.

i32 - The int value to be written.

readInt

int readInt(long address)

Reads an int value from the memory at the specified address.

Parameters:

address - The address where the int should be read from.

Returns:

The int value read from memory.

readInt

int readInt(Object object,
            long offset)

Reads an int value from the memory at the specified offset within the given object.

Parameters:

object - The object containing the memory block.

offset - The offset within the object where the int should be read.

Returns:

The int value read from memory.

writeLong

void writeLong(long address,
               long i64)

Writes a long value to the memory at the specified address.

Parameters:

address - The address where the long should be written.

i64 - The long value to be written.

writeLong

void writeLong(Object object,
               long offset,
               long i64)

Writes a long value to the memory at the specified offset within the given object.

Parameters:

object - The object containing the memory block.

offset - The offset within the object where the long should be written.

i64 - The long value to be written.

readLong

long readLong(long address)

Reads a long value from the memory at the specified address.

Parameters:

address - The address where the long should be read from.

Returns:

The long value read from memory.

readLong

long readLong(Object object,
              long offset)

Reads a long value from the memory at the specified offset within the given object.

Parameters:

object - The object containing the memory block.

offset - The offset within the object where the long should be read.

Returns:

The long value read from memory.

writeFloat

void writeFloat(long address,
                float f)

Writes a float value to the memory at the specified address.

Parameters:

address - The address where the float should be written.

f - The float value to be written.

writeFloat

void writeFloat(Object object,
                long offset,
                float f)

Writes a float value to the memory at the specified offset within the given object.

Parameters:

object - The object containing the memory block.

offset - The offset within the object where the float should be written.

f - The float value to be written.

readFloat

float readFloat(long address)

Reads a float value from the memory at the specified address.

Parameters:

address - The address where the float should be read from.

Returns:

The float value read from memory.

readFloat

float readFloat(Object object,
                long offset)

Reads a float value from the memory at the specified offset within the given object.

Parameters:

object - The object containing the memory block.

offset - The offset within the object where the float should be read.

Returns:

The float value read from memory.

writeDouble

void writeDouble(long address,
                 double d)

Writes a double value to the memory at the specified address.

Parameters:

address - The address where the double should be written.

d - The double value to be written.

writeDouble

void writeDouble(Object object,
                 long offset,
                 double d)

Writes a double value to the memory at the specified offset within the given object.

Parameters:

object - The object containing the memory block.

offset - The offset within the object where the double should be written.

d - The double value to be written.

readDouble

double readDouble(long address)

Reads a double value from the memory at the specified address.

Parameters:

address - The address where the double should be read from.

Returns:

The double value read from memory.

readDouble

double readDouble(Object object,
                  long offset)

Reads a double value from the memory at the specified offset within the given object.

Parameters:

object - The object containing the memory block.

offset - The offset within the object where the double should be read.

Returns:

The double value read from memory.

copyMemory

void copyMemory(byte[] bytes,
                int offset,
                long address,
                int length)

Copies a range of bytes from the given byte array to the specified memory address.

Parameters:

bytes - the source byte array

offset - the starting index in the byte array

address - the destination memory address

length - the number of bytes to copy

copyMemory

void copyMemory(long fromAddress,
                long address,
                long length)

Copies a range of memory from one address to another.

Parameters:

fromAddress - the source memory address

address - the destination memory address

length - the number of bytes to copy

copyMemory

void copyMemory(Object o,
                long offset,
                long toAddress,
                int length)

Copies a range of memory from the given object to the specified memory address.

Parameters:

o - the source object

offset - the starting offset in the source object

toAddress - the destination memory address

length - the number of bytes to copy

copyMemory

void copyMemory(Object o,
                long offset,
                Object o2,
                long offset2,
                int length)

Copies a range of memory from one object to another at the specified offsets.

Parameters:

o - the source object

offset - the starting offset in the source object

o2 - the destination object

offset2 - the starting offset in the destination object

length - the number of bytes to copy

copyMemory

void copyMemory(long fromAddress,
                Object obj2,
                long offset2,
                int length)

Copies a range of memory from the given memory address to the specified object at the given offset.

Parameters:

fromAddress - the source memory address

obj2 - the destination object

offset2 - the starting offset in the destination object

length - the number of bytes to copy

stopBitLength

int stopBitLength(int i)

Returns the length in bytes required to encode an integer using stop-bit encoding.

Parameters:

i - the integer value

Returns:

the number of bytes required to encode the integer

stopBitLength

int stopBitLength(long l)

Returns the length in bytes required to encode a long integer using stop-bit encoding.

Parameters:

l - the long integer value

Returns:

the number of bytes required to encode the long integer

partialRead

long partialRead(byte[] bytes,
                 int offset,
                 int length)

Reads a partial value from the given byte array starting at the specified offset.

Parameters:

bytes - the source byte array

offset - the starting index in the byte array

length - the number of bytes to read

Returns:

the partial value read from the byte array

partialRead

long partialRead(long addr,
                 int length)

Reads a partial value from the memory at the given address.

Parameters:

addr - the source memory address

length - the number of bytes to read

Returns:

the partial value read from the memory

partialWrite

void partialWrite(byte[] bytes,
                  int offset,
                  long value,
                  int length)

Writes a partial value to the byte array at the specified offset.

Parameters:

bytes - the destination byte array

offset - the starting index in the byte array

value - the partial value to write

length - the number of bytes to write

partialWrite

void partialWrite(long addr,
                  long value,
                  int length)

Writes a partial value to the memory at the given address.

Parameters:

addr - the destination memory address

value - the partial value to write

length - the number of bytes to write

is7Bit

boolean is7Bit(byte[] bytes,
               int offset,
               int length)

Checks if the bytes in the specified byte array are 7-bit ASCII characters.

Parameters:

bytes - the byte array

offset - the starting index in the byte array

length - the number of bytes to check

Returns:

true if all bytes are 7-bit ASCII characters, false otherwise

is7Bit

boolean is7Bit(char[] chars,
               int offset,
               int length)

Checks if the characters in the specified char array are 7-bit ASCII characters.

Parameters:

chars - the char array

offset - the starting index in the char array

length - the number of characters to check

Returns:

true if all characters are 7-bit ASCII characters, false otherwise

is7Bit

boolean is7Bit(long address,
               int length)

Checks if the bytes in the memory at the given address are 7-bit ASCII characters.

Parameters:

address - the memory address

length - the number of bytes to check

Returns:

true if all bytes are 7-bit ASCII characters, false otherwise

writeOrderedLong

void writeOrderedLong(long address,
                      long i)

Writes a long value to memory at the given address with ordered store semantics.

Parameters:

address - the memory address

i - the long value to write

writeOrderedLong

void writeOrderedLong(Object object,
                      long offset,
                      long i)

Writes a long value to the object at the given offset with ordered store semantics.

Parameters:

object - the destination object

offset - the offset in the destination object

i - the long value to write

testAndSetInt

void testAndSetInt(long address,
                   long offset,
                   int expected,
                   int value)
            throws IllegalStateException

Atomically sets the value at the specified address to the given value if it equals the expected value. Throws an IllegalStateException If the value does not match the expected value.

Parameters:

address - the memory address

offset - the offset in the memory address

expected - the expected value

value - the new value

Throws:

IllegalStateException - if the current value does not match the expected value

testAndSetInt

void testAndSetInt(Object object,
                   long offset,
                   int expected,
                   int value)
            throws IllegalStateException

Atomically sets the value at the specified offset in the object to the given value if it equals the expected value. Throws an IllegalStateException If the value does not match the expected value.

Parameters:

object - the destination object

offset - the offset in the destination object

expected - the expected value

value - the new value

Throws:

IllegalStateException - if the current value does not match the expected value

compareAndSwapInt

boolean compareAndSwapInt(long address,
                          int expected,
                          int value)
                   throws MisAlignedAssertionError

Compares the value at the specified memory address with the expected value and, if equal, sets it to the new value. Returns true if the value was successfully swapped, false otherwise.

Parameters:

address - the memory address

expected - the expected value

value - the new value

Returns:

true if the value was successfully swapped, false otherwise

Throws:

MisAlignedAssertionError - if the memory address is misaligned for the operation

compareAndSwapInt

boolean compareAndSwapInt(Object object,
                          long offset,
                          int expected,
                          int value)
                   throws MisAlignedAssertionError

Compares the value at the specified offset in the object with the expected value and, if equal, sets it to the new value. Returns true if the value was successfully swapped, false otherwise.

Parameters:

object - the destination object

offset - the offset in the destination object

expected - the expected value

value - the new value

Returns:

true if the value was successfully swapped, false otherwise

Throws:

MisAlignedAssertionError - if the offset is misaligned for the operation

compareAndSwapLong

boolean compareAndSwapLong(long address,
                           long expected,
                           long value)
                    throws MisAlignedAssertionError

Compares the value at the specified memory address with the expected value and, if equal, sets it to the new value. Returns true if the value was successfully swapped, false otherwise.

Parameters:

address - the memory address

expected - the expected value

value - the new value

Returns:

true if the value was successfully swapped, false otherwise

Throws:

MisAlignedAssertionError - if the memory address is misaligned for the operation

compareAndSwapLong

boolean compareAndSwapLong(Object object,
                           long offset,
                           long expected,
                           long value)
                    throws MisAlignedAssertionError

Compares the value at the specified offset in the object with the expected value and, if equal, sets it to the new value. Returns true if the value was successfully swapped, false otherwise.

Parameters:

object - the destination object

offset - the offset in the destination object

expected - the expected value

value - the new value

Returns:

true if the value was successfully swapped, false otherwise

Throws:

MisAlignedAssertionError - if the offset is misaligned for the operation

getAndSetInt

int getAndSetInt(long address,
                 int value)
          throws MisAlignedAssertionError

Atomically sets the value at the specified address to the given value and returns the previous value

Parameters:

address - the memory address

value - the new value

Returns:

the previous value at the memory address

Throws:

MisAlignedAssertionError - if the memory address is misaligned for the operation

getAndSetInt

int getAndSetInt(Object object,
                 long offset,
                 int value)
          throws MisAlignedAssertionError

Atomically sets the value at the specified offset in the object to the given value and returns the previous value.

Parameters:

object - the destination object

offset - the offset in the destination object

value - the new value

Returns:

the previous value at the offset in the object

Throws:

MisAlignedAssertionError - if the offset is misaligned for the operation

pageSize

int pageSize()

Returns the page size of the underlying memory system.

Returns:

the page size

readVolatileByte

byte readVolatileByte(long address)

Reads a volatile byte from the memory at the given address.

Parameters:

address - the memory address

Returns:

the byte value read from the memory

readVolatileByte

byte readVolatileByte(Object object,
                      long offset)

Reads a volatile byte from the object at the given offset.

Parameters:

object - the source object

offset - the offset in the object

Returns:

the byte value read from the object

readVolatileShort

short readVolatileShort(long address)

Reads a volatile short from the memory at the given address.

Parameters:

address - the memory address

Returns:

the short value read from the memory

readVolatileShort

short readVolatileShort(Object object,
                        long offset)

Reads a volatile short from the object at the given offset.

Parameters:

object - the source object

offset - the offset in the object

Returns:

the short value read from the object

readVolatileInt

int readVolatileInt(long address)

Reads a volatile integer from the memory at the given address.

Parameters:

address - the memory address

Returns:

the integer value read from the memory

readVolatileInt

int readVolatileInt(Object object,
                    long offset)

Reads a volatile integer from the object at the given offset.

Parameters:

object - the source object

offset - the offset in the object

Returns:

the integer value read from the object

readVolatileFloat

float readVolatileFloat(long address)

Reads a volatile float from the memory at the given address.

Parameters:

address - the memory address

Returns:

the float value read from the memory

readVolatileFloat

float readVolatileFloat(Object object,
                        long offset)

Reads a volatile float from the object at the given offset.

Parameters:

object - the source object

offset - the offset in the object

Returns:

the float value read from the object

readVolatileLong

long readVolatileLong(long address)

Reads a volatile long from the memory at the given address.

Parameters:

address - the memory address

Returns:

the long value read from the memory

readVolatileLong

long readVolatileLong(Object object,
                      long offset)

Reads a volatile long from the object at the given offset.

Parameters:

object - the source object

offset - the offset in the object

Returns:

the long value

read from the object

readVolatileDouble

double readVolatileDouble(long address)

Reads a volatile double from the memory at the given address.

Parameters:

address - the memory address

Returns:

the double value read from the memory

readVolatileDouble

double readVolatileDouble(Object object,
                          long offset)

Reads a volatile double from the object at the given offset.

Parameters:

object - the source object

offset - the offset in the object

Returns:

the double value read from the object

writeVolatileByte

void writeVolatileByte(long address,
                       byte b)

Writes a volatile byte to the memory at the given address.

Parameters:

address - the memory address

b - the byte value to write

writeVolatileByte

void writeVolatileByte(Object object,
                       long offset,
                       byte b)

Writes a volatile byte to the object at the given offset.

Parameters:

object - the destination object

offset - the offset in the destination object

b - the byte value to write

writeVolatileShort

void writeVolatileShort(long address,
                        short i16)

Writes a volatile short to the memory at the given address.

Parameters:

address - the memory address

i16 - the short value to write

writeVolatileShort

void writeVolatileShort(Object object,
                        long offset,
                        short i16)

Writes a volatile short to the object at the given offset.

Parameters:

object - the destination object

offset - the offset in the destination object

i16 - the short value to write

writeVolatileInt

void writeVolatileInt(long address,
                      int i32)

Writes a volatile integer to the memory at the given address.

Parameters:

address - the memory address

i32 - the integer value to write

writeVolatileInt

void writeVolatileInt(Object object,
                      long offset,
                      int i32)

Writes a volatile integer to the object at the given offset.

Parameters:

object - the destination object

offset - the offset in the destination object

i32 - the integer value to write

writeVolatileFloat

void writeVolatileFloat(long address,
                        float f)

Writes a volatile float to the memory at the given address.

Parameters:

address - the memory address

f - the float value to write

writeVolatileFloat

void writeVolatileFloat(Object object,
                        long offset,
                        float f)

Writes a volatile float to the object at the given offset.

Parameters:

object - the destination object

offset - the offset in the destination object

f - the float value to write

writeVolatileLong

void writeVolatileLong(long address,
                       long i64)

Writes a volatile long to the memory at the given address.

Parameters:

address - the memory address

i64 - the long value to write

writeVolatileLong

void writeVolatileLong(Object object,
                       long offset,
                       long i64)

Writes a volatile long to the object at the given offset.

Parameters:

object - the destination object

offset - the offset in the destination object

i64 - the long value to write

writeVolatileDouble

void writeVolatileDouble(long address,
                         double d)

Writes a volatile double to the memory at the given address.

Parameters:

address - the memory address

d - the double value to write

writeVolatileDouble

void writeVolatileDouble(Object object,
                         long offset,
                         double d)

Writes a volatile double to the object at the given offset.

Parameters:

object - the destination object

offset - the offset in the destination object

d - the double value to write

addInt

int addInt(long address,
           int increment)
    throws MisAlignedAssertionError

Adds the specified increment to the value at the given memory address and returns the updated value.

Parameters:

address - the memory address

increment - the value to add

Returns:

the updated value at the memory address

Throws:

MisAlignedAssertionError - if the memory address is misaligned for the operation

addInt

int addInt(Object object,
           long offset,
           int increment)

Adds the specified increment to the value at the given offset in the object and returns the updated value.

Parameters:

object - the destination object

offset - the offset in the destination object

increment - the value to add

Returns:

the updated value at the offset in the object

addLong

long addLong(long address,
             long increment)
      throws MisAlignedAssertionError

Adds the specified increment to the value at the given memory address and returns the updated value.

Parameters:

address - the memory address

increment - the value to add

Returns:

the updated value at the memory address

Throws:

MisAlignedAssertionError - if the memory address is misaligned for the operation

addLong

long addLong(Object object,
             long offset,
             long increment)
      throws MisAlignedAssertionError

Adds the specified increment to the value at the given offset in the object and returns the updated value.

Parameters:

object - the destination object

offset - the offset in the destination object

increment - the value to add

Returns:

the updated value at the offset in the object

Throws:

MisAlignedAssertionError - if the offset is misaligned for the operation

allocateInstance

@NotNull
<E> E allocateInstance(Class<? extends E> clazz)
                         throws InstantiationException

Allocates and returns a new instance of the specified class.

Type Parameters:

E - the type of the class

Parameters:

clazz - the class to instantiate

Returns:

a new instance of the specified class

Throws:

InstantiationException - If the class cannot be instantiated

getFieldOffset

long getFieldOffset(Field field)

Returns the offset of the specified field in its containing object.

Parameters:

field - the field

Returns:

the offset of the field

putObject

void putObject(@NotNull
               @NotNull Object o,
               long offset,
               Object value)

Sets the value of the specified field in the given object.

Parameters:

o - the object

offset - the offset of the field in the object

value - the new value of the field

getObject

@NotNull
<T> T getObject(@NotNull
                         @NotNull Object o,
                         long offset)

Returns the value of the specified field in the given object.

Type Parameters:

T - the type of the field

Parameters:

o - the object

offset - the offset of the field in the object

Returns:

the value of the field

arrayBaseOffset

int arrayBaseOffset(Class<?> type)

Returns the base offset of the elements in the specified array type.

Parameters:

type - the array type

Returns:

the base offset of the array type

objectFieldOffset

long objectFieldOffset(Field field)

Returns the offset of the specified field in its containing object.

Parameters:

field - the field

Returns:

the offset of the field

sizeOf

static int sizeOf(Class<?> type)

Parameters:

type - of primitive or a reference

Returns:

the number of bytes this type uses.

safeAlignedInt

boolean safeAlignedInt(long addr)

Returns if the provided addr would provide access to an int that would reside entirely within a distinct cache-line.

Parameters:

addr - to use

Returns:

if int access would be confined to the same cache-line

safeAlignedLong

boolean safeAlignedLong(long addr)

Returns if the provided addr would provide access to a long that would reside entirely within a distinct cache-line.

Parameters:

addr - to use

Returns:

if long access would be confined to the same cache-line

address

long address(ByteBuffer bb)

Returns the memory address associated with the given ByteBuffer.

Parameters:

bb - the ByteBuffer

Returns:

the memory address associated with the ByteBuffer