X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-distributed-datastore%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fdatastore%2FTransactionProxy.java;h=a2a7a12044a74e23bc181f65e450e14548059bec;hb=e2d9f9c57e124d46e117f17c44b77c89222fdb99;hp=64f914b19fbebfa517afb2a7f23deb473a46a1a5;hpb=468b9523001807db03b3a545328ac9bf819278c7;p=controller.git diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionProxy.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionProxy.java index 64f914b19f..a2a7a12044 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionProxy.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionProxy.java @@ -18,7 +18,6 @@ import com.google.common.base.Optional; import com.google.common.base.Preconditions; import com.google.common.collect.Lists; import com.google.common.util.concurrent.CheckedFuture; -import com.google.common.util.concurrent.ListenableFuture; import com.google.common.util.concurrent.SettableFuture; import java.util.ArrayList; import java.util.Collection; @@ -41,6 +40,7 @@ import org.opendaylight.controller.cluster.datastore.messages.CreateTransactionR import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategyFactory; import org.opendaylight.controller.cluster.datastore.utils.ActorContext; import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException; +import org.opendaylight.controller.sal.core.spi.data.AbstractDOMStoreTransaction; import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction; import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort; import org.opendaylight.yangtools.util.concurrent.MappingCheckedFuture; @@ -65,26 +65,31 @@ import scala.concurrent.duration.FiniteDuration; * shards will be executed. *

