com.terracottatech.offheapstore.storage.restartable.partial

Class RestartableMinimalStorageEngine<I,K,V>

java.lang.Object

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

com.terracottatech.offheapstore.storage.restartable.partial.RestartableMinimalStorageEngine<I,K,V>

All Implemented Interfaces:

com.terracottatech.frs.object.ObjectManagerSegment<I,ByteBuffer,ByteBuffer>, BinaryStorageEngine, ListenableStorageEngine<K,V>, StorageEngine<K,V>

Direct Known Subclasses:

RestartableKeysOnlyStorageEngine, RestartablePartialStorageEngine

public class RestartableMinimalStorageEngine<I,K,V>
extends AbstractListenableStorageEngine<K,V>
implements StorageEngine<K,V>, BinaryStorageEngine, com.terracottatech.frs.object.ObjectManagerSegment<I,ByteBuffer,ByteBuffer>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	RestartableMinimalStorageEngine.Entry

Nested classes/interfaces inherited from interface org.terracotta.offheapstore.storage.StorageEngine

StorageEngine.Owner

Field Summary

Fields

Modifier and Type	Field and Description
protected Portability<? super K>	keyPortability
protected OffHeapStorageArea	metadataArea
protected StorageEngine.Owner	owner
protected Portability<? super V>	valuePortability

Constructor Summary

Constructors

Constructor and Description
RestartableMinimalStorageEngine(I identifier, com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource, boolean synchronous, PointerSize width, PageSource source, int initialPageSize, int maximalPageSize, Portability<? super K> keyPortability, Portability<? super V> valuePortability, boolean thief, boolean victim, float compressThreshold)
RestartableMinimalStorageEngine(I identifier, com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource, boolean synchronous, PointerSize width, PageSource source, int initialPageSize, int maximalPageSize, Portability<? super K> keyPortability, Portability<? super V> valuePortability, float compressThreshold)
RestartableMinimalStorageEngine(I identifier, com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource, boolean synchronous, PointerSize width, PageSource source, int pageSize, Portability<? super K> keyPortability, Portability<? super V> valuePortability, boolean thief, boolean victim, float compressThreshold)
RestartableMinimalStorageEngine(I identifier, com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource, boolean synchronous, PointerSize width, PageSource source, int pageSize, Portability<? super K> keyPortability, Portability<? super V> valuePortability, float compressThreshold)

Method Summary

Modifier and Type	Method and Description
com.terracottatech.frs.object.ObjectManagerEntry<I,ByteBuffer,ByteBuffer>	acquireCompactionEntry(long ceilingLsn)
protected void	assignLsn(long encoding, long lsn)
void	attachedMapping(long encoding, int hash, int metadata)
void	bind(StorageEngine.Owner owner)
void	clear() Called to indicate that all keys and values are now free.
static <I,K,V> Factory<RestartableMinimalStorageEngine<I,K,V>>	createMinimalFactory(I identifier, com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource, boolean synchronous, PointerSize width, PageSource source, int initialPageSize, int maximalPageSize, Portability<? super K> keyPortability, Portability<? super V> valuePortability, boolean thief, boolean victim, float compressThreshold)
static <I,K,V> Factory<RestartableMinimalStorageEngine<I,K,V>>	createMinimalFactory(I identifier, com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource, boolean synchronous, PointerSize width, PageSource source, int pageSize, Portability<? super K> keyPortability, Portability<? super V> valuePortability, boolean thief, boolean victim, float compressThreshold)
protected int	deriveMetadata(long encoding)
void	destroy()
protected static ByteBuffer	detach(ByteBuffer attached)
protected boolean	equalsBinaryKey(ByteBuffer probe, ByteBuffer stored)
boolean	equalsBinaryKey(ByteBuffer offheapBinaryKey, long encoding)
boolean	equalsKey(Object key, long encoding) Called to determine the equality of the given object against the given encoded form.
boolean	equalsValue(Object value, long encoding) Called to determine the equality of the given Java object value against the given encoded form.
protected long	firstEncoding()
void	freeMapping(long encoding, int hash, boolean removal) Called to indicate that the associated encoded value is no longer needed.
protected int	getActualEntrySize(long encoding)
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.
Long	getLowestLsn()
Long	getLsn(int pojoHash, ByteBuffer frsBinaryKey)
long	getOccupiedMemory() Returns a measure of the amount of memory consumed by this storage engine.
protected int	getRequiredEntrySize(ByteBuffer binaryKey, ByteBuffer binaryValue)
long	getVitalMemory() Returns a measure of the amount of vital memory allocated for this storage engine.
void	invalidateCache() Invalidate any local key/value caches.
protected long	lastEncoding()
protected void	linkNodeExpectingFirst(long node, long lsn)
protected void	linkNodeExpectingLast(long node, long lsn)
void	put(int pojoHash, ByteBuffer frsBinaryKey, ByteBuffer frsBinaryValue, long lsn)
ByteBuffer	readBinaryKey(long encoding)
ByteBuffer	readBinaryValue(long encoding)
protected RestartableMinimalStorageEngine.Entry	readEntry(long encoding)
K	readKey(long encoding, int hashCode) Converts the supplied encoded key into its correct object form.
int	readKeyHash(long encoding)
V	readValue(long encoding) Converts the supplied encoded value into its correct object form.
void	releaseCompactionEntry(com.terracottatech.frs.object.ObjectManagerEntry<I,ByteBuffer,ByteBuffer> entry)
void	remove(int pojoHash, ByteBuffer frsBinaryKey)
void	replayPut(int pojoHash, ByteBuffer frsBinaryKey, ByteBuffer frsBinaryValue, long lsn)
boolean	shrink()
long	size()
long	sizeInBytes()
protected void	unlinkNode(long encoding)
void	updateLsn(int pojoHash, com.terracottatech.frs.object.ObjectManagerEntry<I,ByteBuffer,ByteBuffer> entry, long newLsn)
protected void	validChain()
Long	writeBinaryMapping(ByteBuffer[] binaryKey, ByteBuffer[] binaryValue, int pojoHash, int metadata)
Long	writeBinaryMapping(ByteBuffer binaryKey, ByteBuffer binaryValue, int pojoHash, int metadata)
Long	writeMapping(K key, V value, int hash, int metadata) Converts the supplied key and value objects into their encoded form.
protected Long	writePartialEntry(int hash, ByteBuffer binaryKey, ByteBuffer binaryValue)

