GammaTxnLong.java

package org.multiverse.stms.gamma.transactionalobjects;

import org.multiverse.api.LockMode;
import org.multiverse.api.Txn;
import org.multiverse.api.exceptions.LockedException;
import org.multiverse.api.functions.Functions;
import org.multiverse.api.functions.LongFunction;
import org.multiverse.api.predicates.LongPredicate;
import org.multiverse.api.references.TxnLong;
import org.multiverse.stms.gamma.GammaStm;
import org.multiverse.stms.gamma.Listeners;
import org.multiverse.stms.gamma.transactions.GammaTxn;

import static org.multiverse.api.GlobalStmInstance.getGlobalStmInstance;
import static org.multiverse.stms.gamma.GammaStmUtils.asGammaTxn;
import static org.multiverse.stms.gamma.GammaStmUtils.getRequiredThreadLocalGammaTxn;
import static org.multiverse.stms.gamma.ThreadLocalGammaObjectPool.getThreadLocalGammaObjectPool;

/**
 * A {@link org.multiverse.api.references.TxnLong} for the {@link GammaStm}.
 *
 * @author Peter Veentjer.
 */
@SuppressWarnings({"OverlyComplexClass"})
public class GammaTxnLong extends BaseGammaTxnRef implements TxnLong {

    public GammaTxnLong(long value) {
        this((GammaStm) getGlobalStmInstance(), value);
    }

    public GammaTxnLong(final GammaStm stm) {
        this(stm, 0);
    }

    public GammaTxnLong(final GammaStm stm, long initialValue) {
        super(stm, TYPE_LONG);
        this.long_value = initialValue;
        //noinspection PointlessArithmeticExpression
        this.version = VERSION_UNCOMMITTED + 1;
    }

    public GammaTxnLong(final GammaTxn tx) {
        this(tx, 0);
    }

    public GammaTxnLong(final GammaTxn tx, final long value) {
        super(tx.getConfig().stm, TYPE_LONG);

        arriveAndLock(1, LOCKMODE_EXCLUSIVE);
        Tranlocal tranlocal = openForConstruction(tx);
        tranlocal.long_value = value;
    }

    @Override
    public final long get() {
        return get(getRequiredThreadLocalGammaTxn());
    }

    @Override
    public final long get(final Txn tx) {
        return get(asGammaTxn(tx));
    }

    public final long get(final GammaTxn tx) {
        return openForRead(tx, LOCKMODE_NONE).long_value;
    }

    @Override
    public final long getAndLock(final LockMode lockMode) {
        return getAndLock(getRequiredThreadLocalGammaTxn(), lockMode);
    }

    @Override
    public final long getAndLock(final Txn tx, final LockMode lockMode) {
        return getAndLock(asGammaTxn(tx), lockMode);
    }

    public final long getAndLock(final GammaTxn tx, final LockMode lockMode) {
        return getLong(tx, lockMode);
    }

    @Override
    public final long set(final long value) {
        return set(getRequiredThreadLocalGammaTxn(), value);
    }

    @Override
    public final long set(final Txn tx, final long value) {
        return set(asGammaTxn(tx), value);
    }

    public final long set(final GammaTxn tx, final long value) {
        openForWrite(tx, LOCKMODE_NONE).long_value = value;
        return value;
    }

    @Override
    public final long setAndLock(final long value, final LockMode lockMode) {
        return setAndLock(getRequiredThreadLocalGammaTxn(), value, lockMode);
    }

    @Override
    public final long setAndLock(final Txn tx, final long value, final LockMode lockMode) {
        return setAndLock(asGammaTxn(tx), value, lockMode);
    }

    public final long setAndLock(final GammaTxn tx, final long value, final LockMode lockMode) {
        return setLong(tx, lockMode, value, false);
    }

    @Override
    public final long getAndSet(final long value) {
        return getAndSet(getRequiredThreadLocalGammaTxn(), value);
    }

    public final long getAndSet(final Txn tx, final long value) {
        return getAndSet(asGammaTxn(tx), value);
    }

    public final long getAndSet(final GammaTxn tx, final long value) {
        final Tranlocal tranlocal = openForWrite(tx, LOCKMODE_NONE);
        final long oldValue = tranlocal.long_value;
        tranlocal.long_value = value;
        return oldValue;
    }

    @Override
    public final long getAndSetAndLock(final long value, final LockMode lockMode) {
        return getAndSetAndLock(getRequiredThreadLocalGammaTxn(), value, lockMode);
    }

    @Override
    public final long getAndSetAndLock(final Txn tx, final long value, final LockMode lockMode) {
        return getAndSetLock(asGammaTxn(tx), value, lockMode);
    }

