org.apache.ignite.internal.processors.cache.mvcc

Class MvccUtils

java.lang.Object

org.apache.ignite.internal.processors.cache.mvcc.MvccUtils

public class MvccUtils
extends Object

Utils for MVCC.

Field Summary

Fields

Modifier and Type	Field and Description
static MvccVersion	INITIAL_VERSION A special version visible by everyone
static long	MVCC_COUNTER_NA
static long	MVCC_CRD_COUNTER_NA
static long	MVCC_CRD_START_CNTR
static int	MVCC_HINTS_BIT_OFF
static int	MVCC_HINTS_MASK Mask for tx hints. (2 highest bits)
static long	MVCC_INITIAL_CNTR
static int	MVCC_INVISIBLE
static int	MVCC_KEY_ABSENT_BEFORE_MASK Mask for KeyAbsent flag.
static int	MVCC_KEY_ABSENT_BEFORE_OFF
static MvccSnapshot	MVCC_MAX_SNAPSHOT A special snapshot for which all committed versions are visible
static int	MVCC_OP_COUNTER_MASK Mask for operation counter bits.
static int	MVCC_OP_COUNTER_NA
static int	MVCC_READ_OP_CNTR Used as 'read' snapshot op counter.
static long	MVCC_START_CNTR
static int	MVCC_START_OP_CNTR
static int	MVCC_VISIBLE
static int	MVCC_VISIBLE_REMOVED

Method Summary

