net.openhft.chronicle.bytes

Class MappedBytesStore

java.lang.Object

net.openhft.chronicle.core.io.AbstractReferenceCounted

net.openhft.chronicle.bytes.internal.AbstractBytesStore<NativeBytesStore<U>,U>

net.openhft.chronicle.bytes.internal.NativeBytesStore<Void>

net.openhft.chronicle.bytes.MappedBytesStore

All Implemented Interfaces:

CharSequence, BytesStore<NativeBytesStore<Void>,Void>, RandomDataInput, RandomDataOutput<NativeBytesStore<Void>>, net.openhft.chronicle.core.io.ReferenceCounted, net.openhft.chronicle.core.io.ReferenceCountedTracer, net.openhft.chronicle.core.io.ReferenceOwner

public class MappedBytesStore
extends NativeBytesStore<Void>

BytesStore to wrap memory mapped data.

WARNING: Handle with care as this assumes the caller has correct bounds checking

Field Summary

Fields

Modifier and Type	Field and Description
static @NotNull MappedBytesStoreFactory	MAPPED_BYTES_STORE_FACTORY
protected Runnable	writeCheck

Fields inherited from class net.openhft.chronicle.bytes.internal.NativeBytesStore

address, limit, maximumLimit, memory

Fields inherited from class net.openhft.chronicle.core.io.AbstractReferenceCounted

referenceCounted, WARN_COUNT, WARN_NS

Fields inherited from interface net.openhft.chronicle.bytes.RandomDataInput

charToString

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT, TMP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MappedBytesStore(net.openhft.chronicle.core.io.ReferenceOwner owner, MappedFile mappedFile, long start, long address, long capacity, long safeCapacity)

Method Summary

Modifier and Type	Method and Description
default long	addressForRead(long offset, int buffer)
long	appendUtf8(long pos, char[] chars, int offset, int length)
default ByteOrder	byteOrder()
@NotNull Bytes<Void>	bytesForRead() Returns a Bytes that wraps this ByteStore from the start to the realCapacity.
@NotNull VanillaBytes<Void>	bytesForWrite() Returns a Bytes that wraps this ByteStore from the start to the realCapacity.
boolean	compareAndSwapInt(long offset, int expected, int value) Perform a 32-bit CAS at a given offset.
boolean	compareAndSwapLong(long offset, long expected, long value) Perform a 64-bit CAS at a given offset.
boolean	inside(long offset) Returns if a specified offset is inside this BytesStore limits.
boolean	inside(long offset, long buffer) Returns if a number of bytes starting from an offset are inside this ByteStore limits.
default long	lengthWritten(long startPosition) Typically this calculates the difference however for HexDumpBytes it's not as simple.
FileLock	lock(long position, long size, boolean shared) Calls lock on the underlying file channel
void	nativeWrite(long address, long position, long size) expert level method to copy data from native memory into the BytesStore
protected void	performRelease() Sync the ByteStore if required.
byte	readByte(long offset) Read byte at an offset
default long	readLimit() If the resource is closed, the returned value is unspecified.
long	readPosition() Returns the read position.
default long	realReadRemaining() If the resource is closed, the returned value is unspecified.
default long	realWriteRemaining() If the resource is closed, the returned value is unspecified.
long	safeLimit()
long	start()
SyncMode	syncMode()
void	syncMode(SyncMode syncMode) Set the sync mode for this ByteStore
void	syncUpTo(long position) Synchronise from the last complete page up to this position.
long	translate(long offset)
FileLock	tryLock(long position, long size, boolean shared) Calls tryLock on the underlying file channel
long	underlyingCapacity() Fetch the capacity of the underlying file This can differ from the exposed capacity() of this bytes store (which has been page aligned)
@NotNull MappedBytesStore	write(long offsetInRDO, byte[] byteArray, int offset, int length) Copies the provided byteArray to this Bytes object starting at writeOffset taking content starting at readOffset but copying at most length bytes.
void	write(long offsetInRDO, @NotNull ByteBuffer bytes, int offset, int length) Copy from ByteBuffer into this.
@NotNull MappedBytesStore	write(long writeOffset, @NotNull RandomDataInput bytes, long readOffset, long length) Copy from RandomDataInput into this.
void	write0(long offsetInRDO, @NotNull RandomDataInput bytes, long offset, long length)
@NotNull MappedBytesStore	writeByte(long offset, byte i8) Write an unsigned byte at an offset.
@NotNull MappedBytesStore	writeDouble(long offset, double d) Write a double at an offset.
@NotNull MappedBytesStore	writeFloat(long offset, float f) Write a float at an offset.
@NotNull MappedBytesStore	writeInt(long offset, int i32) Write an int at an offset.
default long	writeLimit() Returns the write limit.
@NotNull MappedBytesStore	writeLong(long offset, long i64) Write a long at an offset.
@NotNull MappedBytesStore	writeOrderedInt(long offset, int i) Perform a non stalling write with a store barrier.
@NotNull MappedBytesStore	writeOrderedLong(long offset, long i) Perform a non stalling write with a store barrier.
default long	writePosition() Returns the write position.
@NotNull MappedBytesStore	writeShort(long offset, short i16) Write a short at an offset.
@NotNull MappedBytesStore	writeVolatileByte(long offset, byte i8)
@NotNull MappedBytesStore	writeVolatileInt(long offset, int i32)
@NotNull MappedBytesStore	writeVolatileLong(long offset, long i64)
@NotNull MappedBytesStore	writeVolatileShort(long offset, short i16)
@NotNull MappedBytesStore	zeroOut(long start, long end) Fills the BytesStore with zeros.