    public final long getAndSetLock(final GammaTxn tx, final long value, final LockMode lockMode) {
        return setLong(tx, lockMode, value, true);
    }

    @Override
    public final long atomicGet() {
        return atomicGetLong();
    }

    @Override
    public final long atomicWeakGet() {
        return long_value;
    }

    @Override
    public final long atomicSet(final long newValue) {
        return atomicSetLong(newValue, false);
    }

    @Override
    public final long atomicGetAndSet(final long newValue) {
        return atomicSetLong(newValue, true);
    }

    @Override
    public final void commute(final LongFunction function) {
        commute(getRequiredThreadLocalGammaTxn(), function);
    }

    @Override
    public final void commute(Txn tx, LongFunction function) {
        openForCommute(asGammaTxn(tx), function);
    }

    public final void commute(GammaTxn tx, LongFunction function) {
        openForCommute(tx, function);
    }

    @Override
    public final long atomicAlterAndGet(final LongFunction function) {
        return atomicAlter(function, false);
    }

    private long atomicAlter(final LongFunction function, final boolean returnOld) {
        if (function == null) {
            throw new NullPointerException("Function can't be null");
        }

        final int arriveStatus = arriveAndExclusiveLockOrBackoff();

        if (arriveStatus == FAILURE) {
            throw new LockedException();
        }

        final long oldValue = long_value;
        long newValue;
        boolean abort = true;
        try {
            newValue = function.call(oldValue);
            abort = false;
        } finally {
            if (abort) {
                departAfterFailureAndUnlock();
            }
        }

        if (oldValue == newValue) {
            if ((arriveStatus & MASK_UNREGISTERED) != 0) {
                unlockByUnregistered();
            } else {
                departAfterReadingAndUnlock();
            }

            return oldValue;
        }

        if ((arriveStatus & MASK_CONFLICT) != 0) {
            stm.globalConflictCounter.signalConflict();
        }

        long_value = newValue;
        //noinspection NonAtomicOperationOnVolatileField
        version++;

        final Listeners listeners = ___removeListenersAfterWrite();

        departAfterUpdateAndUnlock();

        if (listeners != null) {
            listeners.openAll(getThreadLocalGammaObjectPool());
        }

        return returnOld ? oldValue : newValue;
    }

    @Override
    public final long alterAndGet(final LongFunction function) {
        return alterAndGet(getRequiredThreadLocalGammaTxn(), function);
    }

    @Override
    public final long alterAndGet(final Txn tx, final LongFunction function) {
        return alterAndGet(asGammaTxn(tx), function);
    }

    public final long alterAndGet(final GammaTxn tx, final LongFunction function) {
        return alter(tx, function, false);
    }

    @Override
    public final long atomicGetAndAlter(final LongFunction function) {
        return atomicAlter(function, true);
    }

    @Override
    public final long getAndAlter(final LongFunction function) {
        return getAndAlter(getRequiredThreadLocalGammaTxn(), function);
    }

    @Override
    public final long getAndAlter(final Txn tx, final LongFunction function) {
        return getAndAlter(asGammaTxn(tx), function);
    }

    public final long getAndAlter(final GammaTxn tx, final LongFunction function) {
        return alter(tx, function, true);
    }

    private long alter(final GammaTxn tx, final LongFunction function, final boolean returnOld) {
        if (tx == null) {
            throw new NullPointerException();
        }

        if (function == null) {
            tx.abort();
            throw new NullPointerException("Function can't be null");
        }

        final Tranlocal write = openForWrite(tx, LOCKMODE_NONE);

        boolean abort = true;

        try {
            long oldValue = write.long_value;
            write.long_value = function.call(oldValue);
            abort = false;
            return returnOld ? oldValue : write.long_value;
        } finally {
            if (abort) {
                tx.abort();
            }
        }
    }

    @Override
    public final boolean atomicCompareAndSet(final long expectedValue, final long newValue) {
        return atomicCompareAndSetLong(expectedValue, newValue);
    }

    @Override
    public final long atomicGetAndIncrement(final long amount) {
        final long result = atomicIncrementAndGet(amount);
        return result - amount;
    }

    @Override
    public final long getAndIncrement(final long amount) {
        return getAndIncrement(getRequiredThreadLocalGammaTxn(), amount);
    }

    @Override
    public final long getAndIncrement(final Txn tx, final long amount) {
        return getAndIncrement((GammaTxn) tx, amount);
    }

