com.terracottatech.offheapstore.storage.restartable

Class RestartableStorageEngine<T extends StorageEngine<K,LinkedNode<V>> & BinaryStorageEngine,I,K,V>

java.lang.Object

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

com.terracottatech.offheapstore.storage.restartable.RestartableStorageEngine<T,I,K,V>

All Implemented Interfaces:

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

Direct Known Subclasses:

PersistentRestartableStorageEngine

public class RestartableStorageEngine<T extends StorageEngine<K,LinkedNode<V>> & BinaryStorageEngine,I,K,V>
extends AbstractListenableStorageEngine<K,V>
implements StorageEngine<K,V>, BinaryStorageEngine, com.terracottatech.frs.object.ObjectManagerSegment<I,ByteBuffer,ByteBuffer>, StorageEngine.Owner

Nested Class Summary

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

StorageEngine.Owner

Field Summary

Fields

Modifier and Type	Field and Description
protected T	delegateStorageEngine
protected I	identifier
static long	NULL_ENCODING
protected StorageEngine.Owner	owner
protected boolean	synchronous
protected com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer>	transactionSource

Constructor Summary

Constructors

Constructor and Description
RestartableStorageEngine(I identifier, com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource, T storageEngine, boolean synchronous)

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 <T extends StorageEngine<K,LinkedNode<V>> & BinaryStorageEngine,I,K,V> Factory<RestartableStorageEngine<T,I,K,V>>	createFactory(I identifier, com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource, Factory<T> delegateFactory, boolean synchronous)
static ByteBuffer	decodeKey(ByteBuffer frsBinaryKey)
static ByteBuffer	decodeValue(ByteBuffer frsBinaryValue)
protected int	deriveMetadata(long encoding)
void	destroy()
static ByteBuffer	encodeKey(ByteBuffer offheapBinaryKey, int pojoHash)
static ByteBuffer	encodeValue(ByteBuffer offheapBinaryValue, long encoding, int metadata)
Iterable<Long>	encodingSet()
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.
boolean	evict(int slot, boolean b)
static long	extractEncoding(ByteBuffer frsBinaryValue)
static int	extractHashcode(ByteBuffer frsBinaryKey)
static int	extractMetadata(ByteBuffer frsBinaryValue)
protected long	firstEncoding()
void	freeMapping(long encoding, int hash, boolean removal) Called to indicate that the associated encoded value is no longer needed.
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	getEncodingForHashAndBinary(int hash, ByteBuffer offHeapBinaryKey)
Long	getLowestLsn()
Long	getLsn(int pojoHash, ByteBuffer frsBinaryKey)
long	getOccupiedMemory() Returns a measure of the amount of memory consumed by this storage engine.
long	getSize()
Integer	getSlotForHashAndEncoding(int hash, long address, long mask)
long	getVitalMemory() Returns a measure of the amount of vital memory allocated for this storage engine.
long	installMappingForHashAndEncoding(int pojoHash, ByteBuffer offheapBinaryKey, ByteBuffer offheapBinaryValue, int metadata)
void	invalidateCache() Invalidate any local key/value caches.
boolean	isThiefForTableAllocations()
protected long	lastEncoding()
protected void	linkNodeExpectingFirst(LinkedNode<?> node, long encoding, long lsn)
protected void	linkNodeExpectingLast(LinkedNode<?> node, long encoding, long lsn)
void	put(int pojoHash, ByteBuffer frsBinaryKey, ByteBuffer frsBinaryValue, long lsn)
ByteBuffer	readBinaryKey(long encoding)
ByteBuffer	readBinaryValue(long encoding)
K	readKey(long encoding, int hashCode) Converts the supplied encoded key into its correct object form.
int	readKeyHash(long encoding)
Lock	readLock()
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)
protected void	restartabilityPut(long encoding, int pojoHash, int metadata)
boolean	shrink()
long	size()
long	sizeInBytes()
protected void	unlinkNode(LinkedNode<?> node, long encoding)
boolean	updateEncoding(int hashCode, long lastAddress, long compressed, long mask)
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)
Lock	writeLock()
Long	writeMapping(K key, V value, int hash, int metadata) Converts the supplied key and value objects into their encoded form.

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