Modifier and Type	Method and Description
static boolean	belongToSameTx(MvccVersion v1, MvccVersion v2)
static GridNearTxLocal	checkActive(GridNearTxLocal tx) Checks transaction state.
static int	compare(long mvccCrdLeft, long mvccCntrLeft, int mvccOpCntrLeft, long mvccCrdRight, long mvccCntrRight, int mvccOpCntrRight) Compares to pairs of coordinator/counter versions.
static int	compare(long mvccCrdLeft, long mvccCntrLeft, int mvccOpCntrLeft, MvccVersionAware other) Compares to pairs of coordinator/counter versions.
static int	compare(long mvccCrdLeft, long mvccCntrLeft, long mvccCrdRight, long mvccCntrRight) Compares to pairs of coordinator/counter versions.
static int	compare(MvccVersionAware row, long mvccCrdRight, long mvccCntrRight) Compares to pairs of MVCC versions.
static int	compare(MvccVersionAware row, MvccVersion ver) Compares row version (xid_min) with the given version.
static int	compare(MvccVersion mvccVerLeft, long mvccCrdRight, long mvccCntrRight) Compares to pairs of MVCC versions.
static int	compare(MvccVersion mvccVerLeft, long mvccCrdRight, long mvccCntrRight, int mvccOpCntrRight) Compares to pairs of MVCC versions.
static int	compareIgnoreOpCounter(MvccVersion left, MvccVersion right) Compares left version (xid_min) with the given version ignoring operation counter.
static int	compareNewVersion(MvccUpdateVersionAware row, long mvccCrd, long mvccCntr) Compares new row version (xid_max) with the given counter and coordinator versions.
static int	compareNewVersion(MvccUpdateVersionAware row, long mvccCrd, long mvccCntr, int opCntr) Compares new row version (xid_max) with the given counter and coordinator versions.
static int	compareNewVersion(MvccUpdateVersionAware row, MvccVersion ver) Compares new row version (xid_max) with the given version.
static MvccVersion	getNewVersion(GridCacheContext cctx, long link) Returns new version of row (xid_max) if any.
static int	getVisibleState(GridCacheContext cctx, long link, MvccSnapshot snapshot) Checks if a row's new version is visible for the given snapshot.
static boolean	hasNewVersion(MvccUpdateVersionAware row) Checks if a row has not empty new version (xid_max).
static boolean	isActive(GridCacheContext cctx, long mvccCrd, long mvccCntr, MvccSnapshot snapshot)
static boolean	isVisible(GridCacheContext cctx, MvccSnapshot snapshot, DataPageIO dataIo, long pageAddr, int itemId, int pageSize)
static boolean	isVisible(GridCacheContext cctx, MvccSnapshot snapshot, long mvccCrd, long mvccCntr, int opCntr) Checks if version is visible from the given snapshot.
static boolean	isVisible(GridCacheContext cctx, MvccSnapshot snapshot, long mvccCrd, long mvccCntr, int opCntrWithHints, boolean useTxLog) Checks if version is visible from the given snapshot.
static boolean	isVisible(GridCacheContext cctx, MvccSnapshot snapshot, long crd, long cntr, int opCntr, long link) Checks visibility of the given row versions from the given snapshot.
static boolean	mvccEnabled(GridKernalContext ctx)
static @NotNull MvccQueryTracker	mvccTracker(GridCacheContext cctx, boolean autoStartTx) Initialises MVCC filter and returns MVCC query tracker if needed.
static @NotNull MvccQueryTracker	mvccTracker(GridCacheContext cctx, GridNearTxLocal tx) Initialises MVCC filter and returns MVCC query tracker if needed.
static boolean	mvccVersionIsValid(long crdVer, long cntr)
static boolean	mvccVersionIsValid(long crdVer, long cntr, int opCntr)
static ClusterTopologyServerNotFoundException	noCoordinatorError()
static MvccSnapshot	requestSnapshot(@NotNull GridNearTxLocal tx)
static byte	state(CacheGroupContext grp, long mvccCrd, long mvccCntr, int mvccOpCntr)
static byte	state(GridCacheContext cctx, long mvccCrd, long mvccCntr, int mvccOpCntr)
static byte	state(MvccProcessor proc, long mvccCrd, long mvccCntr, int mvccOpCntr)
static void	throwAtomicityModesMismatchException(CacheConfiguration ccfg1, CacheConfiguration ccfg2) Throws atomicity modes compatibility validation exception.
static @Nullable GridNearTxLocal	tx(GridKernalContext ctx)
static @Nullable GridNearTxLocal	tx(GridKernalContext ctx, @Nullable GridCacheVersion txId)
static GridNearTxLocal	txStart(GridCacheContext cctx, long timeout)
static GridNearTxLocal	txStart(GridKernalContext ctx, long timeout)
static IgniteTxUnexpectedStateCheckedException	unexpectedStateException(CacheGroupContext grp, byte state, long crd, long cntr, int opCntr)
static IgniteTxUnexpectedStateCheckedException	unexpectedStateException(GridCacheContext cctx, byte state, long crd, long cntr, int opCntr, MvccSnapshot snapshot)
static void	verifyMvccOperationSupport(GridCacheContext<?,?> cctx, String opType) Throw an UnsupportedOperationException if this cache is transactional and MVCC is enabled with appropriate message about corresponding operation type.

Methods inherited from class java.lang.Object

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

Field Detail

MVCC_KEY_ABSENT_BEFORE_OFF

public static final int MVCC_KEY_ABSENT_BEFORE_OFF

See Also:

Constant Field Values

MVCC_HINTS_BIT_OFF

public static final int MVCC_HINTS_BIT_OFF

See Also:

Constant Field Values

MVCC_KEY_ABSENT_BEFORE_MASK

public static final int MVCC_KEY_ABSENT_BEFORE_MASK

Mask for KeyAbsent flag.

See Also:

Constant Field Values

MVCC_HINTS_MASK

public static final int MVCC_HINTS_MASK

Mask for tx hints. (2 highest bits)

See Also:

Constant Field Values

MVCC_OP_COUNTER_MASK

public static final int MVCC_OP_COUNTER_MASK

Mask for operation counter bits. (Excludes hints and flags)

See Also:

Constant Field Values

MVCC_CRD_COUNTER_NA

public static final long MVCC_CRD_COUNTER_NA

See Also:

Constant Field Values

MVCC_CRD_START_CNTR