    public final long getAndIncrement(final GammaTxn tx, final long amount) {
        final Tranlocal tranlocal = openForWrite(tx, LOCKMODE_NONE);
        final long oldValue = tranlocal.long_value;
        tranlocal.long_value += amount;
        return oldValue;
    }

    @Override
    public final long atomicIncrementAndGet(final long amount) {
        final int arriveStatus = arriveAndExclusiveLockOrBackoff();

        if (arriveStatus == FAILURE) {
            throw new LockedException();
        }

        final long oldValue = long_value;

        if (amount == 0) {
            if ((arriveStatus & MASK_UNREGISTERED) != 0) {
                unlockByUnregistered();
            } else {
                departAfterReadingAndUnlock();
            }

            return oldValue;
        }

        if ((arriveStatus & MASK_CONFLICT) != 0) {
            stm.globalConflictCounter.signalConflict();
        }

        final long newValue = oldValue + amount;
        long_value = newValue;
        //noinspection NonAtomicOperationOnVolatileField
        version++;

        final Listeners listeners = ___removeListenersAfterWrite();

        departAfterUpdateAndUnlock();

        if (listeners != null) {
            listeners.openAll(getThreadLocalGammaObjectPool());
        }

        return newValue;
    }

    @Override
    public final long incrementAndGet(final long amount) {
        return incrementAndGet(getRequiredThreadLocalGammaTxn(), amount);
    }

    @Override
    public final long incrementAndGet(final Txn tx, final long amount) {
        return incrementAndGet(asGammaTxn(tx), amount);
    }

    public final long incrementAndGet(final GammaTxn tx, final long amount) {
        final Tranlocal tranlocal = openForWrite(tx, LOCKMODE_NONE);
        tranlocal.long_value += amount;
        return tranlocal.long_value;
    }

    @Override
    public final void increment() {
        increment(getRequiredThreadLocalGammaTxn());
    }

    @Override
    public final void increment(final Txn tx) {
        commute(asGammaTxn(tx), Functions.incLongFunction());
    }

    public final void increment(final GammaTxn tx) {
        commute(tx, Functions.incLongFunction());
    }

    @Override
    public final void increment(final long amount) {
        commute(getRequiredThreadLocalGammaTxn(), Functions.incLongFunction(amount));
    }

    @Override
    public final void increment(final Txn tx, final long amount) {
        commute(asGammaTxn(tx), Functions.incLongFunction(amount));
    }

    @Override
    public final void decrement() {
        commute(getRequiredThreadLocalGammaTxn(), Functions.decLongFunction());
    }

    @Override
    public final void decrement(final Txn tx) {
        commute(asGammaTxn(tx), Functions.decLongFunction());
    }

    @Override
    public final void decrement(final long amount) {
        commute(getRequiredThreadLocalGammaTxn(), Functions.incLongFunction(-amount));
    }

    @Override
    public final void decrement(final Txn tx, final long amount) {
        commute(asGammaTxn(tx), Functions.incLongFunction(-amount));
    }

    @Override
    public final void await(final long value) {
        await(getRequiredThreadLocalGammaTxn(), value);
    }

    @Override
    public final void await(final Txn tx, final long value) {
        await(asGammaTxn(tx), value);
    }

    public final void await(final GammaTxn tx, final long value) {
        if (openForRead(tx, LOCKMODE_NONE).long_value != value) {
            tx.retry();
        }
    }

    @Override
    public final void await(final LongPredicate predicate) {
        await(getRequiredThreadLocalGammaTxn(), predicate);
    }

    @Override
    public final void await(final Txn tx, final LongPredicate predicate) {
        await(asGammaTxn(tx), predicate);
    }

    public final void await(final GammaTxn tx, final LongPredicate predicate) {
        final Tranlocal tranlocal = openForRead(tx, LOCKMODE_NONE);
        boolean abort = true;
        try {
            if (!predicate.evaluate(tranlocal.long_value)) {
                tx.retry();
            }
            abort = false;
        } finally {
            if (abort) {
                tx.abort();
            }
        }
    }

    @Override
    public final String toDebugString() {
        return String.format("GammaTxnLong{orec=%s, version=%s, value=%s, hasListeners=%s)",
                ___toOrecString(), version, long_value, listeners != null);
    }

    @Override
    public final String toString() {
        return toString(getRequiredThreadLocalGammaTxn());
    }

    @Override
    public final String toString(Txn tx) {
        return toString(asGammaTxn(tx));
    }

    public final String toString(GammaTxn tx) {
        return Long.toString(get(tx));
    }

    @Override
    public final String atomicToString() {
        return Long.toString(atomicGet());
    }
}