org.apache.ignite.internal.processors.cache

Interface IgniteCacheOffheapManager

All Known Implementing Classes:

GridCacheOffheapManager, IgniteCacheOffheapManagerImpl

public interface IgniteCacheOffheapManager

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IgniteCacheOffheapManager.CacheDataStore
static interface	IgniteCacheOffheapManager.OffheapInvokeClosure

Method Summary

Modifier and Type	Method and Description
Iterable<IgniteCacheOffheapManager.CacheDataStore>	cacheDataStores()
long	cacheEntriesCount(int cacheId)
long	cacheEntriesCount(int cacheId, boolean primary, boolean backup, AffinityTopologyVersion topVer)
long	cacheEntriesCount(int cacheId, int part)
<K,V> GridCloseableIterator<javax.cache.Cache.Entry<K,V>>	cacheEntriesIterator(GridCacheContext cctx, boolean primary, boolean backup, AffinityTopologyVersion topVer, boolean keepBinary, @Nullable MvccSnapshot mvccSnapshot, Boolean dataPageScanEnabled)
GridIterator<CacheDataRow>	cacheIterator(int cacheId, boolean primary, boolean backup, AffinityTopologyVersion topVer, @Nullable MvccSnapshot mvccSnapshot, Boolean dataPageScanEnabled)
GridCloseableIterator<KeyCacheObject>	cacheKeysIterator(int cacheId, int part)
GridIterator<CacheDataRow>	cachePartitionIterator(int cacheId, int part, @Nullable MvccSnapshot mvccSnapshot, Boolean dataPageScanEnabled)
void	clearCache(GridCacheContext cctx, boolean readers) Clears offheap entries.
void	confirmPartitionStatesRestored() Confirm that partition states are restored.
boolean	containsKey(GridCacheMapEntry entry) TODO: GG-10884, used on only from initialValue.
IgniteCacheOffheapManager.CacheDataStore	createCacheDataStore(int p)
IgniteCacheOffheapManager.CacheDataStore	dataStore(@Nullable GridDhtLocalPartition part)
void	destroyCacheDataStore(IgniteCacheOffheapManager.CacheDataStore store)
@Nullable RootPage	dropRootPageForIndex(int cacheId, String idxName, int segment) Dropping the root page of the index tree.
boolean	expire(GridCacheContext cctx, IgniteInClosure2X<GridCacheEntryEx,GridCacheVersion> c, int amount)
long	expiredSize() Gets the number of entries pending expire.
@Nullable RootPage	findRootPageForIndex(int cacheId, String idxName, int segment)
GridAtomicLong	globalRemoveId()
void	invoke(GridCacheContext cctx, KeyCacheObject key, GridDhtLocalPartition part, IgniteCacheOffheapManager.OffheapInvokeClosure c)
List<IgniteBiTuple<Object,MvccVersion>>	mvccAllVersions(GridCacheContext cctx, KeyCacheObject key) For testing only.
GridCursor<CacheDataRow>	mvccAllVersionsCursor(GridCacheContext cctx, KeyCacheObject key, Object x) Returns iterator over the all row versions for the given key.
boolean	mvccApplyHistoryIfAbsent(GridCacheMapEntry entry, List<GridCacheMvccEntryInfo> hist) Tries to apply entry history.
void	mvccApplyUpdate(GridCacheContext cctx, KeyCacheObject key, CacheObject val, GridCacheVersion ver, long expireTime, GridDhtLocalPartition part, MvccVersion mvccVer)
boolean	mvccInitialValue(GridCacheMapEntry entry, @Nullable CacheObject val, GridCacheVersion ver, long expireTime, MvccVersion mvccVer, MvccVersion newMvccVer)
@Nullable MvccUpdateResult	mvccLock(GridCacheMapEntry entry, MvccSnapshot mvccSnapshot)
@Nullable CacheDataRow	mvccRead(GridCacheContext cctx, KeyCacheObject key, MvccSnapshot mvccSnapshot)
@Nullable MvccUpdateResult	mvccRemove(GridCacheMapEntry entry, MvccSnapshot mvccSnapshot, boolean primary, boolean needHist, boolean needOldVal, @Nullable CacheEntryPredicate filter, boolean retVal)
void	mvccRemoveAll(GridCacheMapEntry entry)
MvccUpdateResult	mvccUpdate(GridCacheMapEntry entry, CacheObject val, GridCacheVersion ver, long expireTime, MvccSnapshot mvccSnapshot, boolean primary, boolean needHist, boolean noCreate, boolean needOldVal, @Nullable CacheEntryPredicate filter, boolean retVal, boolean keepBinary, javax.cache.processor.EntryProcessor entryProc, Object[] invokeArgs)
boolean	mvccUpdateRowWithPreloadInfo(GridCacheMapEntry entry, @Nullable CacheObject val, GridCacheVersion ver, long expireTime, MvccVersion mvccVer, MvccVersion newMvccVer, byte mvccTxState, byte newMvccTxState) Apply update with full history.
long	offHeapAllocatedSize()
void	onCacheStarted(GridCacheContext cctx)
void	onKernalStop() Callback on node stop.
int	onUndeploy(ClassLoader ldr)
GridIterator<CacheDataRow>	partitionIterator(int part)
void	preloadPartition(int pardId) Preload a partition.
void	prepareToStop() Prepare cache group to stop (due to cache destroy or cluster deactivate).
@Nullable CacheDataRow	read(GridCacheContext cctx, KeyCacheObject key)
@Nullable CacheDataRow	read(GridCacheMapEntry entry)
IgniteRebalanceIterator	rebalanceIterator(IgniteDhtDemandedPartitionsMap parts, AffinityTopologyVersion topVer)
void	remove(GridCacheContext cctx, KeyCacheObject key, int partId, GridDhtLocalPartition part)
@Nullable RootPage	renameRootPageForIndex(int cacheId, String oldIdxName, String newIdxName, int segment) Renaming the root page of the index tree.
GridCloseableIterator<CacheDataRow>	reservedIterator(int part, AffinityTopologyVersion topVer)
void	restorePartitionStates() Pre-create partitions that resides in page memory or WAL and restores their state.
long	restoreStateOfPartition(int p, @Nullable Integer recoveryState) Pre-create single partition that resides in page memory or WAL and restores their state.
ReuseList	reuseListForIndex(String idxName)
RootPage	rootPageForIndex(int cacheId, String idxName, int segment)
void	start(GridCacheSharedContext ctx, CacheGroupContext grp)
void	stop() Stop cache group (due to cache destroy or cluster deactivate).
void	stopCache(int cacheId, boolean destroy)
void	storeEntries(GridDhtLocalPartition part, Iterator<GridCacheEntryInfo> infos, IgnitePredicateX<CacheDataRow> initPred) Store entries.
void	update(GridCacheContext cctx, KeyCacheObject key, CacheObject val, GridCacheVersion ver, long expireTime, GridDhtLocalPartition part, @Nullable CacheDataRow oldRow)