Methods inherited from class net.openhft.chronicle.bytes.internal.NativeBytesStore

addAndGetInt, addAndGetLong, addressForRead, addressForWrite, addressForWritePosition, backgroundPerformRelease, byteCheckSum, byteCheckSum, canReadDirect, capacity, copy, copyTo, copyToDirect, elasticByteBuffer, elasticByteBuffer, equals, fastHash, from, from, hashCode, init, isDirectMemory, isEqual, lazyNativeBytesStoreWithFixedCapacity, move, nativeRead, nativeStore, nativeStoreWithFixedCapacity, peekUnsignedByte, read, read8bit, readDouble, readFloat, readIncompleteLong, readInt, readLong, readShort, readUnsignedByte, readVolatileByte, readVolatileInt, readVolatileLong, readVolatileShort, realCapacity, setAddress, sharedMemory, testAndSetInt, toString, toTemporaryDirectByteBuffer, underlyingObject, uninit, uninitialized, wrap, write8bit, write8bit

Methods inherited from class net.openhft.chronicle.bytes.internal.AbstractBytesStore

canReleaseInBackground, readRemaining, writeRemaining

Methods inherited from class net.openhft.chronicle.core.io.AbstractReferenceCounted

assertReferencesReleased, clearUsedByThread, createdHere, disableReferenceTracing, enableReferenceTracing, refCount, referenceId, release, releaseLast, reserve, reservedBy, reserveTransfer, singleThreadedCheckDisabled, singleThreadedCheckReset, threadSafetyCheck, throwExceptionIfNotReleased, throwExceptionIfReleased, tryReserve, unmonitor, warnAndReleaseIfNotReleased

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.openhft.chronicle.bytes.BytesStore

addAndGetDouble, addAndGetDoubleNotAtomic, addAndGetFloat, addAndGetFloatNotAtomic, addAndGetIntNotAtomic, addAndGetShortNotAtomic, addAndGetUnsignedByteNotAtomic, bytesStore, charAt, cipher, cipher, compareAndSwapDouble, compareAndSwapFloat, contentEquals, copyTo, empty, endsWith, equalBytes, forFields, from, from, hash, isClear, isEmpty, isImmutableEmptyByteStore, length, nativePointer, nativeStoreFrom, readWrite, startsWith, startsWith, subSequence, to8bitString, toDebugString, toDebugString, wrap, wrap, writeMaxInt, writeMaxLong

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataInput

canReadDirect, compareUtf8, copyTo, copyTo, createCharToString, findByte, parseLong, peekVolatileInt, printable, readBoolean, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8Limited, readUtf8Limited, readVolatileDouble, readVolatileFloat, subBytes, toByteArray

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataOutput

append, append, write, write, writeBoolean, writeByte, writeInt24, writeOrderedDouble, writeOrderedFloat, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort, writeUtf8, writeUtf8Limited, writeVolatileDouble, writeVolatileFloat

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceCounted

refCount, release, releaseLast, releaseLast, reserve, reservedBy, reserveTransfer, tryReserve

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

referenceId, referenceName, temporary

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceCountedTracer

onReleased

Field Detail

MAPPED_BYTES_STORE_FACTORY

@NotNull
public static final @NotNull MappedBytesStoreFactory MAPPED_BYTES_STORE_FACTORY

writeCheck

protected final Runnable writeCheck

Constructor Detail

MappedBytesStore

protected MappedBytesStore(net.openhft.chronicle.core.io.ReferenceOwner owner,
                           MappedFile mappedFile,
                           long start,
                           long address,
                           long capacity,
                           long safeCapacity)
                    throws IllegalStateException

Throws:

IllegalStateException

Method Detail

underlyingCapacity

public long underlyingCapacity()

Fetch the capacity of the underlying file This can differ from the exposed capacity() of this bytes store (which has been page aligned)

Returns:

- capacity of the underlying file

bytesForRead

@NotNull
public @NotNull Bytes<Void> bytesForRead()
                                           throws IllegalStateException

Description copied from interface: BytesStore

Returns a Bytes that wraps this ByteStore from the start to the realCapacity.

The returned Bytes is not elastic and can be both read and written using cursors.

Returns:

a Bytes that wraps this ByteStore

Throws:

IllegalStateException - if this Bytes has been released

bytesForWrite

@NotNull
public @NotNull VanillaBytes<Void> bytesForWrite()
                                                   throws IllegalStateException

Description copied from interface: BytesStore

Returns a Bytes that wraps this ByteStore from the start to the realCapacity.

The returned Bytes is not elastic and can be both read and written using cursors.

Specified by:

bytesForWrite in interface BytesStore<NativeBytesStore<Void>,Void>

Overrides:

bytesForWrite in class NativeBytesStore<Void>

Returns:

a Bytes that wraps this BytesStore

Throws:

IllegalStateException - if this BytesStore has been released

inside

public boolean inside(long offset)

Description copied from interface: BytesStore

Returns if a specified offset is inside this BytesStore limits.

Use this test to determine if an offset is considered safe.

Parameters:

offset - the specified offset to check

Returns:

true if offset is safe

inside

public boolean inside(long offset,
                      long buffer)

Description copied from interface: BytesStore

Returns if a number of bytes starting from an offset are inside this ByteStore limits.

Parameters:

offset - the starting index to check

buffer - the number of bytes after the offset to check

Returns:

true if the bytes between the offset and offset+buffer are inside the BytesStore

safeLimit

public long safeLimit()

Specified by:

safeLimit in interface BytesStore<NativeBytesStore<Void>,Void>

Overrides:

safeLimit in class NativeBytesStore<Void>

Returns:

how many bytes can be safely read, i.e. what is the real capacity of the underlying data.

readByte

public byte readByte(long offset)

Description copied from interface: RandomDataInput

Read byte at an offset

Specified by:

readByte in interface RandomDataInput

Overrides:

readByte in class NativeBytesStore<Void>

Parameters:

offset - to read

Returns:

the byte

writeOrderedInt

@NotNull
public @NotNull MappedBytesStore writeOrderedInt(long offset,
                                                          int i)
                                                   throws IllegalStateException

Description copied from interface: RandomDataOutput

Perform a non stalling write with a store barrier.

Specified by:

writeOrderedInt in interface RandomDataOutput<NativeBytesStore<Void>>

Overrides:

writeOrderedInt in class NativeBytesStore<Void>

Parameters:

offset - to write to

i - value to write

Returns:

this

Throws:

IllegalStateException

translate

public long translate(long offset)

Overrides:

translate in class NativeBytesStore<Void>

start

public long start()

Overrides:

start in class AbstractBytesStore<NativeBytesStore<Void>,Void>

