Class FileBackedStorageEngine<K,V>

java.lang.Object

org.terracotta.offheapstore.storage.listener.AbstractListenableStorageEngine<K,V>

org.terracotta.offheapstore.storage.PortabilityBasedStorageEngine<K,V>

org.terracotta.offheapstore.disk.storage.FileBackedStorageEngine<K,V>

All Implemented Interfaces:

Persistent, PersistentStorageEngine<K,V>, BinaryStorageEngine, ListenableStorageEngine<K,V>, StorageEngine<K,V>

public class FileBackedStorageEngine<K,V>
extends PortabilityBasedStorageEngine<K,V>
implements PersistentStorageEngine<K,V>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	FileBackedStorageEngine.FileChunk
(package private) class	FileBackedStorageEngine.FileWriteTask

Nested classes/interfaces inherited from interface StorageEngine

StorageEngine.Owner

Field Summary

Fields

Modifier and Type	Field	Description
private final TreeMap<Long, FileBackedStorageEngine<K,V>.FileChunk>	chunks
private static final int	KEY_DATA_OFFSET
private static final int	KEY_HASH_OFFSET
private static final int	KEY_LENGTH_OFFSET
private static final org.slf4j.Logger	LOGGER
private static final int	MAGIC
private static final int	MAGIC_CHUNK
private final long	maxChunkSize
private StorageEngine.Owner	owner
private final ConcurrentHashMap<Long, FileBackedStorageEngine<K,V>.FileWriteTask>	pendingWrites
private final ReopeningInterruptibleChannel<FileChannel>	readChannel
private final MappedPageSource	source
private static final int	VALUE_LENGTH_OFFSET
private final ReopeningInterruptibleChannel<FileChannel>	writeChannel
private final ExecutorService	writeExecutor

Fields inherited from class PortabilityBasedStorageEngine

keyPortability, valuePortability

Constructor Summary

Constructors

Constructor	Description
FileBackedStorageEngine(MappedPageSource source, long maxChunkSize, MemoryUnit maxChunkUnit, Portability<? super K> keyPortability, Portability<? super V> valuePortability)
FileBackedStorageEngine(MappedPageSource source, long maxChunkSize, MemoryUnit maxChunkUnit, Portability<? super K> keyPortability, Portability<? super V> valuePortability, boolean bootstrap)
FileBackedStorageEngine(MappedPageSource source, long maxChunkSize, MemoryUnit maxChunkUnit, Portability<? super K> keyPortability, Portability<? super V> valuePortability, ExecutorService writer)
FileBackedStorageEngine(MappedPageSource source, long maxChunkSize, MemoryUnit maxChunkUnit, Portability<? super K> keyPortability, Portability<? super V> valuePortability, ExecutorService writer, boolean bootstrap)

Method Summary

Modifier and Type	Method	Description
void	bind(StorageEngine.Owner m)
void	bootstrap(ObjectInput input)
protected void	clearInternal()
void	close()
private void	compress(FileBackedStorageEngine<K,V>.FileChunk from)
static <K,V> Factory<FileBackedStorageEngine<K,V>>	createFactory(MappedPageSource source, long maxChunkSize, MemoryUnit maxChunkUnit, Portability<? super K> keyPortability, Portability<? super V> valuePortability)
static <K,V> Factory<FileBackedStorageEngine<K,V>>	createFactory(MappedPageSource source, long maxChunkSize, MemoryUnit maxChunkUnit, Portability<? super K> keyPortability, Portability<? super V> valuePortability, boolean bootstrap)
static <K,V> Factory<FileBackedStorageEngine<K,V>>	createFactory(MappedPageSource source, long maxChunkSize, MemoryUnit maxChunkUnit, Portability<? super K> keyPortability, Portability<? super V> valuePortability, Factory<? extends ExecutorService> executorFactory, boolean bootstrap)
void	destroy()
private FileBackedStorageEngine<K,V>.FileChunk	findChunk(long address)
void	flush()
protected void	free(long address)
long	getAllocatedMemory()	Returns a measure of the amount of memory allocated for this storage engine.
long	getDataSize()	Returns a measure of the total size of the keys and values stored in this storage engine.
protected WriteContext	getKeyWriteContext(long address)
long	getOccupiedMemory()	Returns a measure of the amount of memory consumed by this storage engine.
protected WriteContext	getValueWriteContext(long address)
long	getVitalMemory()	Returns a measure of the amount of vital memory allocated for this storage engine.
void	persist(ObjectOutput output)
private int	readFromChannel(ByteBuffer buffer, long position)
private int	readFromChannel(FileChannel channel, ByteBuffer buffer, long position)
private int	readIntFromChannel(long position)
protected ByteBuffer	readKeyBuffer(long address)
int	readKeyHash(long address)
protected ByteBuffer	readValueBuffer(long address)
boolean	shrink()
private void	writeIntToChannel(long position, int data)
private void	writeLongToChannel(long position, long data)
protected Long	writeMappingBuffers(ByteBuffer keyBuffer, ByteBuffer valueBuffer, int hash)
private void	writeToChannel(long position, ByteBuffer buffer)