*/ -public class TransactionProxy implements DOMStoreReadWriteTransaction { +public class TransactionProxy extends AbstractDOMStoreTransaction implements DOMStoreReadWriteTransaction { public static enum TransactionType { READ_ONLY, WRITE_ONLY, READ_WRITE; - public static TransactionType fromInt(int type) { - if(type == WRITE_ONLY.ordinal()) { - return WRITE_ONLY; - } else if(type == READ_WRITE.ordinal()) { - return READ_WRITE; - } else if(type == READ_ONLY.ordinal()) { - return READ_ONLY; - } else { - throw new IllegalArgumentException("In TransactionType enum value" + type); + // Cache all values + private static final TransactionType[] VALUES = values(); + + public static TransactionType fromInt(final int type) { + try { + return VALUES[type]; + } catch (IndexOutOfBoundsException e) { + throw new IllegalArgumentException("In TransactionType enum value " + type, e); } } } + private static enum TransactionState { + OPEN, + READY, + CLOSED, + } + static final Mapper SAME_FAILURE_TRANSFORMER = new Mapper() { @Override @@ -147,7 +152,7 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { remoteTransactionActors = referent.remoteTransactionActors; remoteTransactionActorsMB = referent.remoteTransactionActorsMB; actorContext = referent.actorContext; - identifier = referent.identifier; + identifier = referent.getIdentifier(); } @Override @@ -186,10 +191,9 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { private final TransactionType transactionType; private final ActorContext actorContext; - private final TransactionIdentifier identifier; private final String transactionChainId; private final SchemaContext schemaContext; - private boolean inReadyState; + private TransactionState state = TransactionState.OPEN; private volatile boolean initialized; private Semaphore operationLimiter; @@ -199,8 +203,8 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { this(actorContext, transactionType, ""); } - public TransactionProxy(ActorContext actorContext, TransactionType transactionType, - String transactionChainId) { + public TransactionProxy(ActorContext actorContext, TransactionType transactionType, String transactionChainId) { + super(createIdentifier(actorContext)); this.actorContext = Preconditions.checkNotNull(actorContext, "actorContext should not be null"); this.transactionType = Preconditions.checkNotNull(transactionType, @@ -209,14 +213,16 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { "schemaContext should not be null"); this.transactionChainId = transactionChainId; + LOG.debug("Created txn {} of type {} on chain {}", getIdentifier(), transactionType, transactionChainId); + } + + private static TransactionIdentifier createIdentifier(ActorContext actorContext) { String memberName = actorContext.getCurrentMemberName(); - if(memberName == null){ + if (memberName == null) { memberName = "UNKNOWN-MEMBER"; } - this.identifier = new TransactionIdentifier(memberName, counter.getAndIncrement()); - - LOG.debug("Created txn {} of type {} on chain {}", identifier, transactionType, transactionChainId); + return new TransactionIdentifier(memberName, counter.getAndIncrement()); } @VisibleForTesting @@ -224,8 +230,8 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { List> recordedOperationFutures = Lists.newArrayList(); for(TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) { TransactionContext transactionContext = txFutureCallback.getTransactionContext(); - if(transactionContext != null) { - recordedOperationFutures.addAll(transactionContext.getRecordedOperationFutures()); + if (transactionContext != null) { + transactionContext.copyRecordedOperationFutures(recordedOperationFutures); } } @@ -250,7 +256,7 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { Preconditions.checkState(transactionType != TransactionType.WRITE_ONLY, "Read operation on write-only transaction is not allowed"); - LOG.debug("Tx {} read {}", identifier, path); + LOG.debug("Tx {} read {}", getIdentifier(), path); throttleOperation(); @@ -273,7 +279,7 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { Preconditions.checkState(transactionType != TransactionType.WRITE_ONLY, "Exists operation on write-only transaction is not allowed"); - LOG.debug("Tx {} exists {}", identifier, path); + LOG.debug("Tx {} exists {}", getIdentifier(), path); throttleOperation(); @@ -293,7 +299,7 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { private void checkModificationState() { Preconditions.checkState(transactionType != TransactionType.READ_ONLY, "Modification operation on read-only transaction is not allowed"); - Preconditions.checkState(!inReadyState, + Preconditions.checkState(state == TransactionState.OPEN, "Transaction is sealed - further modifications are not allowed"); } @@ -326,13 +332,12 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { } } - @Override public void write(final YangInstanceIdentifier path, final NormalizedNode data) { checkModificationState(); - LOG.debug("Tx {} write {}", identifier, path); + LOG.debug("Tx {} write {}", getIdentifier(), path); throttleOperation(); @@ -350,7 +355,7 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { checkModificationState(); - LOG.debug("Tx {} merge {}", identifier, path); + LOG.debug("Tx {} merge {}", getIdentifier(), path); throttleOperation(); @@ -368,7 +373,7 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { checkModificationState(); - LOG.debug("Tx {} delete {}", identifier, path); + LOG.debug("Tx {} delete {}", getIdentifier(), path); throttleOperation(); @@ -381,18 +386,29 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { }); } + private boolean seal(final TransactionState newState) { + if (state == TransactionState.OPEN) { + state = newState; + return true; + } else { + return false; + } + } + @Override public DOMStoreThreePhaseCommitCohort ready() { + Preconditions.checkState(transactionType != TransactionType.READ_ONLY, + "Read-only transactions cannot be readied"); - checkModificationState(); - - inReadyState = true; + final boolean success = seal(TransactionState.READY); + Preconditions.checkState(success, "Transaction %s is %s, it cannot be readied", getIdentifier(), state); - LOG.debug("Tx {} Readying {} transactions for commit", identifier, + LOG.debug("Tx {} Readying {} transactions for commit", getIdentifier(), txFutureCallbackMap.size()); - if(txFutureCallbackMap.size() == 0) { + if (txFutureCallbackMap.isEmpty()) { onTransactionReady(Collections.>emptyList()); + TransactionRateLimitingCallback.adjustRateLimitForUnusedTransaction(actorContext); return NoOpDOMStoreThreePhaseCommitCohort.INSTANCE; } @@ -402,7 +418,7 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { for(TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) { - LOG.debug("Tx {} Readying transaction for shard {} chain {}", identifier, + LOG.debug("Tx {} Readying transaction for shard {} chain {}", getIdentifier(), txFutureCallback.getShardName(), transactionChainId); final TransactionContext transactionContext = txFutureCallback.getTransactionContext(); @@ -427,7 +443,7 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { onTransactionReady(cohortFutures); return new ThreePhaseCommitCohortProxy(actorContext, cohortFutures, - identifier.toString()); + getIdentifier().toString()); } /** @@ -438,13 +454,18 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { protected void onTransactionReady(List> cohortFutures) { } - @Override - public Object getIdentifier() { - return this.identifier; - } - @Override public void close() { + if (!seal(TransactionState.CLOSED)) { + if (state == TransactionState.CLOSED) { + // Idempotent no-op as per AutoCloseable recommendation + return; + } + + throw new IllegalStateException(String.format("Transaction %s is ready, it cannot be closed", + getIdentifier())); + } + for (TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) { txFutureCallback.enqueueTransactionOperation(new TransactionOperation() { @Override @@ -504,13 +525,6 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { return actorContext; } - /** - * Interfaces for transaction operations to be invoked later. - */ - private static interface TransactionOperation { - void invoke(TransactionContext transactionContext); - } - /** * Implements a Future OnComplete callback for a CreateTransaction message. This class handles * retries, up to a limit, if the shard doesn't have a leader yet. This is done by scheduling a @@ -567,7 +581,7 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { if(transactionType == TransactionType.WRITE_ONLY && actorContext.getDatastoreContext().isWriteOnlyTransactionOptimizationsEnabled()) { LOG.debug("Tx {} Primary shard {} found - creating WRITE_ONLY transaction context", - identifier, primaryShard); + getIdentifier(), primaryShard); // For write-only Tx's we prepare the transaction modifications directly on the shard actor // to avoid the overhead of creating a separate transaction actor. @@ -586,7 +600,7 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { boolean invokeOperation = true; synchronized(txOperationsOnComplete) { if(transactionContext == null) { - LOG.debug("Tx {} Adding operation on complete", identifier); + LOG.debug("Tx {} Adding operation on complete", getIdentifier()); invokeOperation = false; txOperationsOnComplete.add(operation); @@ -614,10 +628,10 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { */ private void tryCreateTransaction() { if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} Primary shard {} found - trying create transaction", identifier, primaryShard); + LOG.debug("Tx {} Primary shard {} found - trying create transaction", getIdentifier(), primaryShard); } - Object serializedCreateMessage = new CreateTransaction(identifier.toString(), + Object serializedCreateMessage = new CreateTransaction(getIdentifier().toString(), TransactionProxy.this.transactionType.ordinal(), getTransactionChainId()).toSerializable(); @@ -635,7 +649,7 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { // is ok. if(--createTxTries > 0) { LOG.debug("Tx {} Shard {} has no leader yet - scheduling create Tx retry", - identifier, shardName); + getIdentifier(), shardName); actorContext.getActorSystem().scheduler().scheduleOnce(CREATE_TX_TRY_INTERVAL, new Runnable() { @@ -667,17 +681,17 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { // TransactionContext until after we've executed all cached TransactionOperations. TransactionContext localTransactionContext; if(failure != null) { - LOG.debug("Tx {} Creating NoOpTransaction because of error", identifier, failure); + LOG.debug("Tx {} Creating NoOpTransaction because of error", getIdentifier(), failure); - localTransactionContext = new NoOpTransactionContext(failure, identifier, operationLimiter); - } else if (response.getClass().equals(CreateTransactionReply.SERIALIZABLE_CLASS)) { + localTransactionContext = new NoOpTransactionContext(failure, getIdentifier(), operationLimiter); + } else if (CreateTransactionReply.SERIALIZABLE_CLASS.equals(response.getClass())) { localTransactionContext = createValidTransactionContext( CreateTransactionReply.fromSerializable(response)); } else { IllegalArgumentException exception = new IllegalArgumentException(String.format( "Invalid reply type %s for CreateTransaction", response.getClass())); - localTransactionContext = new NoOpTransactionContext(exception, identifier, operationLimiter); + localTransactionContext = new NoOpTransactionContext(exception, getIdentifier(), operationLimiter); } executeTxOperatonsOnComplete(localTransactionContext); @@ -717,7 +731,7 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { } private TransactionContext createValidTransactionContext(CreateTransactionReply reply) { - LOG.debug("Tx {} Received {}", identifier, reply); + LOG.debug("Tx {} Received {}", getIdentifier(), reply); return createValidTransactionContext(actorContext.actorSelection(reply.getTransactionPath()), reply.getTransactionPath(), reply.getVersion()); @@ -754,49 +768,17 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { boolean isTxActorLocal = actorContext.isPathLocal(transactionPath); if(remoteTransactionVersion < DataStoreVersions.LITHIUM_VERSION) { - return new PreLithiumTransactionContextImpl(transactionPath, transactionActor, identifier, + return new PreLithiumTransactionContextImpl(transactionPath, transactionActor, getIdentifier(), transactionChainId, actorContext, schemaContext, isTxActorLocal, remoteTransactionVersion, operationCompleter); } else if (transactionType == TransactionType.WRITE_ONLY && actorContext.getDatastoreContext().isWriteOnlyTransactionOptimizationsEnabled()) { - return new WriteOnlyTransactionContextImpl(transactionActor, identifier, transactionChainId, + return new WriteOnlyTransactionContextImpl(transactionActor, getIdentifier(), transactionChainId, actorContext, schemaContext, isTxActorLocal, remoteTransactionVersion, operationCompleter); } else { - return new TransactionContextImpl(transactionActor, identifier, transactionChainId, + return new TransactionContextImpl(transactionActor, getIdentifier(), transactionChainId, actorContext, schemaContext, isTxActorLocal, remoteTransactionVersion, operationCompleter); } } } - - private static class NoOpDOMStoreThreePhaseCommitCohort implements DOMStoreThreePhaseCommitCohort { - static NoOpDOMStoreThreePhaseCommitCohort INSTANCE = new NoOpDOMStoreThreePhaseCommitCohort(); - - private static final ListenableFuture IMMEDIATE_VOID_SUCCESS = - com.google.common.util.concurrent.Futures.immediateFuture(null); - private static final ListenableFuture IMMEDIATE_BOOLEAN_SUCCESS = - com.google.common.util.concurrent.Futures.immediateFuture(Boolean.TRUE); - - private NoOpDOMStoreThreePhaseCommitCohort() { - } - - @Override - public ListenableFuture canCommit() { - return IMMEDIATE_BOOLEAN_SUCCESS; - } - - @Override - public ListenableFuture preCommit() { - return IMMEDIATE_VOID_SUCCESS; - } - - @Override - public ListenableFuture abort() { - return IMMEDIATE_VOID_SUCCESS; - } - - @Override - public ListenableFuture commit() { - return IMMEDIATE_VOID_SUCCESS; - } - } }