Methods inherited from class org.terracotta.offheapstore.storage.listener.AbstractListenableStorageEngine

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

Methods inherited from class java.lang.Object

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

Field Detail

metadataArea

protected final OffHeapStorageArea metadataArea

keyPortability

protected final Portability<? super K> keyPortability

valuePortability

protected final Portability<? super V> valuePortability

owner

protected volatile StorageEngine.Owner owner

Constructor Detail

RestartableMinimalStorageEngine

public RestartableMinimalStorageEngine(I identifier,
                                       com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource,
                                       boolean synchronous,
                                       PointerSize width,
                                       PageSource source,
                                       int pageSize,
                                       Portability<? super K> keyPortability,
                                       Portability<? super V> valuePortability,
                                       float compressThreshold)

RestartableMinimalStorageEngine

public RestartableMinimalStorageEngine(I identifier,
                                       com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource,
                                       boolean synchronous,
                                       PointerSize width,
                                       PageSource source,
                                       int initialPageSize,
                                       int maximalPageSize,
                                       Portability<? super K> keyPortability,
                                       Portability<? super V> valuePortability,
                                       float compressThreshold)

RestartableMinimalStorageEngine

public RestartableMinimalStorageEngine(I identifier,
                                       com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource,
                                       boolean synchronous,
                                       PointerSize width,
                                       PageSource source,
                                       int pageSize,
                                       Portability<? super K> keyPortability,
                                       Portability<? super V> valuePortability,
                                       boolean thief,
                                       boolean victim,
                                       float compressThreshold)

RestartableMinimalStorageEngine

public RestartableMinimalStorageEngine(I identifier,
                                       com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource,
                                       boolean synchronous,
                                       PointerSize width,
                                       PageSource source,
                                       int initialPageSize,
                                       int maximalPageSize,
                                       Portability<? super K> keyPortability,
                                       Portability<? super V> valuePortability,
                                       boolean thief,
                                       boolean victim,
                                       float compressThreshold)

Method Detail

createMinimalFactory

public static <I,K,V> Factory<RestartableMinimalStorageEngine<I,K,V>> createMinimalFactory(I identifier,
                                                                                           com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource,
                                                                                           boolean synchronous,
                                                                                           PointerSize width,
                                                                                           PageSource source,
                                                                                           int pageSize,
                                                                                           Portability<? super K> keyPortability,
                                                                                           Portability<? super V> valuePortability,
                                                                                           boolean thief,
                                                                                           boolean victim,
                                                                                           float compressThreshold)