Returns:

The smallest position allowed in this buffer.

readPosition

public long readPosition()

Returns the read position.

The read position is start() <= readPosition() && readPosition() <= readLimit() && readPosition < safeLimit()

If the resource is closed, the returned value is unspecified.

Overrides:

readPosition in class AbstractBytesStore<NativeBytesStore<Void>,Void>

Returns:

position to read from.

lock

public FileLock lock(long position,
                     long size,
                     boolean shared)
              throws IOException

Calls lock on the underlying file channel

Throws:

IOException

tryLock

public FileLock tryLock(long position,
                        long size,
                        boolean shared)
                 throws IOException

Calls tryLock on the underlying file channel

Throws:

IOException

zeroOut

@NotNull
public @NotNull MappedBytesStore zeroOut(long start,
                                                  long end)

Description copied from interface: BytesStore

Fills the BytesStore with zeros.

Specified by:

zeroOut in interface BytesStore<NativeBytesStore<Void>,Void>

Specified by:

zeroOut in interface RandomDataOutput<NativeBytesStore<Void>>

Overrides:

zeroOut in class NativeBytesStore<Void>

Parameters:

start - first byte inclusive

end - last byte exclusive

Returns:

this

compareAndSwapInt

public boolean compareAndSwapInt(long offset,
                                 int expected,
                                 int value)
                          throws IllegalStateException

Description copied from interface: RandomDataInput

Perform a 32-bit CAS at a given offset.

Specified by:

compareAndSwapInt in interface BytesStore<NativeBytesStore<Void>,Void>

Specified by:

compareAndSwapInt in interface RandomDataInput

Specified by:

compareAndSwapInt in interface RandomDataOutput<NativeBytesStore<Void>>

Overrides:

compareAndSwapInt in class NativeBytesStore<Void>

Parameters:

offset - to perform CAS

expected - value

value - to set

Returns:

true, if successful.

Throws:

IllegalStateException

compareAndSwapLong

public boolean compareAndSwapLong(long offset,
                                  long expected,
                                  long value)
                           throws IllegalStateException

Description copied from interface: RandomDataInput

Perform a 64-bit CAS at a given offset.

Specified by:

compareAndSwapLong in interface BytesStore<NativeBytesStore<Void>,Void>

Specified by:

compareAndSwapLong in interface RandomDataInput

Specified by:

compareAndSwapLong in interface RandomDataOutput<NativeBytesStore<Void>>

Overrides:

compareAndSwapLong in class NativeBytesStore<Void>

Parameters:

offset - to perform CAS

expected - value

value - to set

Returns:

true, if successful.

Throws:

IllegalStateException

writeByte

@NotNull
public @NotNull MappedBytesStore writeByte(long offset,
                                                    byte i8)
                                             throws IllegalStateException

Description copied from interface: RandomDataOutput

Write an unsigned byte at an offset.

Specified by:

writeByte in interface RandomDataOutput<NativeBytesStore<Void>>

Overrides:

writeByte in class NativeBytesStore<Void>

Parameters:

offset - to write to

i8 - the value

Returns:

this

Throws:

IllegalStateException

writeShort

@NotNull
public @NotNull MappedBytesStore writeShort(long offset,
                                                     short i16)
                                              throws IllegalStateException

Description copied from interface: RandomDataOutput

Write a short at an offset.

Specified by:

writeShort in interface RandomDataOutput<NativeBytesStore<Void>>

Overrides:

writeShort in class NativeBytesStore<Void>

Parameters:

offset - to write to

i16 - the value

Returns:

this

Throws:

IllegalStateException

writeInt

@NotNull
public @NotNull MappedBytesStore writeInt(long offset,
                                                   int i32)
                                            throws IllegalStateException

Description copied from interface: RandomDataOutput

Write an int at an offset.

Specified by:

writeInt in interface RandomDataOutput<NativeBytesStore<Void>>

Overrides:

writeInt in class NativeBytesStore<Void>

Parameters:

offset - to write to

i32 - the value

Returns:

this

Throws:

IllegalStateException

writeLong