public static final long MVCC_CRD_START_CNTR

See Also:

Constant Field Values

MVCC_COUNTER_NA

public static final long MVCC_COUNTER_NA

See Also:

Constant Field Values

MVCC_INITIAL_CNTR

public static final long MVCC_INITIAL_CNTR

See Also:

Constant Field Values

MVCC_START_CNTR

public static final long MVCC_START_CNTR

See Also:

Constant Field Values

MVCC_OP_COUNTER_NA

public static final int MVCC_OP_COUNTER_NA

See Also:

Constant Field Values

MVCC_START_OP_CNTR

public static final int MVCC_START_OP_CNTR

See Also:

Constant Field Values

MVCC_READ_OP_CNTR

public static final int MVCC_READ_OP_CNTR

Used as 'read' snapshot op counter.

See Also:

Constant Field Values

MVCC_INVISIBLE

public static final int MVCC_INVISIBLE

See Also:

Constant Field Values

MVCC_VISIBLE_REMOVED

public static final int MVCC_VISIBLE_REMOVED

See Also:

Constant Field Values

MVCC_VISIBLE

public static final int MVCC_VISIBLE

See Also:

Constant Field Values

INITIAL_VERSION

public static final MvccVersion INITIAL_VERSION

A special version visible by everyone

MVCC_MAX_SNAPSHOT

public static final MvccSnapshot MVCC_MAX_SNAPSHOT

A special snapshot for which all committed versions are visible

Method Detail

isActive

public static boolean isActive(GridCacheContext cctx,
                               long mvccCrd,
                               long mvccCntr,
                               MvccSnapshot snapshot)
                        throws IgniteCheckedException

Parameters:

cctx - Cache context.

mvccCrd - Mvcc coordinator version.

mvccCntr - Mvcc counter.

snapshot - Snapshot.

Returns:

True if transaction is active.

Throws:

IgniteCheckedException - If failed.

See Also:

TxState

state

public static byte state(GridCacheContext cctx,
                         long mvccCrd,
                         long mvccCntr,
                         int mvccOpCntr)

Parameters:

cctx - Cache context.

mvccCrd - Mvcc coordinator version.

mvccCntr - Mvcc counter.

mvccOpCntr - Mvcc operation counter.

Returns:

TxState

See Also:

TxState

state

public static byte state(CacheGroupContext grp,
                         long mvccCrd,
                         long mvccCntr,
                         int mvccOpCntr)

Parameters:

grp - Cache group context.

mvccCrd - Mvcc coordinator version.

mvccCntr - Mvcc counter.

mvccOpCntr - Mvcc operation counter.

Returns:

TxState

See Also:

TxState

state

public static byte state(MvccProcessor proc,
                         long mvccCrd,
                         long mvccCntr,
                         int mvccOpCntr)

Parameters:

proc - Mvcc processor.

mvccCrd - Mvcc coordinator version.

mvccCntr - Mvcc counter.

Returns:

TxState

See Also:

TxState

isVisible

public static boolean isVisible(GridCacheContext cctx,
                                MvccSnapshot snapshot,
                                long mvccCrd,
                                long mvccCntr,
                                int opCntr)
                         throws IgniteCheckedException

Checks if version is visible from the given snapshot.

Parameters:

cctx - Cache context.

snapshot - Snapshot.

mvccCrd - Mvcc coordinator.

mvccCntr - Mvcc counter.

opCntr - Operation counter.

Returns:

True if visible.

Throws:

IgniteCheckedException - If failed.

isVisible

public static boolean isVisible(GridCacheContext cctx,
                                MvccSnapshot snapshot,
                                long mvccCrd,
                                long mvccCntr,
                                int opCntrWithHints,
                                boolean useTxLog)
                         throws IgniteCheckedException

Checks if version is visible from the given snapshot.

Parameters:

cctx - Cache context.

snapshot - Snapshot.

mvccCrd - Mvcc coordinator.

mvccCntr - Mvcc counter.