Methods inherited from class PortabilityBasedStorageEngine

attachedMapping, clear, equalsBinaryKey, equalsKey, equalsValue, freeMapping, invalidateCache, readBinaryKey, readBinaryValue, readKey, readValue, writeBinaryMapping, writeBinaryMapping, writeMapping, writeMappingBuffersGathering

Methods inherited from class AbstractListenableStorageEngine

fireCleared, fireCopied, fireFreed, fireRecovered, fireWritten, hasListeners, hasRecoveryListeners, registerListener

Methods inherited from class Object

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

Methods inherited from interface StorageEngine

attachedMapping, clear, equalsKey, equalsValue, freeMapping, invalidateCache, readKey, readValue, writeMapping

Field Details

MAGIC

private static final int MAGIC

See Also:

• Constant Field Values

MAGIC_CHUNK

private static final int MAGIC_CHUNK

See Also:

• Constant Field Values

LOGGER

private static final org.slf4j.Logger LOGGER

KEY_HASH_OFFSET

private static final int KEY_HASH_OFFSET

See Also:

• Constant Field Values

KEY_LENGTH_OFFSET

private static final int KEY_LENGTH_OFFSET

See Also:

• Constant Field Values

VALUE_LENGTH_OFFSET

private static final int VALUE_LENGTH_OFFSET

See Also:

• Constant Field Values

KEY_DATA_OFFSET

private static final int KEY_DATA_OFFSET

See Also:

• Constant Field Values

pendingWrites

private final ConcurrentHashMap<Long, FileBackedStorageEngine<K,V>.FileWriteTask> pendingWrites

writeExecutor

private final ExecutorService writeExecutor

source

private final MappedPageSource source

writeChannel

private final ReopeningInterruptibleChannel<FileChannel> writeChannel

readChannel

private final ReopeningInterruptibleChannel<FileChannel> readChannel

chunks

private final TreeMap<Long, FileBackedStorageEngine<K,V>.FileChunk> chunks

maxChunkSize

private final long maxChunkSize

owner

private volatile StorageEngine.Owner owner

Constructor Details

FileBackedStorageEngine

public FileBackedStorageEngine(MappedPageSource source,
 long maxChunkSize,
 MemoryUnit maxChunkUnit,
 Portability<? super K> keyPortability,
 Portability<? super V> valuePortability)

FileBackedStorageEngine

public FileBackedStorageEngine(MappedPageSource source,
 long maxChunkSize,
 MemoryUnit maxChunkUnit,
 Portability<? super K> keyPortability,
 Portability<? super V> valuePortability,
 ExecutorService writer)

FileBackedStorageEngine

public FileBackedStorageEngine(MappedPageSource source,
 long maxChunkSize,
 MemoryUnit maxChunkUnit,
 Portability<? super K> keyPortability,
 Portability<? super V> valuePortability,
 boolean bootstrap)

FileBackedStorageEngine

public FileBackedStorageEngine(MappedPageSource source,
 long maxChunkSize,
 MemoryUnit maxChunkUnit,
 Portability<? super K> keyPortability,
 Portability<? super V> valuePortability,
 ExecutorService writer,
 boolean bootstrap)

Method Details

createFactory

public static <K,V>
Factory<FileBackedStorageEngine<K,V>> createFactory(MappedPageSource source,
 long maxChunkSize,
 MemoryUnit maxChunkUnit,
 Portability<? super K> keyPortability,
 Portability<? super V> valuePortability)

createFactory

public static <K,V>
Factory<FileBackedStorageEngine<K,V>> createFactory(MappedPageSource source,
 long maxChunkSize,
 MemoryUnit maxChunkUnit,
 Portability<? super K> keyPortability,
 Portability<? super V> valuePortability,
 boolean bootstrap)