@NotNull
public @NotNull MappedBytesStore writeLong(long offset,
                                                    long i64)
                                             throws IllegalStateException

Description copied from interface: RandomDataOutput

Write a long at an offset.

Specified by:

writeLong in interface RandomDataOutput<NativeBytesStore<Void>>

Overrides:

writeLong in class NativeBytesStore<Void>

Parameters:

offset - to write to

i64 - the value

Returns:

this

Throws:

IllegalStateException

writeOrderedLong

@NotNull
public @NotNull MappedBytesStore writeOrderedLong(long offset,
                                                           long i)
                                                    throws IllegalStateException

Description copied from interface: RandomDataOutput

Perform a non stalling write with a store barrier.

Specified by:

writeOrderedLong in interface RandomDataOutput<NativeBytesStore<Void>>

Overrides:

writeOrderedLong in class NativeBytesStore<Void>

Parameters:

offset - to write to

i - value to write

Returns:

this

Throws:

IllegalStateException

writeFloat

@NotNull
public @NotNull MappedBytesStore writeFloat(long offset,
                                                     float f)
                                              throws IllegalStateException

Description copied from interface: RandomDataOutput

Write a float at an offset.

Specified by:

writeFloat in interface RandomDataOutput<NativeBytesStore<Void>>

Overrides:

writeFloat in class NativeBytesStore<Void>

Parameters:

offset - to write to

f - the value

Returns:

this

Throws:

IllegalStateException

writeDouble

@NotNull
public @NotNull MappedBytesStore writeDouble(long offset,
                                                      double d)
                                               throws IllegalStateException

Description copied from interface: RandomDataOutput

Write a double at an offset.

Specified by:

writeDouble in interface RandomDataOutput<NativeBytesStore<Void>>

Overrides:

writeDouble in class NativeBytesStore<Void>

Parameters:

offset - to write to

d - the value

Returns:

this

Throws:

IllegalStateException

writeVolatileByte

@NotNull
public @NotNull MappedBytesStore writeVolatileByte(long offset,
                                                            byte i8)
                                                     throws IllegalStateException

Specified by:

writeVolatileByte in interface RandomDataOutput<NativeBytesStore<Void>>

Overrides:

writeVolatileByte in class NativeBytesStore<Void>

Throws:

IllegalStateException

writeVolatileShort

@NotNull
public @NotNull MappedBytesStore writeVolatileShort(long offset,
                                                             short i16)
                                                      throws IllegalStateException

Specified by:

writeVolatileShort in interface RandomDataOutput<NativeBytesStore<Void>>

Overrides:

writeVolatileShort in class NativeBytesStore<Void>

Throws:

IllegalStateException

writeVolatileInt

@NotNull
public @NotNull MappedBytesStore writeVolatileInt(long offset,
                                                           int i32)
                                                    throws IllegalStateException

Specified by:

writeVolatileInt in interface RandomDataOutput<NativeBytesStore<Void>>

Overrides:

writeVolatileInt in class NativeBytesStore<Void>

Throws:

IllegalStateException

writeVolatileLong

@NotNull
public @NotNull MappedBytesStore writeVolatileLong(long offset,
                                                            long i64)
                                                     throws IllegalStateException

Specified by:

writeVolatileLong in interface RandomDataOutput<NativeBytesStore<Void>>

Overrides:

writeVolatileLong in class NativeBytesStore<Void>

Throws:

IllegalStateException

write

@NotNull
public @NotNull MappedBytesStore write(long offsetInRDO,
                                                byte[] byteArray,
                                                int offset,
                                                int length)
                                         throws IllegalStateException

Description copied from interface: RandomDataOutput

Copies the provided byteArray to this Bytes object starting at writeOffset taking content starting at readOffset but copying at most length bytes.

Does not update cursors e.g. writePosition()

Specified by:

write in interface RandomDataOutput<NativeBytesStore<Void>>

Overrides:

write in class NativeBytesStore<Void>

Parameters:

offsetInRDO - non-negative offset to write to

byteArray - non-null copy from byteArray

offset - non-negative copy from offset

length - non-negative length to copy

Returns:

this

Throws:

IllegalStateException - if this Bytes object has been previously released

write

