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=71799c92d40a9bca75304a196f1c500895a04b09;hb=f3db96e1a7b1e416bcbd75c06cbca2fba8a152eb;hp=443e0af9e031392fe1ebb08d03d956b883b91dab;hpb=fa3763a80e5c8464252678565978527844ccdf98;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 443e0af9e0..71799c92d4 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 @@ -12,51 +12,40 @@ import akka.actor.ActorSelection; import akka.dispatch.Mapper; import akka.dispatch.OnComplete; import com.google.common.annotations.VisibleForTesting; -import com.google.common.base.FinalizablePhantomReference; -import com.google.common.base.FinalizableReferenceQueue; 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.FutureCallback; import com.google.common.util.concurrent.Futures; +import com.google.common.util.concurrent.ListenableFuture; import com.google.common.util.concurrent.SettableFuture; +import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; -import java.util.concurrent.ConcurrentHashMap; +import java.util.Set; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Semaphore; import java.util.concurrent.TimeUnit; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicLong; -import javax.annotation.concurrent.GuardedBy; -import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException; +import org.opendaylight.controller.cluster.datastore.compat.PreLithiumTransactionContextImpl; import org.opendaylight.controller.cluster.datastore.identifiers.TransactionIdentifier; -import org.opendaylight.controller.cluster.datastore.messages.CloseTransaction; -import org.opendaylight.controller.cluster.datastore.messages.CreateTransaction; -import org.opendaylight.controller.cluster.datastore.messages.CreateTransactionReply; -import org.opendaylight.controller.cluster.datastore.messages.DataExists; -import org.opendaylight.controller.cluster.datastore.messages.DataExistsReply; -import org.opendaylight.controller.cluster.datastore.messages.DeleteData; -import org.opendaylight.controller.cluster.datastore.messages.MergeData; -import org.opendaylight.controller.cluster.datastore.messages.ReadData; -import org.opendaylight.controller.cluster.datastore.messages.ReadDataReply; -import org.opendaylight.controller.cluster.datastore.messages.ReadyTransaction; -import org.opendaylight.controller.cluster.datastore.messages.ReadyTransactionReply; -import org.opendaylight.controller.cluster.datastore.messages.WriteData; import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategyFactory; import org.opendaylight.controller.cluster.datastore.utils.ActorContext; +import org.opendaylight.controller.cluster.datastore.utils.NormalizedNodeAggregator; 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; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; +import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException; import org.opendaylight.yangtools.yang.model.api.SchemaContext; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import scala.concurrent.Future; import scala.concurrent.Promise; -import scala.concurrent.duration.FiniteDuration; /** * TransactionProxy acts as a proxy for one or more transactions that were created on a remote shard @@ -70,12 +59,29 @@ 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 + READ_WRITE; + + // 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 = @@ -90,79 +96,6 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { private static final Logger LOG = LoggerFactory.getLogger(TransactionProxy.class); - /** - * Time interval in between transaction create retries. - */ - private static final FiniteDuration CREATE_TX_TRY_INTERVAL = - FiniteDuration.create(1, TimeUnit.SECONDS); - - /** - * Used to enqueue the PhantomReferences for read-only TransactionProxy instances. The - * FinalizableReferenceQueue is safe to use statically in an OSGi environment as it uses some - * trickery to clean up its internal thread when the bundle is unloaded. - */ - private static final FinalizableReferenceQueue phantomReferenceQueue = - new FinalizableReferenceQueue(); - - /** - * This stores the TransactionProxyCleanupPhantomReference instances statically, This is - * necessary because PhantomReferences need a hard reference so they're not garbage collected. - * Once finalized, the TransactionProxyCleanupPhantomReference removes itself from this map - * and thus becomes eligible for garbage collection. - */ - private static final Map phantomReferenceCache = - new ConcurrentHashMap<>(); - - /** - * A PhantomReference that closes remote transactions for a TransactionProxy when it's - * garbage collected. This is used for read-only transactions as they're not explicitly closed - * by clients. So the only way to detect that a transaction is no longer in use and it's safe - * to clean up is when it's garbage collected. It's inexact as to when an instance will be GC'ed - * but TransactionProxy instances should generally be short-lived enough to avoid being moved - * to the old generation space and thus should be cleaned up in a timely manner as the GC - * runs on the young generation (eden, swap1...) space much more frequently. - */ - private static class TransactionProxyCleanupPhantomReference - extends FinalizablePhantomReference { - - private final List remoteTransactionActors; - private final AtomicBoolean remoteTransactionActorsMB; - private final ActorContext actorContext; - private final TransactionIdentifier identifier; - - protected TransactionProxyCleanupPhantomReference(TransactionProxy referent) { - super(referent, phantomReferenceQueue); - - // Note we need to cache the relevant fields from the TransactionProxy as we can't - // have a hard reference to the TransactionProxy instance itself. - - remoteTransactionActors = referent.remoteTransactionActors; - remoteTransactionActorsMB = referent.remoteTransactionActorsMB; - actorContext = referent.actorContext; - identifier = referent.identifier; - } - - @Override - public void finalizeReferent() { - LOG.trace("Cleaning up {} Tx actors for TransactionProxy {}", - remoteTransactionActors.size(), identifier); - - phantomReferenceCache.remove(this); - - // Access the memory barrier volatile to ensure all previous updates to the - // remoteTransactionActors list are visible to this thread. - - if(remoteTransactionActorsMB.get()) { - for(ActorSelection actor : remoteTransactionActors) { - LOG.trace("Sending CloseTransaction to {}", actor); - actorContext.sendOperationAsync(actor, - new CloseTransaction().toSerializable()); - } - } - } - } - /** * Stores the remote Tx actors for each requested data store path to be used by the * PhantomReference to close the remote Tx's. This is only used for read-only Tx's. The @@ -170,8 +103,8 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { * remoteTransactionActors list so they will be visible to the thread accessing the * PhantomReference. */ - private List remoteTransactionActors; - private AtomicBoolean remoteTransactionActorsMB; + List remoteTransactionActors; + volatile AtomicBoolean remoteTransactionActorsMB; /** * Stores the create transaction results per shard. @@ -179,18 +112,21 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { private final Map txFutureCallbackMap = new HashMap<>(); private final TransactionType transactionType; - private final ActorContext actorContext; - private final TransactionIdentifier identifier; + final ActorContext actorContext; private final String transactionChainId; private final SchemaContext schemaContext; - private boolean inReadyState; + private TransactionState state = TransactionState.OPEN; + + private volatile boolean initialized; + private Semaphore operationLimiter; + private OperationCompleter operationCompleter; public TransactionProxy(ActorContext actorContext, TransactionType transactionType) { 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, @@ -199,41 +135,16 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { "schemaContext should not be null"); this.transactionChainId = transactionChainId; - String memberName = actorContext.getCurrentMemberName(); - if(memberName == null){ - memberName = "UNKNOWN-MEMBER"; - } - - this.identifier = TransactionIdentifier.builder().memberName(memberName).counter( - counter.getAndIncrement()).build(); - - if(transactionType == TransactionType.READ_ONLY) { - // Read-only Tx's aren't explicitly closed by the client so we create a PhantomReference - // to close the remote Tx's when this instance is no longer in use and is garbage - // collected. - - remoteTransactionActors = Lists.newArrayList(); - remoteTransactionActorsMB = new AtomicBoolean(); - - TransactionProxyCleanupPhantomReference cleanup = - new TransactionProxyCleanupPhantomReference(this); - phantomReferenceCache.put(cleanup, cleanup); - } - - LOG.debug("Created txn {} of type {} on chain {}", identifier, transactionType, transactionChainId); + LOG.debug("Created txn {} of type {} on chain {}", getIdentifier(), transactionType, transactionChainId); } - @VisibleForTesting - List> getRecordedOperationFutures() { - List> recordedOperationFutures = Lists.newArrayList(); - for(TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) { - TransactionContext transactionContext = txFutureCallback.getTransactionContext(); - if(transactionContext != null) { - recordedOperationFutures.addAll(transactionContext.getRecordedOperationFutures()); - } + private static TransactionIdentifier createIdentifier(ActorContext actorContext) { + String memberName = actorContext.getCurrentMemberName(); + if (memberName == null) { + memberName = "UNKNOWN-MEMBER"; } - return recordedOperationFutures; + return new TransactionIdentifier(memberName, counter.getAndIncrement()); } @VisibleForTesting @@ -248,119 +159,153 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { return false; } + private boolean isRootPath(YangInstanceIdentifier path){ + return !path.getPathArguments().iterator().hasNext(); + } + @Override - public CheckedFuture>, ReadFailedException> read( - final YangInstanceIdentifier path) { + public CheckedFuture>, ReadFailedException> read(final YangInstanceIdentifier path) { 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); - TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); - TransactionContext transactionContext = txFutureCallback.getTransactionContext(); + final SettableFuture>> proxyFuture = SettableFuture.create(); - CheckedFuture>, ReadFailedException> future; - if(transactionContext != null) { - future = transactionContext.readData(path); + if(isRootPath(path)){ + readAllData(path, proxyFuture); } else { - // The shard Tx hasn't been created yet so add the Tx operation to the Tx Future - // callback to be executed after the Tx is created. - final SettableFuture>> proxyFuture = SettableFuture.create(); - txFutureCallback.addTxOperationOnComplete(new TransactionOperation() { + throttleOperation(); + + TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); + txFutureCallback.enqueueTransactionOperation(new TransactionOperation() { @Override public void invoke(TransactionContext transactionContext) { - Futures.addCallback(transactionContext.readData(path), - new FutureCallback>>() { - @Override - public void onSuccess(Optional> data) { - proxyFuture.set(data); - } - - @Override - public void onFailure(Throwable t) { - proxyFuture.setException(t); - } - }); + transactionContext.readData(path, proxyFuture); } }); - future = MappingCheckedFuture.create(proxyFuture, ReadFailedException.MAPPER); } - return future; + return MappingCheckedFuture.create(proxyFuture, ReadFailedException.MAPPER); } - @Override - public CheckedFuture exists(final YangInstanceIdentifier path) { + private void readAllData(final YangInstanceIdentifier path, + final SettableFuture>> proxyFuture) { + Set allShardNames = actorContext.getConfiguration().getAllShardNames(); + List>>> futures = new ArrayList<>(allShardNames.size()); - Preconditions.checkState(transactionType != TransactionType.WRITE_ONLY, - "Exists operation on write-only transaction is not allowed"); + for(String shardName : allShardNames){ + final SettableFuture>> subProxyFuture = SettableFuture.create(); - LOG.debug("Tx {} exists {}", identifier, path); + throttleOperation(); - TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); - TransactionContext transactionContext = txFutureCallback.getTransactionContext(); - - CheckedFuture future; - if(transactionContext != null) { - future = transactionContext.dataExists(path); - } else { - // The shard Tx hasn't been created yet so add the Tx operation to the Tx Future - // callback to be executed after the Tx is created. - final SettableFuture proxyFuture = SettableFuture.create(); - txFutureCallback.addTxOperationOnComplete(new TransactionOperation() { + TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(shardName); + txFutureCallback.enqueueTransactionOperation(new TransactionOperation() { @Override public void invoke(TransactionContext transactionContext) { - Futures.addCallback(transactionContext.dataExists(path), - new FutureCallback() { - @Override - public void onSuccess(Boolean exists) { - proxyFuture.set(exists); - } - - @Override - public void onFailure(Throwable t) { - proxyFuture.setException(t); - } - }); + transactionContext.readData(path, subProxyFuture); } }); - future = MappingCheckedFuture.create(proxyFuture, ReadFailedException.MAPPER); + futures.add(subProxyFuture); } - return future; + final ListenableFuture>>> future = Futures.allAsList(futures); + + future.addListener(new Runnable() { + @Override + public void run() { + try { + proxyFuture.set(NormalizedNodeAggregator.aggregate(YangInstanceIdentifier.builder().build(), + future.get(), actorContext.getSchemaContext())); + } catch (DataValidationFailedException | InterruptedException | ExecutionException e) { + proxyFuture.setException(e); + } + } + }, actorContext.getActorSystem().dispatcher()); + } + + @Override + public CheckedFuture exists(final YangInstanceIdentifier path) { + + Preconditions.checkState(transactionType != TransactionType.WRITE_ONLY, + "Exists operation on write-only transaction is not allowed"); + + LOG.debug("Tx {} exists {}", getIdentifier(), path); + + throttleOperation(); + + final SettableFuture proxyFuture = SettableFuture.create(); + + TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); + txFutureCallback.enqueueTransactionOperation(new TransactionOperation() { + @Override + public void invoke(TransactionContext transactionContext) { + transactionContext.dataExists(path, proxyFuture); + } + }); + + return MappingCheckedFuture.create(proxyFuture, ReadFailedException.MAPPER); } 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"); } + private void throttleOperation() { + throttleOperation(1); + } + + private void throttleOperation(int acquirePermits) { + if(!initialized) { + // Note : Currently mailbox-capacity comes from akka.conf and not from the config-subsystem + operationLimiter = new Semaphore(actorContext.getTransactionOutstandingOperationLimit()); + operationCompleter = new OperationCompleter(operationLimiter); + + // Make sure we write this last because it's volatile and will also publish the non-volatile writes + // above as well so they'll be visible to other threads. + initialized = true; + } + + try { + if(!operationLimiter.tryAcquire(acquirePermits, + actorContext.getDatastoreContext().getOperationTimeoutInSeconds(), TimeUnit.SECONDS)){ + LOG.warn("Failed to acquire operation permit for transaction {}", getIdentifier()); + } + } catch (InterruptedException e) { + if(LOG.isDebugEnabled()) { + LOG.debug("Interrupted when trying to acquire operation permit for transaction " + getIdentifier().toString(), e); + } else { + LOG.warn("Interrupted when trying to acquire operation permit for transaction {}", getIdentifier()); + } + } + } + + final void ensureInitializied() { + Preconditions.checkState(initialized, "Transaction %s was not propertly initialized.", getIdentifier()); + } + @Override public void write(final YangInstanceIdentifier path, final NormalizedNode data) { checkModificationState(); - LOG.debug("Tx {} write {}", identifier, path); + LOG.debug("Tx {} write {}", getIdentifier(), path); + + throttleOperation(); TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); - TransactionContext transactionContext = txFutureCallback.getTransactionContext(); - if(transactionContext != null) { - transactionContext.writeData(path, data); - } else { - // The shard Tx hasn't been created yet so add the Tx operation to the Tx Future - // callback to be executed after the Tx is created. - txFutureCallback.addTxOperationOnComplete(new TransactionOperation() { - @Override - public void invoke(TransactionContext transactionContext) { - transactionContext.writeData(path, data); - } - }); - } + txFutureCallback.enqueueTransactionOperation(new TransactionOperation() { + @Override + public void invoke(TransactionContext transactionContext) { + transactionContext.writeData(path, data); + } + }); } @Override @@ -368,22 +313,17 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { checkModificationState(); - LOG.debug("Tx {} merge {}", identifier, path); + LOG.debug("Tx {} merge {}", getIdentifier(), path); + + throttleOperation(); TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); - TransactionContext transactionContext = txFutureCallback.getTransactionContext(); - if(transactionContext != null) { - transactionContext.mergeData(path, data); - } else { - // The shard Tx hasn't been created yet so add the Tx operation to the Tx Future - // callback to be executed after the Tx is created. - txFutureCallback.addTxOperationOnComplete(new TransactionOperation() { - @Override - public void invoke(TransactionContext transactionContext) { - transactionContext.mergeData(path, data); - } - }); - } + txFutureCallback.enqueueTransactionOperation(new TransactionOperation() { + @Override + public void invoke(TransactionContext transactionContext) { + transactionContext.mergeData(path, data); + } + }); } @Override @@ -391,109 +331,99 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { checkModificationState(); - LOG.debug("Tx {} delete {}", identifier, path); + LOG.debug("Tx {} delete {}", getIdentifier(), path); + + throttleOperation(); TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); - TransactionContext transactionContext = txFutureCallback.getTransactionContext(); - if(transactionContext != null) { - transactionContext.deleteData(path); + txFutureCallback.enqueueTransactionOperation(new TransactionOperation() { + @Override + public void invoke(TransactionContext transactionContext) { + transactionContext.deleteData(path); + } + }); + } + + private boolean seal(final TransactionState newState) { + if (state == TransactionState.OPEN) { + state = newState; + return true; } else { - // The shard Tx hasn't been created yet so add the Tx operation to the Tx Future - // callback to be executed after the Tx is created. - txFutureCallback.addTxOperationOnComplete(new TransactionOperation() { - @Override - public void invoke(TransactionContext transactionContext) { - transactionContext.deleteData(path); - } - }); + return false; } } @Override - public DOMStoreThreePhaseCommitCohort ready() { - - checkModificationState(); + public AbstractThreePhaseCommitCohort ready() { + Preconditions.checkState(transactionType != TransactionType.READ_ONLY, + "Read-only transactions cannot be readied"); - 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()); - List> cohortFutures = Lists.newArrayList(); + if (txFutureCallbackMap.isEmpty()) { + TransactionRateLimitingCallback.adjustRateLimitForUnusedTransaction(actorContext); + return NoOpDOMStoreThreePhaseCommitCohort.INSTANCE; + } + + throttleOperation(txFutureCallbackMap.size()); + List> cohortFutures = new ArrayList<>(txFutureCallbackMap.size()); 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); - TransactionContext transactionContext = txFutureCallback.getTransactionContext(); - if(transactionContext != null) { - cohortFutures.add(transactionContext.readyTransaction()); + final TransactionContext transactionContext = txFutureCallback.getTransactionContext(); + final Future future; + if (transactionContext != null) { + // avoid the creation of a promise and a TransactionOperation + future = transactionContext.readyTransaction(); } else { - // The shard Tx hasn't been created yet so create a promise to ready the Tx later - // after it's created. - final Promise cohortPromise = akka.dispatch.Futures.promise(); - txFutureCallback.addTxOperationOnComplete(new TransactionOperation() { + final Promise promise = akka.dispatch.Futures.promise(); + txFutureCallback.enqueueTransactionOperation(new TransactionOperation() { @Override public void invoke(TransactionContext transactionContext) { - cohortPromise.completeWith(transactionContext.readyTransaction()); + promise.completeWith(transactionContext.readyTransaction()); } }); - - cohortFutures.add(cohortPromise.future()); + future = promise.future(); } - } - onTransactionReady(cohortFutures); + cohortFutures.add(future); + } return new ThreePhaseCommitCohortProxy(actorContext, cohortFutures, - identifier.toString()); - } - - /** - * Method for derived classes to be notified when the transaction has been readied. - * - * @param cohortFutures the cohort Futures for each shard transaction. - */ - protected void onTransactionReady(List> cohortFutures) { - } - - /** - * Method called to send a CreateTransaction message to a shard. - * - * @param shard the shard actor to send to - * @param serializedCreateMessage the serialized message to send - * @return the response Future - */ - protected Future sendCreateTransaction(ActorSelection shard, - Object serializedCreateMessage) { - return actorContext.executeOperationAsync(shard, serializedCreateMessage); - } - - @Override - public Object getIdentifier() { - return this.identifier; + getIdentifier().toString()); } @Override public void close() { - for(TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) { - TransactionContext transactionContext = txFutureCallback.getTransactionContext(); - if(transactionContext != null) { - transactionContext.closeTransaction(); - } else { - txFutureCallback.addTxOperationOnComplete(new TransactionOperation() { - @Override - public void invoke(TransactionContext transactionContext) { - transactionContext.closeTransaction(); - } - }); + 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 + public void invoke(TransactionContext transactionContext) { + transactionContext.closeTransaction(); + } + }); } txFutureCallbackMap.clear(); - if(transactionType == TransactionType.READ_ONLY) { + if(remoteTransactionActorsMB != null) { remoteTransactionActors.clear(); remoteTransactionActorsMB.set(true); } @@ -503,14 +433,29 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { return ShardStrategyFactory.getStrategy(path).findShard(path); } + protected Future sendFindPrimaryShardAsync(String shardName) { + return actorContext.findPrimaryShardAsync(shardName); + } + + final TransactionType getTransactionType() { + return transactionType; + } + + final Semaphore getOperationLimiter() { + return operationLimiter; + } + private TransactionFutureCallback getOrCreateTxFutureCallback(YangInstanceIdentifier path) { String shardName = shardNameFromIdentifier(path); + return getOrCreateTxFutureCallback(shardName); + } + + private TransactionFutureCallback getOrCreateTxFutureCallback(String shardName) { TransactionFutureCallback txFutureCallback = txFutureCallbackMap.get(shardName); if(txFutureCallback == null) { - Future findPrimaryFuture = actorContext.findPrimaryShardAsync(shardName); + Future findPrimaryFuture = sendFindPrimaryShardAsync(shardName); - final TransactionFutureCallback newTxFutureCallback = - new TransactionFutureCallback(shardName); + final TransactionFutureCallback newTxFutureCallback = new TransactionFutureCallback(this, shardName); txFutureCallback = newTxFutureCallback; txFutureCallbackMap.put(shardName, txFutureCallback); @@ -519,18 +464,18 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { @Override public void onComplete(Throwable failure, ActorSelection primaryShard) { if(failure != null) { - newTxFutureCallback.onComplete(failure, null); + newTxFutureCallback.createTransactionContext(failure, null); } else { newTxFutureCallback.setPrimaryShard(primaryShard); } } - }, actorContext.getActorSystem().dispatcher()); + }, actorContext.getClientDispatcher()); } return txFutureCallback; } - public String getTransactionChainId() { + String getTransactionChainId() { return transactionChainId; } @@ -538,573 +483,41 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { return actorContext; } - /** - * Interface for a transaction operation 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 - * retry task after a short delay. - *

- * The end result from a completed CreateTransaction message is a TransactionContext that is - * used to perform transaction operations. Transaction operations that occur before the - * CreateTransaction completes are cache and executed once the CreateTransaction completes, - * successfully or not. - */ - private class TransactionFutureCallback extends OnComplete { - - /** - * The list of transaction operations to execute once the CreateTransaction completes. - */ - @GuardedBy("txOperationsOnComplete") - private final List txOperationsOnComplete = Lists.newArrayList(); + TransactionContext createValidTransactionContext(ActorSelection transactionActor, + String transactionPath, short remoteTransactionVersion) { - /** - * The TransactionContext resulting from the CreateTransaction reply. - */ - private volatile TransactionContext transactionContext; - - /** - * The target primary shard. - */ - private volatile ActorSelection primaryShard; - - private volatile int createTxTries = (int) (actorContext.getDatastoreContext(). - getShardLeaderElectionTimeout().duration().toMillis() / - CREATE_TX_TRY_INTERVAL.toMillis()); - - private final String shardName; - - TransactionFutureCallback(String shardName) { - this.shardName = shardName; - } - - String getShardName() { - return shardName; - } - - TransactionContext getTransactionContext() { - return transactionContext; - } - - - /** - * Sets the target primary shard and initiates a CreateTransaction try. - */ - void setPrimaryShard(ActorSelection primaryShard) { - LOG.debug("Tx {} Primary shard found - trying create transaction", identifier); - - this.primaryShard = primaryShard; - tryCreateTransaction(); - } - - /** - * Adds a TransactionOperation to be executed after the CreateTransaction completes. - */ - void addTxOperationOnComplete(TransactionOperation operation) { - synchronized(txOperationsOnComplete) { - if(transactionContext == null) { - LOG.debug("Tx {} Adding operation on complete {}", identifier); - - txOperationsOnComplete.add(operation); - } else { - operation.invoke(transactionContext); - } - } - } - - /** - * Performs a CreateTransaction try async. - */ - private void tryCreateTransaction() { - Future createTxFuture = sendCreateTransaction(primaryShard, - new CreateTransaction(identifier.toString(), - TransactionProxy.this.transactionType.ordinal(), - getTransactionChainId()).toSerializable()); - - createTxFuture.onComplete(this, actorContext.getActorSystem().dispatcher()); - } - - @Override - public void onComplete(Throwable failure, Object response) { - if(failure instanceof NoShardLeaderException) { - // There's no leader for the shard yet - schedule and try again, unless we're out - // of retries. Note: createTxTries is volatile as it may be written by different - // threads however not concurrently, therefore decrementing it non-atomically here - // is ok. - if(--createTxTries > 0) { - LOG.debug("Tx {} Shard {} has no leader yet - scheduling create Tx retry", - identifier, shardName); - - actorContext.getActorSystem().scheduler().scheduleOnce(CREATE_TX_TRY_INTERVAL, - new Runnable() { - @Override - public void run() { - tryCreateTransaction(); - } - }, actorContext.getActorSystem().dispatcher()); - return; - } - } - - // Create the TransactionContext from the response or failure and execute delayed - // TransactionOperations. This entire section is done atomically (ie synchronized) with - // respect to #addTxOperationOnComplete to handle timing issues and ensure no - // TransactionOperation is missed and that they are processed in the order they occurred. - synchronized(txOperationsOnComplete) { - // Store the new TransactionContext locally until we've completed invoking the - // TransactionOperations. This avoids thread timing issues which could cause - // out-of-order TransactionOperations. Eg, on a modification operation, if the - // TransactionContext is non-null, then we directly call the TransactionContext. - // However, at the same time, the code may be executing the cached - // TransactionOperations. So to avoid thus timing, we don't publish the - // TransactionContext until after we've executed all cached TransactionOperations. - TransactionContext localTransactionContext; - if(failure != null) { - LOG.debug("Tx {} Creating NoOpTransaction because of error: {}", identifier, - failure.getMessage()); - - localTransactionContext = new NoOpTransactionContext(failure, identifier); - } else if (response.getClass().equals(CreateTransactionReply.SERIALIZABLE_CLASS)) { - 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); - } - - for(TransactionOperation oper: txOperationsOnComplete) { - oper.invoke(localTransactionContext); - } - - txOperationsOnComplete.clear(); - - // We're done invoking the TransactionOperations so we can now publish the - // TransactionContext. - transactionContext = localTransactionContext; - } - } - - private TransactionContext createValidTransactionContext(CreateTransactionReply reply) { - String transactionPath = reply.getTransactionPath(); - - LOG.debug("Tx {} Received transaction actor path {}", identifier, transactionPath); - - ActorSelection transactionActor = actorContext.actorSelection(transactionPath); - - if (transactionType == TransactionType.READ_ONLY) { - // Add the actor to the remoteTransactionActors list for access by the - // cleanup PhantonReference. - remoteTransactionActors.add(transactionActor); - - // Write to the memory barrier volatile to publish the above update to the - // remoteTransactionActors list for thread visibility. - remoteTransactionActorsMB.set(true); - } - - // TxActor is always created where the leader of the shard is. - // Check if TxActor is created in the same node - boolean isTxActorLocal = actorContext.isLocalPath(transactionPath); - - return new TransactionContextImpl(transactionPath, transactionActor, identifier, - actorContext, schemaContext, isTxActorLocal, reply.getVersion()); - } - } - - private interface TransactionContext { - void closeTransaction(); - - Future readyTransaction(); - - void writeData(YangInstanceIdentifier path, NormalizedNode data); - - void deleteData(YangInstanceIdentifier path); - - void mergeData(YangInstanceIdentifier path, NormalizedNode data); - - CheckedFuture>, ReadFailedException> readData( - final YangInstanceIdentifier path); - - CheckedFuture dataExists(YangInstanceIdentifier path); - - List> getRecordedOperationFutures(); - } - - private static abstract class AbstractTransactionContext implements TransactionContext { - - protected final TransactionIdentifier identifier; - protected final List> recordedOperationFutures = Lists.newArrayList(); - - AbstractTransactionContext(TransactionIdentifier identifier) { - this.identifier = identifier; - } - - @Override - public List> getRecordedOperationFutures() { - return recordedOperationFutures; - } - } - - private static class TransactionContextImpl extends AbstractTransactionContext { - private final Logger LOG = LoggerFactory.getLogger(TransactionContextImpl.class); - - private final ActorContext actorContext; - private final SchemaContext schemaContext; - private final String transactionPath; - private final ActorSelection actor; - private final boolean isTxActorLocal; - private final int remoteTransactionVersion; - - private TransactionContextImpl(String transactionPath, ActorSelection actor, TransactionIdentifier identifier, - ActorContext actorContext, SchemaContext schemaContext, - boolean isTxActorLocal, int remoteTransactionVersion) { - super(identifier); - this.transactionPath = transactionPath; - this.actor = actor; - this.actorContext = actorContext; - this.schemaContext = schemaContext; - this.isTxActorLocal = isTxActorLocal; - this.remoteTransactionVersion = remoteTransactionVersion; - } - - private ActorSelection getActor() { - return actor; - } - - @Override - public void closeTransaction() { - LOG.debug("Tx {} closeTransaction called", identifier); - - actorContext.sendOperationAsync(getActor(), new CloseTransaction().toSerializable()); - } - - @Override - public Future readyTransaction() { - LOG.debug("Tx {} readyTransaction called with {} previous recorded operations pending", - identifier, recordedOperationFutures.size()); - - // Send the ReadyTransaction message to the Tx actor. - - ReadyTransaction readyTransaction = new ReadyTransaction(); - final Future replyFuture = actorContext.executeOperationAsync(getActor(), - isTxActorLocal ? readyTransaction : readyTransaction.toSerializable()); - - // Combine all the previously recorded put/merge/delete operation reply Futures and the - // ReadyTransactionReply Future into one Future. If any one fails then the combined - // Future will fail. We need all prior operations and the ready operation to succeed - // in order to attempt commit. - - List> futureList = - Lists.newArrayListWithCapacity(recordedOperationFutures.size() + 1); - futureList.addAll(recordedOperationFutures); - futureList.add(replyFuture); - - Future> combinedFutures = akka.dispatch.Futures.sequence(futureList, - actorContext.getActorSystem().dispatcher()); - - // Transform the combined Future into a Future that returns the cohort actor path from - // the ReadyTransactionReply. That's the end result of the ready operation. - - return combinedFutures.transform(new Mapper, ActorSelection>() { - @Override - public ActorSelection checkedApply(Iterable notUsed) { - LOG.debug("Tx {} readyTransaction: pending recorded operations succeeded", - identifier); - - // At this point all the Futures succeeded and we need to extract the cohort - // actor path from the ReadyTransactionReply. For the recorded operations, they - // don't return any data so we're only interested that they completed - // successfully. We could be paranoid and verify the correct reply types but - // that really should never happen so it's not worth the overhead of - // de-serializing each reply. - - // Note the Future get call here won't block as it's complete. - Object serializedReadyReply = replyFuture.value().get().get(); - if (serializedReadyReply instanceof ReadyTransactionReply) { - return actorContext.actorSelection(((ReadyTransactionReply)serializedReadyReply).getCohortPath()); - - } else if(serializedReadyReply.getClass().equals(ReadyTransactionReply.SERIALIZABLE_CLASS)) { - ReadyTransactionReply reply = ReadyTransactionReply.fromSerializable(serializedReadyReply); - String cohortPath = reply.getCohortPath(); - - // In Helium we used to return the local path of the actor which represented - // a remote ThreePhaseCommitCohort. The local path would then be converted to - // a remote path using this resolvePath method. To maintain compatibility with - // a Helium node we need to continue to do this conversion. - // At some point in the future when upgrades from Helium are not supported - // we could remove this code to resolvePath and just use the cohortPath as the - // resolved cohortPath - if(TransactionContextImpl.this.remoteTransactionVersion < CreateTransaction.HELIUM_1_VERSION) { - cohortPath = actorContext.resolvePath(transactionPath, cohortPath); - } - - return actorContext.actorSelection(cohortPath); - - } else { - // Throwing an exception here will fail the Future. - throw new IllegalArgumentException(String.format("Invalid reply type {}", - serializedReadyReply.getClass())); - } - } - }, SAME_FAILURE_TRANSFORMER, actorContext.getActorSystem().dispatcher()); - } - - @Override - public void deleteData(YangInstanceIdentifier path) { - LOG.debug("Tx {} deleteData called path = {}", identifier, path); - - DeleteData deleteData = new DeleteData(path); - recordedOperationFutures.add(actorContext.executeOperationAsync(getActor(), - isTxActorLocal ? deleteData : deleteData.toSerializable())); - } - - @Override - public void mergeData(YangInstanceIdentifier path, NormalizedNode data) { - LOG.debug("Tx {} mergeData called path = {}", identifier, path); - - MergeData mergeData = new MergeData(path, data, schemaContext); - recordedOperationFutures.add(actorContext.executeOperationAsync(getActor(), - isTxActorLocal ? mergeData : mergeData.toSerializable())); - } - - @Override - public void writeData(YangInstanceIdentifier path, NormalizedNode data) { - LOG.debug("Tx {} writeData called path = {}", identifier, path); - - WriteData writeData = new WriteData(path, data, schemaContext); - recordedOperationFutures.add(actorContext.executeOperationAsync(getActor(), - isTxActorLocal ? writeData : writeData.toSerializable())); - } - - @Override - public CheckedFuture>, ReadFailedException> readData( - final YangInstanceIdentifier path) { - - LOG.debug("Tx {} readData called path = {}", identifier, path); - - final SettableFuture>> returnFuture = SettableFuture.create(); - - // If there were any previous recorded put/merge/delete operation reply Futures then we - // must wait for them to successfully complete. This is necessary to honor the read - // uncommitted semantics of the public API contract. If any one fails then fail the read. - - if(recordedOperationFutures.isEmpty()) { - finishReadData(path, returnFuture); - } else { - LOG.debug("Tx {} readData: verifying {} previous recorded operations", - identifier, recordedOperationFutures.size()); - - // Note: we make a copy of recordedOperationFutures to be on the safe side in case - // Futures#sequence accesses the passed List on a different thread, as - // recordedOperationFutures is not synchronized. - - Future> combinedFutures = akka.dispatch.Futures.sequence( - Lists.newArrayList(recordedOperationFutures), - actorContext.getActorSystem().dispatcher()); - - OnComplete> onComplete = new OnComplete>() { - @Override - public void onComplete(Throwable failure, Iterable notUsed) - throws Throwable { - if(failure != null) { - LOG.debug("Tx {} readData: a recorded operation failed: {}", - identifier, failure); - returnFuture.setException(new ReadFailedException( - "The read could not be performed because a previous put, merge," - + "or delete operation failed", failure)); - } else { - finishReadData(path, returnFuture); - } - } - }; - - combinedFutures.onComplete(onComplete, actorContext.getActorSystem().dispatcher()); - } - - return MappingCheckedFuture.create(returnFuture, ReadFailedException.MAPPER); - } - - private void finishReadData(final YangInstanceIdentifier path, - final SettableFuture>> returnFuture) { - - LOG.debug("Tx {} finishReadData called path = {}", identifier, path); - - OnComplete onComplete = new OnComplete() { - @Override - public void onComplete(Throwable failure, Object readResponse) throws Throwable { - if(failure != null) { - LOG.debug("Tx {} read operation failed: {}", identifier, failure); - returnFuture.setException(new ReadFailedException( - "Error reading data for path " + path, failure)); - - } else { - LOG.debug("Tx {} read operation succeeded", identifier, failure); - - if (readResponse instanceof ReadDataReply) { - ReadDataReply reply = (ReadDataReply) readResponse; - returnFuture.set(Optional.>fromNullable(reply.getNormalizedNode())); - - } else if (readResponse.getClass().equals(ReadDataReply.SERIALIZABLE_CLASS)) { - ReadDataReply reply = ReadDataReply.fromSerializable(schemaContext, path, readResponse); - returnFuture.set(Optional.>fromNullable(reply.getNormalizedNode())); - - } else { - returnFuture.setException(new ReadFailedException( - "Invalid response reading data for path " + path)); - } - } - } - }; - - ReadData readData = new ReadData(path); - Future readFuture = actorContext.executeOperationAsync(getActor(), - isTxActorLocal ? readData : readData.toSerializable()); - - readFuture.onComplete(onComplete, actorContext.getActorSystem().dispatcher()); - } - - @Override - public CheckedFuture dataExists( - final YangInstanceIdentifier path) { - - LOG.debug("Tx {} dataExists called path = {}", identifier, path); - - final SettableFuture returnFuture = SettableFuture.create(); - - // If there were any previous recorded put/merge/delete operation reply Futures then we - // must wait for them to successfully complete. This is necessary to honor the read - // uncommitted semantics of the public API contract. If any one fails then fail this - // request. - - if(recordedOperationFutures.isEmpty()) { - finishDataExists(path, returnFuture); - } else { - LOG.debug("Tx {} dataExists: verifying {} previous recorded operations", - identifier, recordedOperationFutures.size()); - - // Note: we make a copy of recordedOperationFutures to be on the safe side in case - // Futures#sequence accesses the passed List on a different thread, as - // recordedOperationFutures is not synchronized. + if (transactionType == TransactionType.READ_ONLY) { + // Read-only Tx's aren't explicitly closed by the client so we create a PhantomReference + // to close the remote Tx's when this instance is no longer in use and is garbage + // collected. - Future> combinedFutures = akka.dispatch.Futures.sequence( - Lists.newArrayList(recordedOperationFutures), - actorContext.getActorSystem().dispatcher()); - OnComplete> onComplete = new OnComplete>() { - @Override - public void onComplete(Throwable failure, Iterable notUsed) - throws Throwable { - if(failure != null) { - LOG.debug("Tx {} dataExists: a recorded operation failed: {}", - identifier, failure); - returnFuture.setException(new ReadFailedException( - "The data exists could not be performed because a previous " - + "put, merge, or delete operation failed", failure)); - } else { - finishDataExists(path, returnFuture); - } - } - }; + if(remoteTransactionActorsMB == null) { + remoteTransactionActors = Lists.newArrayList(); + remoteTransactionActorsMB = new AtomicBoolean(); - combinedFutures.onComplete(onComplete, actorContext.getActorSystem().dispatcher()); + TransactionProxyCleanupPhantomReference.track(TransactionProxy.this); } - return MappingCheckedFuture.create(returnFuture, ReadFailedException.MAPPER); - } - - private void finishDataExists(final YangInstanceIdentifier path, - final SettableFuture returnFuture) { - - LOG.debug("Tx {} finishDataExists called path = {}", identifier, path); - - OnComplete onComplete = new OnComplete() { - @Override - public void onComplete(Throwable failure, Object response) throws Throwable { - if(failure != null) { - LOG.debug("Tx {} dataExists operation failed: {}", identifier, failure); - returnFuture.setException(new ReadFailedException( - "Error checking data exists for path " + path, failure)); - } else { - LOG.debug("Tx {} dataExists operation succeeded", identifier, failure); - - if (response instanceof DataExistsReply) { - returnFuture.set(Boolean.valueOf(((DataExistsReply) response).exists())); - - } else if (response.getClass().equals(DataExistsReply.SERIALIZABLE_CLASS)) { - returnFuture.set(Boolean.valueOf(DataExistsReply.fromSerializable(response).exists())); - - } else { - returnFuture.setException(new ReadFailedException( - "Invalid response checking exists for path " + path)); - } - } - } - }; - - DataExists dataExists = new DataExists(path); - Future future = actorContext.executeOperationAsync(getActor(), - isTxActorLocal ? dataExists : dataExists.toSerializable()); - - future.onComplete(onComplete, actorContext.getActorSystem().dispatcher()); - } - } - - private static class NoOpTransactionContext extends AbstractTransactionContext { - - private final Logger LOG = LoggerFactory.getLogger(NoOpTransactionContext.class); + // Add the actor to the remoteTransactionActors list for access by the + // cleanup PhantonReference. + remoteTransactionActors.add(transactionActor); - private final Throwable failure; - - public NoOpTransactionContext(Throwable failure, TransactionIdentifier identifier){ - super(identifier); - this.failure = failure; - } - - @Override - public void closeTransaction() { - LOG.debug("NoOpTransactionContext {} closeTransaction called", identifier); - } - - @Override - public Future readyTransaction() { - LOG.debug("Tx {} readyTransaction called", identifier); - return akka.dispatch.Futures.failed(failure); - } - - @Override - public void deleteData(YangInstanceIdentifier path) { - LOG.debug("Tx {} deleteData called path = {}", identifier, path); - } - - @Override - public void mergeData(YangInstanceIdentifier path, NormalizedNode data) { - LOG.debug("Tx {} mergeData called path = {}", identifier, path); - } - - @Override - public void writeData(YangInstanceIdentifier path, NormalizedNode data) { - LOG.debug("Tx {} writeData called path = {}", identifier, path); + // Write to the memory barrier volatile to publish the above update to the + // remoteTransactionActors list for thread visibility. + remoteTransactionActorsMB.set(true); } - @Override - public CheckedFuture>, ReadFailedException> readData( - YangInstanceIdentifier path) { - LOG.debug("Tx {} readData called path = {}", identifier, path); - return Futures.immediateFailedCheckedFuture(new ReadFailedException( - "Error reading data for path " + path, failure)); - } + // TxActor is always created where the leader of the shard is. + // Check if TxActor is created in the same node + boolean isTxActorLocal = actorContext.isPathLocal(transactionPath); - @Override - public CheckedFuture dataExists( - YangInstanceIdentifier path) { - LOG.debug("Tx {} dataExists called path = {}", identifier, path); - return Futures.immediateFailedCheckedFuture(new ReadFailedException( - "Error checking exists for path " + path, failure)); + if(remoteTransactionVersion < DataStoreVersions.LITHIUM_VERSION) { + return new PreLithiumTransactionContextImpl(transactionPath, transactionActor, getIdentifier(), + transactionChainId, actorContext, schemaContext, isTxActorLocal, remoteTransactionVersion, + operationCompleter); + } else { + return new TransactionContextImpl(transactionActor, getIdentifier(), transactionChainId, + actorContext, schemaContext, isTxActorLocal, remoteTransactionVersion, operationCompleter); } } }