Method Detail

start

void start(GridCacheSharedContext ctx,
           CacheGroupContext grp)
    throws IgniteCheckedException

Parameters:

ctx - Context.

grp - Cache group.

Throws:

IgniteCheckedException - If failed.

onCacheStarted

void onCacheStarted(GridCacheContext cctx)
             throws IgniteCheckedException

Parameters:

cctx - Cache context.

Throws:

IgniteCheckedException - If failed.

onKernalStop

void onKernalStop()

Callback on node stop.

stopCache

void stopCache(int cacheId,
               boolean destroy)

Parameters:

cacheId - Cache ID.

destroy - Destroy data flag. Setting to true will remove all cache data.

prepareToStop

void prepareToStop()

Prepare cache group to stop (due to cache destroy or cluster deactivate).

stop

void stop()

Stop cache group (due to cache destroy or cluster deactivate).

restoreStateOfPartition

long restoreStateOfPartition(int p,
                             @Nullable
                             @Nullable Integer recoveryState)
                      throws IgniteCheckedException

Pre-create single partition that resides in page memory or WAL and restores their state.

Parameters:

p - Partition id.

recoveryState - Partition recovery state.

Returns:

Processing time in millis.

Throws:

IgniteCheckedException - If failed.

restorePartitionStates

void restorePartitionStates()
                     throws IgniteCheckedException