createFactory

public static <K,V>
Factory<FileBackedStorageEngine<K,V>> createFactory(MappedPageSource source,
 long maxChunkSize,
 MemoryUnit maxChunkUnit,
 Portability<? super K> keyPortability,
 Portability<? super V> valuePortability,
 Factory<? extends ExecutorService> executorFactory,
 boolean bootstrap)

clearInternal

protected void clearInternal()

Specified by:

clearInternal in class PortabilityBasedStorageEngine<K,V>

destroy

public void destroy()

Specified by:

destroy in interface StorageEngine<K,V>

flush

public void flush()
           throws IOException

Specified by:

flush in interface Persistent

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Persistent

Throws:

IOException

persist

public void persist(ObjectOutput output)
             throws IOException

Specified by:

persist in interface Persistent

Throws:

IOException

bootstrap

public void bootstrap(ObjectInput input)
               throws IOException

Specified by:

bootstrap in interface Persistent

Throws:

IOException

free

protected void free(long address)

Specified by:

free in class PortabilityBasedStorageEngine<K,V>

readKeyBuffer

protected ByteBuffer readKeyBuffer(long address)

Specified by:

readKeyBuffer in class PortabilityBasedStorageEngine<K,V>

getKeyWriteContext

protected WriteContext getKeyWriteContext(long address)

Specified by:

getKeyWriteContext in class PortabilityBasedStorageEngine<K,V>

readValueBuffer

protected ByteBuffer readValueBuffer(long address)

Specified by:

readValueBuffer in class PortabilityBasedStorageEngine<K,V>

getValueWriteContext

protected WriteContext getValueWriteContext(long address)

Specified by:

getValueWriteContext in class PortabilityBasedStorageEngine<K,V>

writeMappingBuffers

protected Long writeMappingBuffers(ByteBuffer keyBuffer,
 ByteBuffer valueBuffer,
 int hash)

Specified by:

writeMappingBuffers in class PortabilityBasedStorageEngine<K,V>

getAllocatedMemory

public long getAllocatedMemory()

Description copied from interface: StorageEngine

Returns a measure of the amount of memory allocated for this storage engine.

Specified by:

getAllocatedMemory in interface StorageEngine<K,V>

Returns:

memory allocated for this engine in bytes

getOccupiedMemory

public long getOccupiedMemory()

Description copied from interface: StorageEngine

Returns a measure of the amount of memory consumed by this storage engine.

Specified by:

getOccupiedMemory in interface StorageEngine<K,V>

Returns:

memory occupied by this engine in bytes

getVitalMemory

public long getVitalMemory()

Description copied from interface: StorageEngine

Returns a measure of the amount of vital memory allocated for this storage engine.

Specified by:

getVitalMemory in interface StorageEngine<K,V>

Returns:

vital memory allocated for this engine in bytes

getDataSize

public long getDataSize()

Description copied from interface: StorageEngine

Returns a measure of the total size of the keys and values stored in this storage engine.

Specified by:

getDataSize in interface StorageEngine<K,V>

Returns:

size of the stored keys and values in bytes

findChunk

private FileBackedStorageEngine<K,V>.FileChunk findChunk(long address)

readIntFromChannel

private int readIntFromChannel(long position)
                        throws IOException

Throws:

IOException

writeIntToChannel

private void writeIntToChannel(long position,
 int data)
                        throws IOException

Throws:

IOException

writeLongToChannel

private void writeLongToChannel(long position,
 long data)
                         throws IOException

Throws:

IOException

writeToChannel

private void writeToChannel(long position,
 ByteBuffer buffer)
                     throws IOException

Throws:

IOException

readFromChannel

private int readFromChannel(ByteBuffer buffer,
 long position)
                     throws IOException

Throws:

IOException

readFromChannel

private int readFromChannel(FileChannel channel,
 ByteBuffer buffer,
 long position)
                     throws IOException

Throws:

IOException

shrink

public boolean shrink()

Specified by:

shrink in interface StorageEngine<K,V>

compress

private void compress(FileBackedStorageEngine<K,V>.FileChunk from)

bind

public void bind(StorageEngine.Owner m)

Specified by:

bind in interface StorageEngine<K,V>

readKeyHash

public int readKeyHash(long address)

Specified by:

readKeyHash in interface BinaryStorageEngine