opCntrWithHints - Operation counter.

useTxLog - True if TxLog should be used.

Returns:

True if visible.

Throws:

IgniteCheckedException - If failed.

unexpectedStateException

public static IgniteTxUnexpectedStateCheckedException unexpectedStateException(CacheGroupContext grp,
                                                                               byte state,
                                                                               long crd,
                                                                               long cntr,
                                                                               int opCntr)

Parameters:

grp - Cache group context.

state - State.

crd - Mvcc coordinator counter.

cntr - Mvcc counter.

opCntr - Mvcc operation counter.

Returns:

State exception.

unexpectedStateException

public static IgniteTxUnexpectedStateCheckedException unexpectedStateException(GridCacheContext cctx,
                                                                               byte state,
                                                                               long crd,
                                                                               long cntr,
                                                                               int opCntr,
                                                                               MvccSnapshot snapshot)

Parameters:

cctx - Cache context.

state - State.

crd - Mvcc coordinator counter.

cntr - Mvcc counter.

opCntr - Mvcc operation counter.

snapshot - Mvcc snapshot

Returns:

State exception.

isVisible

public static boolean isVisible(GridCacheContext cctx,
                                MvccSnapshot snapshot,
                                long crd,
                                long cntr,
                                int opCntr,
                                long link)
                         throws IgniteCheckedException

Checks visibility of the given row versions from the given snapshot.

Parameters:

cctx - Context.

snapshot - Snapshot.

crd - Mvcc coordinator counter.

cntr - Mvcc counter.

opCntr - Mvcc operation counter.

link - Link to data row (new version is located there).

Returns:

Visibility status.

Throws:

IgniteCheckedException - If failed.

hasNewVersion

public static boolean hasNewVersion(MvccUpdateVersionAware row)

Checks if a row has not empty new version (xid_max).

Parameters:

row - Row.

Returns:

True if row has a new version.

getVisibleState

public static int getVisibleState(GridCacheContext cctx,
                                  long link,
                                  MvccSnapshot snapshot)
                           throws IgniteCheckedException

Checks if a row's new version is visible for the given snapshot.

Parameters:

cctx - Cache context.

link - Link to the row.

snapshot - Mvcc snapshot.

Returns:

True if row is visible for the given snapshot.

Throws:

IgniteCheckedException - If failed.

getNewVersion

public static MvccVersion getNewVersion(GridCacheContext cctx,
                                        long link)
                                 throws IgniteCheckedException

Returns new version of row (xid_max) if any.

Parameters:

cctx - Cache context.

link - Link to the row.

Returns:

New MvccVersion if row has xid_max, or null if doesn't.

Throws:

IgniteCheckedException - If failed.

compare

public static int compare(MvccVersionAware row,
                          MvccVersion ver)

Compares row version (xid_min) with the given version.

Parameters:

row - Row.

ver - Version.

Returns:

Comparison result, see Comparable.

compare

public static int compare(MvccVersion mvccVerLeft,
                          long mvccCrdRight,
                          long mvccCntrRight)

Compares to pairs of MVCC versions. See Comparable.

Parameters:

mvccVerLeft - First MVCC version.

mvccCrdRight - Second coordinator version.

mvccCntrRight - Second counter.

Returns:

Comparison result, see Comparable.

compare

public static int compare(MvccVersionAware row,
                          long mvccCrdRight,
                          long mvccCntrRight)

Compares to pairs of MVCC versions. See Comparable.

Parameters:

row - First MVCC version.

mvccCrdRight - Second coordinator version.

mvccCntrRight - Second counter.

Returns:

Comparison result, see Comparable.

compare

public static int compare(MvccVersion mvccVerLeft,
                          long mvccCrdRight,
                          long mvccCntrRight,
                          int mvccOpCntrRight)

Compares to pairs of MVCC versions. See Comparable.

Parameters:

mvccVerLeft - First MVCC version.

mvccCrdRight - Second coordinator version.

mvccCntrRight - Second counter.