createMinimalFactory

public static <I,K,V> Factory<RestartableMinimalStorageEngine<I,K,V>> createMinimalFactory(I identifier,
                                                                                           com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource,
                                                                                           boolean synchronous,
                                                                                           PointerSize width,
                                                                                           PageSource source,
                                                                                           int initialPageSize,
                                                                                           int maximalPageSize,
                                                                                           Portability<? super K> keyPortability,
                                                                                           Portability<? super V> valuePortability,
                                                                                           boolean thief,
                                                                                           boolean victim,
                                                                                           float compressThreshold)

writeMapping

public Long writeMapping(K key,
                         V value,
                         int hash,
                         int metadata)

Description copied from interface: StorageEngine

Converts the supplied key and value objects into their encoded form.

Specified by:

writeMapping in interface StorageEngine<K,V>

Parameters:

key - a key object

value - a value object

hash - the key hash

metadata - the metadata bits

Returns:

the encoded mapping

writePartialEntry

protected Long writePartialEntry(int hash,
                                 ByteBuffer binaryKey,
                                 ByteBuffer binaryValue)

getRequiredEntrySize

protected int getRequiredEntrySize(ByteBuffer binaryKey,
                                   ByteBuffer binaryValue)

getActualEntrySize

protected int getActualEntrySize(long encoding)

attachedMapping

public void attachedMapping(long encoding,
                            int hash,
                            int metadata)

Specified by:

attachedMapping in interface StorageEngine<K,V>

freeMapping

public void freeMapping(long encoding,
                        int hash,
                        boolean removal)

Description copied from interface: StorageEngine

Called to indicate that the associated encoded value is no longer needed.

This call can be used to free any associated resources tied to the lifecycle of the supplied encoded value.

Specified by:

freeMapping in interface StorageEngine<K,V>

Parameters:

encoding - encoded value

hash - hash of the freed mapping

removal - marks removal from a map

readValue

public V readValue(long encoding)

Description copied from interface: StorageEngine

Converts the supplied encoded value into its correct object form.

Specified by:

readValue in interface StorageEngine<K,V>

Parameters:

encoding - encoded value

Returns:

a decoded value object

equalsValue

public boolean equalsValue(Object value,
                           long encoding)

Description copied from interface: StorageEngine

Called to determine the equality of the given Java object value against the given encoded form.

Simple implementations will probably perform a decode on the given encoded form in order to do a regular Object.equals(Object) comparison. This method is provided to allow implementations to optimize this comparison if possible.

Specified by:

equalsValue in interface StorageEngine<K,V>

Parameters:

value - a value object

encoding - encoded value

Returns:

true if the value and the encoding are equal

readKey

public K readKey(long encoding,
                 int hashCode)

Description copied from interface: StorageEngine

Converts the supplied encoded key into its correct object form.

Specified by:

readKey in interface StorageEngine<K,V>

Parameters:

encoding - encoded key

hashCode - hash-code of the decoded key

Returns:

a decoded key object

equalsKey

public boolean equalsKey(Object key,
                         long encoding)

Description copied from interface: StorageEngine

Called to determine the equality of the given object against the given encoded form.

Simple implementations will probably perform a decode on the given encoded form in order to do a regular Object.equals(Object) comparison. This method is provided to allow implementations to optimize this comparison if possible.

Specified by:

equalsKey in interface StorageEngine<K,V>

Parameters:

key - a key object

encoding - encoded value

Returns:

true if the key and the encoding are equal

equalsBinaryKey

public boolean equalsBinaryKey(ByteBuffer offheapBinaryKey,
                               long encoding)

Specified by:

equalsBinaryKey in interface BinaryStorageEngine

equalsBinaryKey

protected final boolean equalsBinaryKey(ByteBuffer probe,
                                        ByteBuffer stored)

clear

public void clear()

Description copied from interface: StorageEngine

Called to indicate that all keys and values are now free.

Specified by:

clear in interface StorageEngine<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

invalidateCache

public void invalidateCache()

Description copied from interface: StorageEngine

Invalidate any local key/value caches.

This is called to indicate the termination of a map write "phase". Caching is permitted within a write operation (i.e. to cache around allocation failures during eviction processes).

Specified by:

invalidateCache in interface StorageEngine<K,V>

bind

public void bind(StorageEngine.Owner owner)

Specified by:

