alluxio.client.file.cache

Class ClockCuckooShadowCacheManager

java.lang.Object

alluxio.client.file.cache.ClockCuckooShadowCacheManager

All Implemented Interfaces:

ShadowCacheManager

public class ClockCuckooShadowCacheManager
extends Object
implements ShadowCacheManager

This class is a shadow cache with ClockCuckooFilter implementation.

Constructor Summary

Constructors

Constructor and Description
ClockCuckooShadowCacheManager(AlluxioConfiguration conf) Create a ClockCuckooShadowCacheManager.

Method Summary

Modifier and Type	Method and Description
void	aging() Aging all the pages stored in this shadow cache.
boolean	delete(PageId pageId) Deletes a page from the cache.
int	get(PageId pageId, int bytesToRead, CacheScope cacheScope) Reads the entire page and refresh its access time if the queried page is found in the cache.
double	getFalsePositiveRatio()
long	getShadowCacheByteHit()
long	getShadowCacheByteRead()
long	getShadowCacheBytes()
long	getShadowCacheBytes(CacheScope scope)
long	getShadowCachePageHit()
long	getShadowCachePageRead()
long	getShadowCachePages()
long	getShadowCachePages(CacheScope scope)
boolean	put(PageId pageId, int size, CacheScope cacheScope) Puts a page with specified size and scope into the shadow cache manager.
void	stopUpdate() Stop the background aging task.
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.ShadowCacheManager

create

Constructor Detail

ClockCuckooShadowCacheManager

public ClockCuckooShadowCacheManager(AlluxioConfiguration conf)

Create a ClockCuckooShadowCacheManager.

Parameters:

conf - the alluxio configuration

Method Detail

put

public boolean put(PageId pageId,
                   int size,
                   CacheScope cacheScope)

Description copied from interface: ShadowCacheManager

Puts a page with specified size and scope into the shadow cache manager.

Specified by:

put in interface ShadowCacheManager

Parameters:

pageId - page identifier

size - page size

cacheScope - cache scope

Returns:

true if the put was successful, false otherwise

get

public int get(PageId pageId,
               int bytesToRead,
               CacheScope cacheScope)

Description copied from interface: ShadowCacheManager

Reads the entire page and refresh its access time if the queried page is found in the cache.

Specified by:

get in interface ShadowCacheManager

Parameters:

pageId - page identifier

bytesToRead - number of bytes to read in this page

cacheScope - cache scope

Returns:

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

delete

public boolean delete(PageId pageId)

Description copied from interface: ShadowCacheManager

Deletes a page from the cache.

Specified by:

delete in interface ShadowCacheManager

Parameters:

pageId - page identifier

Returns:

true if the page is successfully deleted, false otherwise

aging

public void aging()

Description copied from interface: ShadowCacheManager

Aging all the pages stored in this shadow cache. Specifically, aging operation removes all the stale pages which are not accessed for more than a sliding window.

Specified by:

aging in interface ShadowCacheManager

updateWorkingSetSize

public void updateWorkingSetSize()

Description copied from interface: ShadowCacheManager

Update working set size in number of pages and bytes. Suggest calling this method before getting the number of pages or bytes.

Specified by:

updateWorkingSetSize in interface ShadowCacheManager

stopUpdate

public void stopUpdate()

Description copied from interface: ShadowCacheManager

Stop the background aging task.

Specified by:

stopUpdate in interface ShadowCacheManager

getShadowCachePages

public long getShadowCachePages()

Specified by:

getShadowCachePages in interface ShadowCacheManager

Returns:

the number of pages in this shadow cache

getShadowCachePages

public long getShadowCachePages(CacheScope scope)

Specified by:

getShadowCachePages in interface ShadowCacheManager

Parameters:

scope - cache scope

Returns:

the number of pages of given cache scope in this shadow cache

getShadowCacheBytes

public long getShadowCacheBytes()

Specified by:

getShadowCacheBytes in interface ShadowCacheManager

Returns:

the number of bytes in this shadow cache

getShadowCacheBytes

public long getShadowCacheBytes(CacheScope scope)

Specified by:

getShadowCacheBytes in interface ShadowCacheManager

Parameters:

scope - cache scope

Returns:

the number of bytes of given cache scope in this shadow cache

getShadowCachePageRead

public long getShadowCachePageRead()

Specified by:

getShadowCachePageRead in interface ShadowCacheManager

Returns:

the number of pages read in this shadow cache

getShadowCachePageHit

public long getShadowCachePageHit()

Specified by:

getShadowCachePageHit in interface ShadowCacheManager

Returns:

the number of pages hit in this shadow cache

getShadowCacheByteRead

public long getShadowCacheByteRead()

Specified by:

getShadowCacheByteRead in interface ShadowCacheManager

Returns:

the number of bytes read in this shadow cache

getShadowCacheByteHit

public long getShadowCacheByteHit()

Specified by:

getShadowCacheByteHit in interface ShadowCacheManager

Returns:

the number of bytes hit in this shadow cache

getFalsePositiveRatio

public double getFalsePositiveRatio()

Specified by:

getFalsePositiveRatio in interface ShadowCacheManager

Returns:

the false positive ratio