mvccOpCntrRight - Second operation counter.

Returns:

Comparison result, see Comparable.

compare

public static int compare(long mvccCrdLeft,
                          long mvccCntrLeft,
                          int mvccOpCntrLeft,
                          MvccVersionAware other)

Compares to pairs of coordinator/counter versions. See Comparable.

Parameters:

mvccCrdLeft - First coordinator version.

mvccCntrLeft - First counter version.

mvccOpCntrLeft - First operation counter.

other - The object to compare with.

Returns:

Comparison result, see Comparable.

compare

public static int compare(long mvccCrdLeft,
                          long mvccCntrLeft,
                          long mvccCrdRight,
                          long mvccCntrRight)

Compares to pairs of coordinator/counter versions. See Comparable.

Parameters:

mvccCrdLeft - First coordinator version.

mvccCntrLeft - First counter version.

mvccCrdRight - Second coordinator version.

mvccCntrRight - Second counter version.

Returns:

Comparison result, see Comparable.

compare

public static int compare(long mvccCrdLeft,
                          long mvccCntrLeft,
                          int mvccOpCntrLeft,
                          long mvccCrdRight,
                          long mvccCntrRight,
                          int mvccOpCntrRight)

Compares to pairs of coordinator/counter versions. See Comparable.

Parameters:

mvccCrdLeft - First coordinator version.

mvccCntrLeft - First counter version.

mvccOpCntrLeft - First operation counter.

mvccCrdRight - Second coordinator version.

mvccCntrRight - Second counter version.

mvccOpCntrRight - Second operation counter.

Returns:

Comparison result, see Comparable.

compareIgnoreOpCounter

public static int compareIgnoreOpCounter(MvccVersion left,
                                         MvccVersion right)

Compares left version (xid_min) with the given version ignoring operation counter.

Parameters:

left - Version.

right - Version.

Returns:

Comparison result, see Comparable.

compareNewVersion

public static int compareNewVersion(MvccUpdateVersionAware row,
                                    long mvccCrd,
                                    long mvccCntr)

Compares new row version (xid_max) with the given counter and coordinator versions.

Parameters:

row - Row.

mvccCrd - Mvcc coordinator.

mvccCntr - Mvcc counter.

Returns:

Comparison result, see Comparable.

compareNewVersion

public static int compareNewVersion(MvccUpdateVersionAware row,
                                    long mvccCrd,
                                    long mvccCntr,
                                    int opCntr)

Compares new row version (xid_max) with the given counter and coordinator versions.

Parameters:

row - Row.

mvccCrd - Mvcc coordinator.

mvccCntr - Mvcc counter.

opCntr - Mvcc operation counter.

Returns:

Comparison result, see Comparable.

compareNewVersion

public static int compareNewVersion(MvccUpdateVersionAware row,
                                    MvccVersion ver)

Compares new row version (xid_max) with the given version.

Parameters:

row - Row.

ver - Version.

Returns:

Comparison result, see Comparable.

mvccVersionIsValid

public static boolean mvccVersionIsValid(long crdVer,
                                         long cntr,
                                         int opCntr)

Parameters:

crdVer - Mvcc coordinator version.

cntr - Counter.

opCntr - Operation counter.

Returns:

Always true.

mvccVersionIsValid

public static boolean mvccVersionIsValid(long crdVer,
                                         long cntr)

Parameters:

crdVer - Mvcc coordinator version.

cntr - Counter.

Returns:

True if version is valid.

noCoordinatorError

public static ClusterTopologyServerNotFoundException noCoordinatorError()

Returns:

Error.

isVisible

public static boolean isVisible(GridCacheContext cctx,
                                MvccSnapshot snapshot,
                                DataPageIO dataIo,
                                long pageAddr,
                                int itemId,
                                int pageSize)
                         throws IgniteCheckedException

Parameters:

cctx - Cache context.

snapshot - Mvcc snapshot.

dataIo - Data page IO.

pageAddr - Page address.