public void write(long offsetInRDO,
                  @NotNull
                  @NotNull ByteBuffer bytes,
                  int offset,
                  int length)
           throws IllegalStateException

Description copied from interface: RandomDataOutput

Copy from ByteBuffer into this.

Does not update cursors e.g. writePosition()

Specified by:

write in interface RandomDataOutput<NativeBytesStore<Void>>

Overrides:

write in class NativeBytesStore<Void>

Parameters:

offsetInRDO - offset to write to

bytes - copy from bytes

offset - copy from offset

Throws:

IllegalStateException

write

@NotNull
public @NotNull MappedBytesStore write(long writeOffset,
                                                @NotNull
                                                @NotNull RandomDataInput bytes,
                                                long readOffset,
                                                long length)
                                         throws BufferOverflowException,
                                                BufferUnderflowException,
                                                IllegalStateException

Description copied from interface: RandomDataOutput

Copy from RandomDataInput into this. Does not bump writePosition() nor RandomCommon.readPosition()

Specified by:

write in interface RandomDataOutput<NativeBytesStore<Void>>

Overrides:

write in class NativeBytesStore<Void>

Parameters:

writeOffset - offset to write to

bytes - copy from bytes

readOffset - copy from offset

Returns:

this

Throws:

BufferOverflowException

IllegalStateException

BufferUnderflowException

write0

public void write0(long offsetInRDO,
                   @NotNull
                   @NotNull RandomDataInput bytes,
                   long offset,
                   long length)
            throws IllegalStateException

Overrides:

write0 in class NativeBytesStore<Void>

Throws:

IllegalStateException

nativeWrite

public void nativeWrite(long address,
                        long position,
                        long size)
                 throws IllegalStateException

Description copied from interface: RandomDataOutput

expert level method to copy data from native memory into the BytesStore

Specified by:

nativeWrite in interface RandomDataOutput<NativeBytesStore<Void>>

Overrides:

nativeWrite in class NativeBytesStore<Void>

Parameters:

address - in native memory to copy from

position - in BytesStore to copy to

size - in bytes

Throws:

IllegalStateException

appendUtf8

public long appendUtf8(long pos,
                       char[] chars,
                       int offset,
                       int length)
                throws IllegalStateException

Overrides:

appendUtf8 in class NativeBytesStore<Void>

Throws:

IllegalStateException

performRelease

protected void performRelease()

Sync the ByteStore if required.

Overrides:

performRelease in class NativeBytesStore<Void>

syncMode

public SyncMode syncMode()

Returns:

the sync mode for this ByteStore

syncMode

public void syncMode(SyncMode syncMode)

Set the sync mode for this ByteStore

Parameters:

syncMode -

syncUpTo

public void syncUpTo(long position)

Synchronise from the last complete page up to this position.

Parameters:

position - to sync with the syncMode()

writePosition

public long writePosition()

Returns the write position. The write position is readPosition() <= writePosition() && writePosition() <= writeLimit()

If the resource is closed, the returned value is unspecified.

Returns:

position to write to.

lengthWritten

public long lengthWritten(long startPosition)

Typically this calculates the difference however for HexDumpBytes it's not as simple.

If the resource is closed, the returned value is unspecified.

Parameters:

startPosition - to compare against

Returns:

the length from the startPosition

realReadRemaining

public long realReadRemaining()

If the resource is closed, the returned value is unspecified.

Returns:

how much can be safely read directly.

realWriteRemaining

public long realWriteRemaining()

If the resource is closed, the returned value is unspecified.

Returns:

writeRemaining with resize

readLimit

public long readLimit()

If the resource is closed, the returned value is unspecified.

Returns:

the highest offset or position allowed for this buffer.

writeLimit

public long writeLimit()

Returns the write limit.

If the resource is closed, the returned value is unspecified.

Returns:

the write limit

addressForRead

public long addressForRead(long offset,
                           int buffer)
                    throws UnsupportedOperationException,
                           BufferUnderflowException,
                           IllegalStateException

Throws:

UnsupportedOperationException

BufferUnderflowException

IllegalStateException

byteOrder

public ByteOrder byteOrder()