org.apache.hadoop.hive.llap.cache

Class LlapAllocatorBuffer

java.lang.Object

org.apache.hadoop.hive.llap.cache.LlapCacheableBuffer

org.apache.hadoop.hive.llap.cache.LlapAllocatorBuffer

All Implemented Interfaces:

org.apache.hadoop.hive.common.io.encoded.MemoryBuffer

Direct Known Subclasses:

LlapDataBuffer, MetadataCache.LlapMetadataBuffer, SerDeLowLevelCacheImpl.LlapSerDeDataBuffer

public abstract class LlapAllocatorBuffer
extends LlapCacheableBuffer
implements org.apache.hadoop.hive.common.io.encoded.MemoryBuffer

We want to have cacheable and non-allocator buffers, as well as allocator buffers with no cache dependency, and also ones that are both. Alas, we could only achieve this if we were using a real programming language.

Field Summary

Fields

Modifier and Type	Field and Description
int	allocSize Allocator uses this to remember the allocation size.
ByteBuffer	byteBuffer

Fields inherited from class org.apache.hadoop.hive.llap.cache.LlapCacheableBuffer

IN_LIST, indexInHeap, INVALIDATE_ALREADY_INVALID, INVALIDATE_FAILED, INVALIDATE_OK, lastUpdate, next, NOT_IN_CACHE, prev, priority

Constructor Summary

Constructors

Constructor and Description
LlapAllocatorBuffer()

Method Summary

Modifier and Type	Method and Description
Boolean	cancelDiscard()
int	decRef()
Boolean	endDiscard()
ByteBuffer	getByteBufferDup()
ByteBuffer	getByteBufferRaw()
long	getMemoryUsage()
int	incRef()
void	initialize(ByteBuffer byteBuffer, int offset, int length)
void	initializeWithExistingSlice(ByteBuffer byteBuffer, int allocSize)
int	invalidate() Invalidates the cached buffer.
int	invalidateAndRelease() Invalidates the uncached buffer.
boolean	isInvalid()
boolean	isLocked()
int	releaseInvalidated() Marks previously invalidated buffer as released.
void	setNewAllocLocation(int arenaIx, int headerIx)
boolean	startMoveOrDiscard(int arenaIx, int headerIx, boolean isForceDiscard)
String	toDebugString()
String	toString()

Methods inherited from class org.apache.hadoop.hive.llap.cache.LlapCacheableBuffer

getTag, notifyEvicted, toStringForCache

Methods inherited from class java.lang.Object

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

Field Detail

byteBuffer

public ByteBuffer byteBuffer

allocSize

public int allocSize

Allocator uses this to remember the allocation size. Somewhat redundant with header.

Constructor Detail

LlapAllocatorBuffer

public LlapAllocatorBuffer()

Method Detail

initialize

public void initialize(ByteBuffer byteBuffer,
                       int offset,
                       int length)

initializeWithExistingSlice

public void initializeWithExistingSlice(ByteBuffer byteBuffer,
                                        int allocSize)

setNewAllocLocation

public void setNewAllocLocation(int arenaIx,
                                int headerIx)

getByteBufferDup

public ByteBuffer getByteBufferDup()

Specified by:

getByteBufferDup in interface org.apache.hadoop.hive.common.io.encoded.MemoryBuffer

getByteBufferRaw

public ByteBuffer getByteBufferRaw()

Specified by:

getByteBufferRaw in interface org.apache.hadoop.hive.common.io.encoded.MemoryBuffer

getMemoryUsage

public long getMemoryUsage()

Specified by:

getMemoryUsage in class LlapCacheableBuffer

incRef

public int incRef()

isLocked

public boolean isLocked()

Specified by:

isLocked in class LlapCacheableBuffer

isInvalid

public boolean isInvalid()

decRef

public int decRef()

invalidate

public int invalidate()

Invalidates the cached buffer. The memory allocation in memory manager is managed by the caller, and therefore we mark the buffer as having released the memory too.

Specified by:

invalidate in class LlapCacheableBuffer

Returns:

Whether the we can invalidate; false if locked or already evicted.

invalidateAndRelease

public int invalidateAndRelease()

Invalidates the uncached buffer. The memory allocation in memory manager is managed by the allocator; we will only mark it as released if there are no concurrent moves. In that case, the caller of this will release the memory; otherwise, the end of move will release.

Returns:

Arena index, if the buffer memory can be released; -1 otherwise.

releaseInvalidated

public int releaseInvalidated()

Marks previously invalidated buffer as released.

Returns:

Whether the buffer memory can be released.

toString

public String toString()

Overrides:

toString in class LlapCacheableBuffer

toDebugString

public String toDebugString()

startMoveOrDiscard

public boolean startMoveOrDiscard(int arenaIx,
                                  int headerIx,
                                  boolean isForceDiscard)

cancelDiscard

public Boolean cancelDiscard()

Returns:

null if no action is required; otherwise, the buffer should be deallocated and, if the value is true, its memory should be released to the memory manager.

endDiscard

public Boolean endDiscard()

Returns:

null if no action is required; otherwise, the buffer should be deallocated and, if the value is true, its memory should be released to the memory manager.