Pre-create partitions that resides in page memory or WAL and restores their state.

Throws:

IgniteCheckedException - If failed.

confirmPartitionStatesRestored

void confirmPartitionStatesRestored()

Confirm that partition states are restored. This method should be called after restoring state of all partitions in group using restoreStateOfPartition(int, Integer).

read

@Nullable
@Nullable CacheDataRow read(GridCacheMapEntry entry)
                               throws IgniteCheckedException

Parameters:

entry - Cache entry.

Returns:

Cached row, if available, null otherwise.

Throws:

IgniteCheckedException - If failed.

read

@Nullable
@Nullable CacheDataRow read(GridCacheContext cctx,
                                      KeyCacheObject key)
                               throws IgniteCheckedException

Parameters:

cctx - Cache context.

key - Key.

Returns:

Cached row, if available, null otherwise.

Throws:

IgniteCheckedException - If failed.

createCacheDataStore

IgniteCacheOffheapManager.CacheDataStore createCacheDataStore(int p)
                                                       throws IgniteCheckedException

Parameters:

p - Partition.

Returns:

Data store.

Throws:

IgniteCheckedException - If failed.

cacheDataStores

Iterable<IgniteCacheOffheapManager.CacheDataStore> cacheDataStores()

Returns:

Iterable over all existing cache data stores.

dataStore

IgniteCacheOffheapManager.CacheDataStore dataStore(@Nullable
                                                   @Nullable GridDhtLocalPartition part)

Parameters:

part - Local partition or null if a related cache group is LOCAL.

Returns:

Cache data store associated with given partition or the cache data store for a LOCAL cache group.

destroyCacheDataStore

void destroyCacheDataStore(IgniteCacheOffheapManager.CacheDataStore store)
                    throws IgniteCheckedException

Parameters:

store - Data store.

Throws:

IgniteCheckedException - If failed.

containsKey

boolean containsKey(GridCacheMapEntry entry)

TODO: GG-10884, used on only from initialValue.

expire

boolean expire(GridCacheContext cctx,
               IgniteInClosure2X<GridCacheEntryEx,GridCacheVersion> c,
               int amount)
        throws IgniteCheckedException

Parameters:

cctx - Cache context.

c - Closure.

amount - Limit of processed entries by single call, -1 for no limit.

Returns:

True if unprocessed expired entries remains.

Throws:

IgniteCheckedException - If failed.

expiredSize

long expiredSize()
          throws IgniteCheckedException

Gets the number of entries pending expire.

Returns:

Number of pending entries.

Throws:

IgniteCheckedException - If failed to get number of pending entries.

invoke

void invoke(GridCacheContext cctx,
            KeyCacheObject key,
            GridDhtLocalPartition part,
            IgniteCacheOffheapManager.OffheapInvokeClosure c)
     throws IgniteCheckedException

Parameters:

cctx - Cache context.

key - Key.

part - Partition.

c - Tree update closure.

Throws:

IgniteCheckedException - If failed.

mvccRead

@Nullable
@Nullable CacheDataRow mvccRead(GridCacheContext cctx,
                                          KeyCacheObject key,
                                          MvccSnapshot mvccSnapshot)
                                   throws IgniteCheckedException

Parameters:

cctx - Cache context.

key - Key.

mvccSnapshot - MVCC snapshot.

Returns:

Cached row, if available, null otherwise.

Throws:

IgniteCheckedException - If failed.

mvccAllVersions

List<IgniteBiTuple<Object,MvccVersion>> mvccAllVersions(GridCacheContext cctx,
                                                        KeyCacheObject key)
                                                 throws IgniteCheckedException

For testing only.

Parameters:

cctx - Cache context.

key - Key.

Returns:

All stored versions for given key.

Throws:

IgniteCheckedException - If failed.

mvccAllVersionsCursor

GridCursor<CacheDataRow> mvccAllVersionsCursor(GridCacheContext cctx,
                                               KeyCacheObject key,
                                               Object x)
                                        throws IgniteCheckedException

Returns iterator over the all row versions for the given key.

Parameters:

cctx - Cache context.

key - Key.

x - Implementation specific argument, null always means that we need to return full detached data row.

Returns:

Iterator over all versions.

Throws:

IgniteCheckedException - If failed.

mvccInitialValue

boolean mvccInitialValue(GridCacheMapEntry entry,
                         @Nullable
                         @Nullable CacheObject val,
                         GridCacheVersion ver,
                         long expireTime,
                         MvccVersion mvccVer,
                         MvccVersion newMvccVer)
                  throws IgniteCheckedException

Parameters:

entry - Entry.

val - Value.

ver - Version.

expireTime - Expire time.

mvccVer - MVCC version.

newMvccVer - New MVCC version.

Returns:

True if value was inserted.

Throws:

IgniteCheckedException - If failed.

mvccApplyHistoryIfAbsent

boolean mvccApplyHistoryIfAbsent(GridCacheMapEntry entry,
                                 List<GridCacheMvccEntryInfo> hist)
                          throws IgniteCheckedException

Tries to apply entry history. Either applies full entry history or do nothing.

Parameters:

entry - Entry to update.

hist - Full entry history.

Returns:

True if history applied successfully, False otherwise.

Throws:

IgniteCheckedException

mvccUpdate

MvccUpdateResult mvccUpdate(GridCacheMapEntry entry,
                            CacheObject val,
                            GridCacheVersion ver,
                            long expireTime,
                            MvccSnapshot mvccSnapshot,
                            boolean primary,
                            boolean needHist,
                            boolean noCreate,
                            boolean needOldVal,
                            @Nullable
                            @Nullable CacheEntryPredicate filter,
                            boolean retVal,
                            boolean keepBinary,
                            javax.cache.processor.EntryProcessor entryProc,
                            Object[] invokeArgs)
                     throws IgniteCheckedException

Parameters:

entry - Entry.

val - Value.

ver - Cache version.

expireTime - Expire time.

mvccSnapshot - MVCC snapshot.

primary - True if on primary node.

needHist - Flag to collect history.

noCreate - Flag indicating that row should not be created if absent.

needOldVal - True if need old value.

filter - Filter.

retVal - Flag to return previous value.

keepBinary - Keep binary flag.

entryProc - Entry processor.

invokeArgs - Entry processor invoke arguments.

Returns:

Update result.

Throws:

IgniteCheckedException - If failed.

mvccRemove

@Nullable
@Nullable MvccUpdateResult mvccRemove(GridCacheMapEntry entry,
                                                MvccSnapshot mvccSnapshot,
                                                boolean primary,
                                                boolean needHist,
                                                boolean needOldVal,
                                                @Nullable
                                                @Nullable CacheEntryPredicate filter,
                                                boolean retVal)
                                         throws IgniteCheckedException

Parameters:

entry - Entry.

mvccSnapshot - MVCC snapshot.

primary - True if on primary node.

needHist - Flag to collect history.

needOldVal - True if need old value.

filter - Filter.

retVal - Flag to return previous value.

Returns:

Update result.

Throws:

IgniteCheckedException - If failed.

mvccLock

@Nullable
@Nullable MvccUpdateResult mvccLock(GridCacheMapEntry entry,
                                              MvccSnapshot mvccSnapshot)
                                       throws IgniteCheckedException

Parameters:

entry - Entry.

mvccSnapshot - MVCC snapshot.

Returns:

Update result.

Throws:

IgniteCheckedException - If failed.

mvccUpdateRowWithPreloadInfo

boolean mvccUpdateRowWithPreloadInfo(GridCacheMapEntry entry,
                                     @Nullable
                                     @Nullable CacheObject val,
                                     GridCacheVersion ver,
                                     long expireTime,
                                     MvccVersion mvccVer,
                                     MvccVersion newMvccVer,
                                     byte mvccTxState,
                                     byte newMvccTxState)
                              throws IgniteCheckedException

Apply update with full history. Note: History version may be skipped if it have already been actualized with previous update operation.

Parameters:

entry - Entry.

val - Value.

ver - Version.

mvccVer - MVCC version.

newMvccVer - New MVCC version.

Returns:

True if value was inserted.

Throws:

IgniteCheckedException - If failed.

mvccRemoveAll

void mvccRemoveAll(GridCacheMapEntry entry)
            throws IgniteCheckedException

Parameters:

entry - Entry.

Throws:

IgniteCheckedException - If failed.

update

void update(GridCacheContext cctx,
            KeyCacheObject key,
            CacheObject val,
            GridCacheVersion ver,
            long expireTime,
            GridDhtLocalPartition part,
            @Nullable
            @Nullable CacheDataRow oldRow)
     throws IgniteCheckedException

Parameters:

cctx - Cache context.

key - Key.

val - Value.

ver - Version.

expireTime - Expire time.

oldRow - Old row if available.

part - Partition.

Throws:

IgniteCheckedException - If failed.

mvccApplyUpdate

void mvccApplyUpdate(GridCacheContext cctx,
                     KeyCacheObject key,
                     CacheObject val,
                     GridCacheVersion ver,
                     long expireTime,
                     GridDhtLocalPartition part,
                     MvccVersion mvccVer)
              throws IgniteCheckedException

Parameters:

cctx - Cache context.

key - Key.

val - Value.

ver - Version.

expireTime - Expire time.

part - Partition.

mvccVer - Mvcc version.

Throws:

IgniteCheckedException - If failed.

remove

void remove(GridCacheContext cctx,
            KeyCacheObject key,
            int partId,
            GridDhtLocalPartition part)
     throws IgniteCheckedException

Parameters:

cctx - Cache context.

key - Key.

partId - Partition number.

part - Partition.

Throws:

IgniteCheckedException - If failed.

onUndeploy

int onUndeploy(ClassLoader ldr)

Parameters:

ldr - Class loader.

Returns:

Number of undeployed entries.

cacheIterator

GridIterator<CacheDataRow> cacheIterator(int cacheId,
                                         boolean primary,
                                         boolean backup,
                                         AffinityTopologyVersion topVer,
                                         @Nullable
                                         @Nullable MvccSnapshot mvccSnapshot,
                                         Boolean dataPageScanEnabled)
                                  throws IgniteCheckedException

Parameters:

cacheId - Cache ID.

primary - Primary entries flag.

backup - Backup entries flag.

topVer - Topology version.

mvccSnapshot - MVCC snapshot.

dataPageScanEnabled - Flag to enable data page scan.

Returns:

Rows iterator.

Throws:

IgniteCheckedException - If failed.

cachePartitionIterator

GridIterator<CacheDataRow> cachePartitionIterator(int cacheId,
                                                  int part,
                                                  @Nullable
                                                  @Nullable MvccSnapshot mvccSnapshot,
                                                  Boolean dataPageScanEnabled)
                                           throws IgniteCheckedException

Parameters:

cacheId - Cache ID.

part - Partition.

mvccSnapshot - MVCC snapshot.

dataPageScanEnabled - Flag to enable data page scan.

Returns:

Partition data iterator.

Throws:

IgniteCheckedException - If failed.

partitionIterator

GridIterator<CacheDataRow> partitionIterator(int part)
                                      throws IgniteCheckedException

Parameters:

part - Partition number.

Returns:

Iterator for given partition.

Throws:

IgniteCheckedException - If failed.

reservedIterator

GridCloseableIterator<CacheDataRow> reservedIterator(int part,
                                                     AffinityTopologyVersion topVer)
                                              throws IgniteCheckedException

Parameters:

part - Partition number.

topVer - Topology version.

Returns:

Iterator for given partition that will reserve partition state until it is closed.

Throws:

IgniteCheckedException - If failed.

rebalanceIterator

IgniteRebalanceIterator rebalanceIterator(IgniteDhtDemandedPartitionsMap parts,
                                          AffinityTopologyVersion topVer)
                                   throws IgniteCheckedException

Parameters:

parts - Partitions.

Returns:

Partition data iterator.

Throws:

IgniteCheckedException - If failed.

cacheEntriesIterator

<K,V> GridCloseableIterator<javax.cache.Cache.Entry<K,V>> cacheEntriesIterator(GridCacheContext cctx,
                                                                               boolean primary,
                                                                               boolean backup,
                                                                               AffinityTopologyVersion topVer,
                                                                               boolean keepBinary,
                                                                               @Nullable
                                                                               @Nullable MvccSnapshot mvccSnapshot,
                                                                               Boolean dataPageScanEnabled)
                                                                        throws IgniteCheckedException