NULL_ENCODING

public static final long NULL_ENCODING

See Also:

Constant Field Values

delegateStorageEngine

protected final T extends StorageEngine<K,LinkedNode<V>> & BinaryStorageEngine delegateStorageEngine

identifier

protected final I identifier

transactionSource

protected final com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource

synchronous

protected final boolean synchronous

owner

protected volatile StorageEngine.Owner owner

Constructor Detail

RestartableStorageEngine

public RestartableStorageEngine(I identifier,
                                com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource,
                                T storageEngine,
                                boolean synchronous)

Method Detail

createFactory

public static <T extends StorageEngine<K,LinkedNode<V>> & BinaryStorageEngine,I,K,V> Factory<RestartableStorageEngine<T,I,K,V>> createFactory(I identifier,
                                                                                                                                              com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource,
                                                                                                                                              Factory<T> delegateFactory,
                                                                                                                                              boolean synchronous)

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

attachedMapping

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

Specified by:

attachedMapping in interface StorageEngine<K,V>

restartabilityPut

protected void restartabilityPut(long encoding,
                                 int pojoHash,
                                 int metadata)

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

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(LinkedNode<?> node,
                                long encoding)

linkNodeExpectingLast

protected final void linkNodeExpectingLast(LinkedNode<?> node,
                                           long encoding,
                                           long lsn)

linkNodeExpectingFirst

protected final void linkNodeExpectingFirst(LinkedNode<?> node,
                                            long encoding,
                                            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

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)

encodeKey

public static ByteBuffer encodeKey(ByteBuffer offheapBinaryKey,
                                   int pojoHash)

decodeKey

public static ByteBuffer decodeKey(ByteBuffer frsBinaryKey)

extractHashcode

public static int extractHashcode(ByteBuffer frsBinaryKey)

encodeValue

public static ByteBuffer encodeValue(ByteBuffer offheapBinaryValue,
                                     long encoding,
                                     int metadata)

decodeValue

public static ByteBuffer decodeValue(ByteBuffer frsBinaryValue)

extractMetadata

public static int extractMetadata(ByteBuffer frsBinaryValue)

extractEncoding

public static long extractEncoding(ByteBuffer frsBinaryValue)

sizeInBytes

public long sizeInBytes()

Specified by:

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

getEncodingForHashAndBinary

public Long getEncodingForHashAndBinary(int hash,
                                        ByteBuffer offHeapBinaryKey)

Specified by:

getEncodingForHashAndBinary in interface StorageEngine.Owner

getSize

public long getSize()

Specified by:

getSize in interface StorageEngine.Owner

installMappingForHashAndEncoding

public long installMappingForHashAndEncoding(int pojoHash,
                                             ByteBuffer offheapBinaryKey,
                                             ByteBuffer offheapBinaryValue,
                                             int metadata)

Specified by:

installMappingForHashAndEncoding in interface StorageEngine.Owner

encodingSet

public Iterable<Long> encodingSet()

Specified by:

encodingSet in interface StorageEngine.Owner

updateEncoding

public boolean updateEncoding(int hashCode,
                              long lastAddress,
                              long compressed,
                              long mask)

Specified by:

updateEncoding in interface StorageEngine.Owner

getSlotForHashAndEncoding

public Integer getSlotForHashAndEncoding(int hash,
                                         long address,
                                         long mask)

Specified by:

getSlotForHashAndEncoding in interface StorageEngine.Owner

evict

public boolean evict(int slot,
                     boolean b)

Specified by:

evict in interface StorageEngine.Owner

isThiefForTableAllocations

public boolean isThiefForTableAllocations()

Specified by:

isThiefForTableAllocations in interface StorageEngine.Owner

readLock

public Lock readLock()

Specified by:

readLock in interface ReadWriteLock

writeLock

public Lock writeLock()

Specified by:

writeLock in interface ReadWriteLock