alluxio.client.file.cache

Class CacheManagerWithShadowCache

java.lang.Object

alluxio.client.file.cache.CacheManagerWithShadowCache

All Implemented Interfaces:

CacheManager, CacheStatus, AutoCloseable

public class CacheManagerWithShadowCache
extends Object
implements CacheManager

A wrapper class of CacheManager with shadow cache.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CacheManagerWithShadowCache.PageIdFunnel Funnel for PageId.

Nested classes/interfaces inherited from interface alluxio.client.file.cache.CacheManager

CacheManager.Factory, CacheManager.State

Field Summary

Fields inherited from interface alluxio.client.file.cache.CacheManager

LOG

Constructor Summary

Constructors

Constructor and Description
CacheManagerWithShadowCache(CacheManager cacheManager, AlluxioConfiguration conf)

Method Summary

Modifier and Type	Method and Description
void	aging() Decrease each item's clock and clean stale items.
boolean	append(PageId pageId, int appendAt, byte[] page, CacheContext cacheContext)
void	close()
void	commitFile(String fileId) Commit the File.
boolean	delete(PageId pageId) Deletes a page from the cache.
void	deleteFile(String fileId) Deletes all pages of the given file.
void	deleteTempFile(String fileId) Deletes all temporary pages of the given file.
int	get(PageId pageId, int pageOffset, int bytesToRead, ReadTargetBuffer target, CacheContext cacheContext) Reads a part of a page if the queried page is found in the cache, stores the result in buffer.
int	getAndLoad(PageId pageId, int pageOffset, int bytesToRead, ReadTargetBuffer buffer, CacheContext cacheContext, java.util.function.Supplier<byte[]> externalDataSupplier) Reads a part of a page if the queried page is found in the cache, stores the result in buffer.
Optional<DataFileChannel>	getDataFileChannel(PageId pageId, int pageOffset, int bytesToRead, CacheContext cacheContext) Get a DataFileChannel which wraps a FileRegion.
long	getShadowCacheByteHit()
long	getShadowCacheByteRead()
long	getShadowCacheBytes()
long	getShadowCachePageHit()
long	getShadowCachePageRead()
long	getShadowCachePages()
Optional<CacheUsage>	getUsage() Gets cache usage.
boolean	put(PageId pageId, ByteBuffer page, CacheContext cacheContext) Puts a page into the cache manager with scope and quota respected.
CacheManager.State	state()
void	stopUpdate() Stop to switch bloom filters and update working set size.
void	updateWorkingSetSize() Update working set size in number of pages and bytes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.client.file.cache.CacheManager

get, get, get, get, getCachedPageIdsByFileId, invalidate, put, put, put

Constructor Detail

CacheManagerWithShadowCache

public CacheManagerWithShadowCache(CacheManager cacheManager,
                                   AlluxioConfiguration conf)

Parameters:

cacheManager - the real cache manager

conf - the alluxio configuration

Method Detail

commitFile

public void commitFile(String fileId)

Description copied from interface: CacheManager

Commit the File.

Specified by:

commitFile in interface CacheManager

Parameters:

fileId - the file ID

put

public boolean put(PageId pageId,
                   ByteBuffer page,
                   CacheContext cacheContext)

Description copied from interface: CacheManager

Puts a page into the cache manager with scope and quota respected. This method is best effort. It is possible that this put operation returns without page written.

Specified by:

put in interface CacheManager

Parameters:

pageId - page identifier

page - page data

cacheContext - cache related context

Returns:

true if the put was successful, false otherwise

get

public int get(PageId pageId,
               int pageOffset,
               int bytesToRead,
               ReadTargetBuffer target,
               CacheContext cacheContext)

Description copied from interface: CacheManager

Reads a part of a page if the queried page is found in the cache, stores the result in buffer.

Specified by:

get in interface CacheManager

Parameters:

pageId - page identifier

pageOffset - offset into the page

bytesToRead - number of bytes to read in this page

target - destination buffer to write

cacheContext - cache related context

Returns:

number of bytes read, 0 if page is not found, -1 on errors

getAndLoad

public int getAndLoad(PageId pageId,
                      int pageOffset,
                      int bytesToRead,
                      ReadTargetBuffer buffer,
                      CacheContext cacheContext,
                      java.util.function.Supplier<byte[]> externalDataSupplier)

Description copied from interface: CacheManager

Reads a part of a page if the queried page is found in the cache, stores the result in buffer. Loads the page otherwise.

Specified by:

getAndLoad in interface CacheManager

Parameters:

pageId - page identifier

pageOffset - offset into the page

bytesToRead - number of bytes to read in this page

buffer - destination buffer to write

cacheContext - cache related context

externalDataSupplier - the external data supplier to read a page

Returns:

number of bytes read, 0 if page is not found, -1 on errors

updateWorkingSetSize

public void updateWorkingSetSize()

Update working set size in number of pages and bytes.

delete

public boolean delete(PageId pageId)

Description copied from interface: CacheManager

Deletes a page from the cache.

Specified by:

delete in interface CacheManager

Parameters:

pageId - page identifier

Returns:

true if the page is successfully deleted, false otherwise

stopUpdate

public void stopUpdate()

Stop to switch bloom filters and update working set size.

state

public CacheManager.State state()

Specified by:

state in interface CacheManager

Returns:

state of this cache

append

public boolean append(PageId pageId,
                      int appendAt,
                      byte[] page,
                      CacheContext cacheContext)

Specified by:

append in interface CacheManager

Returns:

true if append was successful

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

deleteFile

public void deleteFile(String fileId)

Description copied from interface: CacheManager

Deletes all pages of the given file.

Specified by:

deleteFile in interface CacheManager

Parameters:

fileId - the file id of the target file

deleteTempFile

public void deleteTempFile(String fileId)

Description copied from interface: CacheManager

Deletes all temporary pages of the given file.

Specified by:

deleteTempFile in interface CacheManager

Parameters:

fileId - the file id of the target file

getUsage

public Optional<CacheUsage> getUsage()

Description copied from interface: CacheStatus

Gets cache usage.

Specified by:

getUsage in interface CacheManager

Specified by:

getUsage in interface CacheStatus

Returns:

cache usage, or none if reporting usage info is not supported

getDataFileChannel

public Optional<DataFileChannel> getDataFileChannel(PageId pageId,
                                                    int pageOffset,
                                                    int bytesToRead,
                                                    CacheContext cacheContext)
                                             throws PageNotFoundException

Description copied from interface: CacheManager

Get a DataFileChannel which wraps a FileRegion.

Specified by:

getDataFileChannel in interface CacheManager

Parameters:

pageId - the page id

pageOffset - the offset inside the page

bytesToRead - the bytes to read

cacheContext - the cache context

Returns:

an object of DataFileChannel

Throws:

PageNotFoundException

aging

public void aging()

Decrease each item's clock and clean stale items.

getShadowCachePages

public long getShadowCachePages()

Returns:

ShadowCachePages

getShadowCacheBytes

public long getShadowCacheBytes()

Returns:

ShadowCacheBytes

getShadowCachePageRead

public long getShadowCachePageRead()

Returns:

ShadowCacheBytes

getShadowCachePageHit

public long getShadowCachePageHit()

Returns:

ShadowCacheBytes

getShadowCacheByteRead

public long getShadowCacheByteRead()

Returns:

ShadowCacheBytes

getShadowCacheByteHit

public long getShadowCacheByteHit()

Returns:

ShadowCacheBytes