itemId - Item Id.

pageSize - Page size.

Returns:

true If the row is visible.

Throws:

IgniteCheckedException - If failed.

verifyMvccOperationSupport

public static void verifyMvccOperationSupport(GridCacheContext<?,?> cctx,
                                              String opType)

Throw an UnsupportedOperationException if this cache is transactional and MVCC is enabled with appropriate message about corresponding operation type.

Parameters:

cctx - Cache context.

opType - operation type to mention in error message.

checkActive

public static GridNearTxLocal checkActive(GridNearTxLocal tx)
                                   throws IgniteTxAlreadyCompletedCheckedException

Checks transaction state.

Parameters:

tx - Transaction.

Returns:

Checked transaction.

Throws:

IgniteTxAlreadyCompletedCheckedException

tx

@Nullable
public static @Nullable GridNearTxLocal tx(GridKernalContext ctx)

Parameters:

ctx - Grid kernal context.

Returns:

Currently started user transaction, or null if none started.

Throws:

TransactionUnsupportedConcurrencyException - If transaction mode is not supported when MVCC is enabled.

TransactionMixedModeException - If started transaction spans non MVCC caches.

tx

@Nullable
public static @Nullable GridNearTxLocal tx(GridKernalContext ctx,
                                                     @Nullable
                                                     @Nullable GridCacheVersion txId)

Parameters:

ctx - Grid kernal context.

txId - Transaction ID.

Returns:

Currently started user transaction, or null if none started.

Throws:

TransactionUnsupportedConcurrencyException - If transaction mode is not supported when MVCC is enabled.

TransactionMixedModeException - If started transaction spans non MVCC caches.

txStart

public static GridNearTxLocal txStart(GridKernalContext ctx,
                                      long timeout)

Parameters:

ctx - Grid kernal context.

timeout - Transaction timeout.

Returns:

Newly started SQL transaction.

txStart

public static GridNearTxLocal txStart(GridCacheContext cctx,
                                      long timeout)

Parameters:

cctx - Cache context.

timeout - Transaction timeout.

Returns:

Newly started SQL transaction.

mvccEnabled

public static boolean mvccEnabled(GridKernalContext ctx)

Parameters:

ctx - Grid kernal context.

Returns:

Whether MVCC is enabled or not.

mvccTracker

@NotNull
public static @NotNull MvccQueryTracker mvccTracker(GridCacheContext cctx,
                                                             boolean autoStartTx)
                                                      throws IgniteCheckedException

Initialises MVCC filter and returns MVCC query tracker if needed.

Parameters:

cctx - Cache context.

autoStartTx - Start transaction flag.

Returns:

MVCC query tracker.

Throws:

IgniteCheckedException - If failed.

mvccTracker

@NotNull
public static @NotNull MvccQueryTracker mvccTracker(GridCacheContext cctx,
                                                             GridNearTxLocal tx)
                                                      throws IgniteCheckedException

Initialises MVCC filter and returns MVCC query tracker if needed.

Parameters:

cctx - Cache context.

tx - Transaction.

Returns:

MVCC query tracker.

Throws:

IgniteCheckedException - If failed.

requestSnapshot

public static MvccSnapshot requestSnapshot(@NotNull
                                           @NotNull GridNearTxLocal tx)
                                    throws IgniteCheckedException

Parameters:

tx - Transaction.

Returns:

Mvcc snapshot.

Throws:

IgniteCheckedException - If failed.

throwAtomicityModesMismatchException

public static void throwAtomicityModesMismatchException(CacheConfiguration ccfg1,
                                                        CacheConfiguration ccfg2)

Throws atomicity modes compatibility validation exception.

Parameters:

ccfg1 - Config 1.

ccfg2 - Config 2.

belongToSameTx

public static boolean belongToSameTx(MvccVersion v1,
                                     MvccVersion v2)

Parameters:

v1 - First MVCC version.

v2 - Second MVCC version.

Returns:

True if compared versions belongs to the same transaction.