Parameters:

cctx - Cache context.

primary - True if need to return primary entries.

backup - True if need to return backup entries.

topVer - Topology version.

keepBinary - Keep binary flag.

mvccSnapshot - MVCC snapshot.

dataPageScanEnabled - Flag to enable data page scan.

Returns:

Entries iterator.

Throws:

IgniteCheckedException - If failed.

cacheKeysIterator

GridCloseableIterator<KeyCacheObject> cacheKeysIterator(int cacheId,
                                                        int part)
                                                 throws IgniteCheckedException

Parameters:

cacheId - Cache ID.

part - Partition.

Returns:

Iterator.

Throws:

IgniteCheckedException - If failed.

cacheEntriesCount

long cacheEntriesCount(int cacheId,
                       boolean primary,
                       boolean backup,
                       AffinityTopologyVersion topVer)

Parameters:

cacheId - Cache ID.

primary - Primary entries flag.

backup - Backup entries flag.

topVer - Topology version.

Returns:

Entries count.

storeEntries

void storeEntries(GridDhtLocalPartition part,
                  Iterator<GridCacheEntryInfo> infos,
                  IgnitePredicateX<CacheDataRow> initPred)
           throws IgniteCheckedException

Store entries.

Parameters:

part - Local partition.

infos - Entry infos.

initPred - Applied to all created rows. Each row that not matches the predicate is removed.

Throws:

IgniteCheckedException - If failed.

clearCache

void clearCache(GridCacheContext cctx,
                boolean readers)

Clears offheap entries.

Parameters:

cctx - Cache context.

readers - True to clear readers.

cacheEntriesCount

long cacheEntriesCount(int cacheId,
                       int part)

Parameters:

cacheId - Cache ID.

part - Partition.

Returns:

Number of entries in given partition.

offHeapAllocatedSize

long offHeapAllocatedSize()

Returns:

Offheap allocated size.

globalRemoveId

GridAtomicLong globalRemoveId()

Returns:

Global remove ID counter.

rootPageForIndex

RootPage rootPageForIndex(int cacheId,
                          String idxName,
                          int segment)
                   throws IgniteCheckedException

Parameters:

cacheId - Cache ID.

idxName - Index name.

segment - Segment.

Returns:

Root page for index tree.

Throws:

IgniteCheckedException - If failed.

findRootPageForIndex

@Nullable
@Nullable RootPage findRootPageForIndex(int cacheId,
                                                  String idxName,
                                                  int segment)
                                           throws IgniteCheckedException

Parameters:

cacheId - Cache ID.

idxName - Index name.

Throws:

IgniteCheckedException - If failed.

dropRootPageForIndex

@Nullable
@Nullable RootPage dropRootPageForIndex(int cacheId,
                                                  String idxName,
                                                  int segment)
                                           throws IgniteCheckedException

Dropping the root page of the index tree.

Parameters:

cacheId - Cache ID.

idxName - Index name.

segment - Segment index.

Returns:

Dropped root page of the index tree.

Throws:

IgniteCheckedException - If failed.

renameRootPageForIndex

@Nullable
@Nullable RootPage renameRootPageForIndex(int cacheId,
                                                    String oldIdxName,
                                                    String newIdxName,
                                                    int segment)
                                             throws IgniteCheckedException

Renaming the root page of the index tree.

Parameters:

cacheId - Cache id.

oldIdxName - Old name of the index tree.

newIdxName - New name of the index tree.

segment - Segment index.

Returns:

Renamed root page of the index tree.

Throws:

IgniteCheckedException - If failed.

reuseListForIndex

ReuseList reuseListForIndex(String idxName)
                     throws IgniteCheckedException

Parameters:

idxName - Index name.

Returns:

Reuse list for index tree.

Throws:

IgniteCheckedException - If failed.

cacheEntriesCount

long cacheEntriesCount(int cacheId)

Parameters:

cacheId - Cache ID.

Returns:

Number of entries.

preloadPartition

void preloadPartition(int pardId)
               throws IgniteCheckedException

Preload a partition. Must be called under partition reservation for DHT caches.

Parameters:

pardId - Partition id.

Throws:

IgniteCheckedException - If failed.