bind in interface StorageEngine<K,V>

destroy

public void destroy()

Specified by:

destroy in interface StorageEngine<K,V>

shrink

public boolean shrink()

Specified by:

shrink in interface StorageEngine<K,V>

assignLsn

protected final void assignLsn(long encoding,
                               long lsn)

unlinkNode

protected final void unlinkNode(long encoding)

linkNodeExpectingLast

protected final void linkNodeExpectingLast(long node,
                                           long lsn)

linkNodeExpectingFirst

protected final void linkNodeExpectingFirst(long node,
                                            long lsn)

validChain

protected final void validChain()

firstEncoding

protected long firstEncoding()

lastEncoding

protected long lastEncoding()

size

public long size()

Specified by:

size in interface com.terracottatech.frs.object.ObjectManagerSegment<I,ByteBuffer,ByteBuffer>

getLowestLsn

public Long getLowestLsn()

Specified by:

getLowestLsn in interface com.terracottatech.frs.object.ObjectManagerSegment<I,ByteBuffer,ByteBuffer>

getLsn

public Long getLsn(int pojoHash,
                   ByteBuffer frsBinaryKey)

Specified by:

getLsn in interface com.terracottatech.frs.object.ObjectManagerSegment<I,ByteBuffer,ByteBuffer>

put

public void put(int pojoHash,
                ByteBuffer frsBinaryKey,
                ByteBuffer frsBinaryValue,
                long lsn)

Specified by:

put in interface com.terracottatech.frs.object.ObjectManagerSegment<I,ByteBuffer,ByteBuffer>

remove

public void remove(int pojoHash,
                   ByteBuffer frsBinaryKey)

Specified by:

remove in interface com.terracottatech.frs.object.ObjectManagerSegment<I,ByteBuffer,ByteBuffer>

replayPut

public void replayPut(int pojoHash,
                      ByteBuffer frsBinaryKey,
                      ByteBuffer frsBinaryValue,
                      long lsn)

Specified by:

replayPut in interface com.terracottatech.frs.object.ObjectManagerSegment<I,ByteBuffer,ByteBuffer>

writeBinaryMapping

public Long writeBinaryMapping(ByteBuffer binaryKey,
                               ByteBuffer binaryValue,
                               int pojoHash,
                               int metadata)

Specified by:

writeBinaryMapping in interface BinaryStorageEngine

writeBinaryMapping

public Long writeBinaryMapping(ByteBuffer[] binaryKey,
                               ByteBuffer[] binaryValue,
                               int pojoHash,
                               int metadata)

Specified by:

writeBinaryMapping in interface BinaryStorageEngine

readKeyHash

public int readKeyHash(long encoding)

Specified by:

readKeyHash in interface BinaryStorageEngine

readBinaryKey

public ByteBuffer readBinaryKey(long encoding)

Specified by:

readBinaryKey in interface BinaryStorageEngine

readBinaryValue

public ByteBuffer readBinaryValue(long encoding)

Specified by:

readBinaryValue in interface BinaryStorageEngine

detach

protected static ByteBuffer detach(ByteBuffer attached)

readEntry

protected RestartableMinimalStorageEngine.Entry readEntry(long encoding)

acquireCompactionEntry

public com.terracottatech.frs.object.ObjectManagerEntry<I,ByteBuffer,ByteBuffer> acquireCompactionEntry(long ceilingLsn)

Specified by:

acquireCompactionEntry in interface com.terracottatech.frs.object.ObjectManagerSegment<I,ByteBuffer,ByteBuffer>

releaseCompactionEntry

public void releaseCompactionEntry(com.terracottatech.frs.object.ObjectManagerEntry<I,ByteBuffer,ByteBuffer> entry)

Specified by:

releaseCompactionEntry in interface com.terracottatech.frs.object.ObjectManagerSegment<I,ByteBuffer,ByteBuffer>

updateLsn

public void updateLsn(int pojoHash,
                      com.terracottatech.frs.object.ObjectManagerEntry<I,ByteBuffer,ByteBuffer> entry,
                      long newLsn)

Specified by:

updateLsn in interface com.terracottatech.frs.object.ObjectManagerSegment<I,ByteBuffer,ByteBuffer>

deriveMetadata

protected int deriveMetadata(long encoding)

sizeInBytes

public long sizeInBytes()

Specified by:

sizeInBytes in interface com.terracottatech.frs.object.ObjectManagerSegment<I,ByteBuffer,ByteBuffer>