X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-distributed-datastore%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fdatastore%2FTransactionProxy.java;h=b0817e06ff27fa4f33109f9ff83a109c6a64d98d;hp=7703f484c73e687391ff5dd9ffe1739afd201c0f;hb=f7da1de9c83827bbb9c13632e5715c2e6720ae21;hpb=112e6b1bfeed9c7125a073d1015d05e31f006bbf 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 7703f484c7..b774fc4787 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 @@ -5,1102 +5,329 @@ * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ - package org.opendaylight.controller.cluster.datastore; 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.Function; import com.google.common.base.Optional; import com.google.common.base.Preconditions; -import com.google.common.collect.Lists; +import com.google.common.base.Supplier; +import com.google.common.collect.Iterables; 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.MoreExecutors; import com.google.common.util.concurrent.SettableFuture; +import java.util.ArrayList; +import java.util.Collection; import java.util.HashMap; import java.util.List; import java.util.Map; -import java.util.concurrent.ConcurrentHashMap; -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.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 java.util.Map.Entry; +import java.util.Set; +import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier; +import org.opendaylight.controller.cluster.datastore.messages.AbstractRead; 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.SerializableMessage; -import org.opendaylight.controller.cluster.datastore.messages.WriteData; -import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategyFactory; +import org.opendaylight.controller.cluster.datastore.modification.AbstractModification; +import org.opendaylight.controller.cluster.datastore.modification.DeleteModification; +import org.opendaylight.controller.cluster.datastore.modification.MergeModification; +import org.opendaylight.controller.cluster.datastore.modification.WriteModification; 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.mdsal.common.api.MappingCheckedFuture; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; -import org.opendaylight.yangtools.yang.model.api.SchemaContext; +import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException; 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 - *

- * Creating a transaction on the consumer side will create one instance of a transaction proxy. If during - * the transaction reads and writes are done on data that belongs to different shards then a separate transaction will - * be created on each of those shards by the TransactionProxy - *

- *

- * The TransactionProxy does not make any guarantees about atomicity or order in which the transactions on the various - * shards will be executed. - *

+ * A transaction potentially spanning multiple backend shards. */ -public class TransactionProxy implements DOMStoreReadWriteTransaction { - - public static enum TransactionType { - READ_ONLY, - WRITE_ONLY, - READ_WRITE +public class TransactionProxy extends AbstractDOMStoreTransaction + implements DOMStoreReadWriteTransaction { + private enum TransactionState { + OPEN, + READY, + CLOSED, } - static final Mapper SAME_FAILURE_TRANSFORMER = - new Mapper() { - @Override - public Throwable apply(Throwable failure) { - return failure; - } - }; - - private static final AtomicLong counter = new AtomicLong(); - 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 - * remoteTransactionActorsMB volatile serves as a memory barrier to publish updates to the - * remoteTransactionActors list so they will be visible to the thread accessing the - * PhantomReference. - */ - private List remoteTransactionActors; - private AtomicBoolean remoteTransactionActorsMB; - - /** - * Stores the create transaction results per shard. - */ - private final Map txFutureCallbackMap = new HashMap<>(); + private final Map txContextWrappers = new HashMap<>(); + private final AbstractTransactionContextFactory txContextFactory; + private final TransactionType type; + private TransactionState state = TransactionState.OPEN; - private final TransactionType transactionType; - private final ActorContext actorContext; - private final TransactionIdentifier identifier; - private final String transactionChainId; - private final SchemaContext schemaContext; - private boolean inReadyState; + @VisibleForTesting + public TransactionProxy(final AbstractTransactionContextFactory txContextFactory, final TransactionType type) { + super(txContextFactory.nextIdentifier(), txContextFactory.getActorContext().getDatastoreContext() + .isTransactionDebugContextEnabled()); + this.txContextFactory = txContextFactory; + this.type = Preconditions.checkNotNull(type); - public TransactionProxy(ActorContext actorContext, TransactionType transactionType) { - this(actorContext, transactionType, ""); + LOG.debug("New {} Tx - {}", type, getIdentifier()); } - public TransactionProxy(ActorContext actorContext, TransactionType transactionType, - String transactionChainId) { - this.actorContext = Preconditions.checkNotNull(actorContext, - "actorContext should not be null"); - this.transactionType = Preconditions.checkNotNull(transactionType, - "transactionType should not be null"); - this.schemaContext = Preconditions.checkNotNull(actorContext.getSchemaContext(), - "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); + @Override + public CheckedFuture exists(final YangInstanceIdentifier path) { + return executeRead(shardNameFromIdentifier(path), new DataExists(path, DataStoreVersions.CURRENT_VERSION)); } - @VisibleForTesting - List> getRecordedOperationFutures() { - List> recordedOperationFutures = Lists.newArrayList(); - for(TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) { - TransactionContext transactionContext = txFutureCallback.getTransactionContext(); - if(transactionContext != null) { - recordedOperationFutures.addAll(transactionContext.getRecordedOperationFutures()); - } - } + private CheckedFuture executeRead(final String shardName, + final AbstractRead readCmd) { + Preconditions.checkState(type != TransactionType.WRITE_ONLY, + "Reads from write-only transactions are not allowed"); - return recordedOperationFutures; - } + LOG.trace("Tx {} {} {}", getIdentifier(), readCmd.getClass().getSimpleName(), readCmd.getPath()); - @VisibleForTesting - boolean hasTransactionContext() { - for(TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) { - TransactionContext transactionContext = txFutureCallback.getTransactionContext(); - if(transactionContext != null) { - return true; + final SettableFuture proxyFuture = SettableFuture.create(); + TransactionContextWrapper contextWrapper = getContextWrapper(shardName); + contextWrapper.maybeExecuteTransactionOperation(new TransactionOperation() { + @Override + public void invoke(final TransactionContext transactionContext) { + transactionContext.executeRead(readCmd, proxyFuture); } - } + }); - return false; + return MappingCheckedFuture.create(proxyFuture, ReadFailedException.MAPPER); } @Override public CheckedFuture>, ReadFailedException> read(final YangInstanceIdentifier path) { + Preconditions.checkState(type != TransactionType.WRITE_ONLY, + "Reads from write-only transactions are not allowed"); - Preconditions.checkState(transactionType != TransactionType.WRITE_ONLY, - "Read operation on write-only transaction is not allowed"); - - LOG.debug("Tx {} read {}", identifier, path); + LOG.trace("Tx {} read {}", getIdentifier(), path); - TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); - return txFutureCallback.enqueueReadOperation(new ReadOperation>>() { - @Override - public CheckedFuture>, ReadFailedException> invoke( - TransactionContext transactionContext) { - return transactionContext.readData(path); - } - }); + if (YangInstanceIdentifier.EMPTY.equals(path)) { + return readAllData(); + } else { + return singleShardRead(shardNameFromIdentifier(path), path); + } } - @Override - public CheckedFuture exists(final YangInstanceIdentifier path) { + private CheckedFuture>, ReadFailedException> singleShardRead( + final String shardName, final YangInstanceIdentifier path) { + return executeRead(shardName, new ReadData(path, DataStoreVersions.CURRENT_VERSION)); + } - Preconditions.checkState(transactionType != TransactionType.WRITE_ONLY, - "Exists operation on write-only transaction is not allowed"); + private CheckedFuture>, ReadFailedException> readAllData() { + final Set allShardNames = txContextFactory.getActorContext().getConfiguration().getAllShardNames(); + final Collection>, ReadFailedException>> futures = + new ArrayList<>(allShardNames.size()); - LOG.debug("Tx {} exists {}", identifier, path); + for (String shardName : allShardNames) { + futures.add(singleShardRead(shardName, YangInstanceIdentifier.EMPTY)); + } - TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); - return txFutureCallback.enqueueReadOperation(new ReadOperation() { - @Override - public CheckedFuture invoke(TransactionContext transactionContext) { - return transactionContext.dataExists(path); - } - }); - } + final ListenableFuture>>> listFuture = Futures.allAsList(futures); + final ListenableFuture>> aggregateFuture; + aggregateFuture = Futures.transform(listFuture, + (Function>>, Optional>>) input -> { + try { + return NormalizedNodeAggregator.aggregate(YangInstanceIdentifier.EMPTY, input, + txContextFactory.getActorContext().getSchemaContext(), + txContextFactory.getActorContext().getDatastoreContext().getLogicalStoreType()); + } catch (DataValidationFailedException e) { + throw new IllegalArgumentException("Failed to aggregate", e); + } + }, MoreExecutors.directExecutor()); - private void checkModificationState() { - Preconditions.checkState(transactionType != TransactionType.READ_ONLY, - "Modification operation on read-only transaction is not allowed"); - Preconditions.checkState(!inReadyState, - "Transaction is sealed - further modifications are not allowed"); + return MappingCheckedFuture.create(aggregateFuture, ReadFailedException.MAPPER); } @Override - public void write(final YangInstanceIdentifier path, final NormalizedNode data) { - - checkModificationState(); - - LOG.debug("Tx {} write {}", identifier, path); - - TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); - txFutureCallback.enqueueModifyOperation(new TransactionOperation() { - @Override - public void invoke(TransactionContext transactionContext) { - transactionContext.writeData(path, data); - } - }); + public void delete(final YangInstanceIdentifier path) { + executeModification(new DeleteModification(path)); } @Override public void merge(final YangInstanceIdentifier path, final NormalizedNode data) { - - checkModificationState(); - - LOG.debug("Tx {} merge {}", identifier, path); - - TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); - txFutureCallback.enqueueModifyOperation(new TransactionOperation() { - @Override - public void invoke(TransactionContext transactionContext) { - transactionContext.mergeData(path, data); - } - }); + executeModification(new MergeModification(path, data)); } @Override - public void delete(final YangInstanceIdentifier path) { + public void write(final YangInstanceIdentifier path, final NormalizedNode data) { + executeModification(new WriteModification(path, data)); + } + private void executeModification(final AbstractModification modification) { checkModificationState(); - LOG.debug("Tx {} delete {}", identifier, path); + LOG.trace("Tx {} executeModification {} {}", getIdentifier(), modification.getClass().getSimpleName(), + modification.getPath()); - TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); - txFutureCallback.enqueueModifyOperation(new TransactionOperation() { + TransactionContextWrapper contextWrapper = getContextWrapper(modification.getPath()); + contextWrapper.maybeExecuteTransactionOperation(new TransactionOperation() { @Override - public void invoke(TransactionContext transactionContext) { - transactionContext.deleteData(path); + protected void invoke(final TransactionContext transactionContext) { + transactionContext.executeModification(modification); } }); } - @Override - public DOMStoreThreePhaseCommitCohort ready() { - - checkModificationState(); - - inReadyState = true; - - LOG.debug("Tx {} Readying {} transactions for commit", identifier, - txFutureCallbackMap.size()); - - List> cohortFutures = Lists.newArrayList(); - - for(TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) { - - LOG.debug("Tx {} Readying transaction for shard {} chain {}", identifier, - txFutureCallback.getShardName(), transactionChainId); - - Future future = txFutureCallback.enqueueFutureOperation(new FutureOperation() { - @Override - public Future invoke(TransactionContext transactionContext) { - return transactionContext.readyTransaction(); - } - }); - - cohortFutures.add(future); - } - - onTransactionReady(cohortFutures); - - 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) { + private void checkModificationState() { + Preconditions.checkState(type != TransactionType.READ_ONLY, + "Modification operation on read-only transaction is not allowed"); + Preconditions.checkState(state == TransactionState.OPEN, + "Transaction is sealed - further modifications are not allowed"); } - /** - * 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); + private boolean seal(final TransactionState newState) { + if (state == TransactionState.OPEN) { + state = newState; + return true; + } else { + return false; + } } @Override - public Object getIdentifier() { - return this.identifier; - } + public final void close() { + if (!seal(TransactionState.CLOSED)) { + Preconditions.checkState(state == TransactionState.CLOSED, "Transaction %s is ready, it cannot be closed", + getIdentifier()); + // Idempotent no-op as per AutoCloseable recommendation + return; + } - @Override - public void close() { - for (TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) { - txFutureCallback.enqueueModifyOperation(new TransactionOperation() { + for (TransactionContextWrapper contextWrapper : txContextWrappers.values()) { + contextWrapper.maybeExecuteTransactionOperation(new TransactionOperation() { @Override - public void invoke(TransactionContext transactionContext) { + public void invoke(final TransactionContext transactionContext) { transactionContext.closeTransaction(); } }); } - txFutureCallbackMap.clear(); - if(transactionType == TransactionType.READ_ONLY) { - remoteTransactionActors.clear(); - remoteTransactionActorsMB.set(true); - } + txContextWrappers.clear(); } - private String shardNameFromIdentifier(YangInstanceIdentifier path){ - return ShardStrategyFactory.getStrategy(path).findShard(path); - } - - private TransactionFutureCallback getOrCreateTxFutureCallback(YangInstanceIdentifier path) { - String shardName = shardNameFromIdentifier(path); - TransactionFutureCallback txFutureCallback = txFutureCallbackMap.get(shardName); - if(txFutureCallback == null) { - Future findPrimaryFuture = actorContext.findPrimaryShardAsync(shardName); + @Override + public final AbstractThreePhaseCommitCohort ready() { + Preconditions.checkState(type != TransactionType.READ_ONLY, "Read-only transactions cannot be readied"); - final TransactionFutureCallback newTxFutureCallback = - new TransactionFutureCallback(shardName); + final boolean success = seal(TransactionState.READY); + Preconditions.checkState(success, "Transaction %s is %s, it cannot be readied", getIdentifier(), state); - txFutureCallback = newTxFutureCallback; - txFutureCallbackMap.put(shardName, txFutureCallback); + LOG.debug("Tx {} Readying {} components for commit", getIdentifier(), txContextWrappers.size()); - findPrimaryFuture.onComplete(new OnComplete() { - @Override - public void onComplete(Throwable failure, ActorSelection primaryShard) { - if(failure != null) { - newTxFutureCallback.onComplete(failure, null); - } else { - newTxFutureCallback.setPrimaryShard(primaryShard); - } - } - }, actorContext.getActorSystem().dispatcher()); + final AbstractThreePhaseCommitCohort ret; + switch (txContextWrappers.size()) { + case 0: + ret = NoOpDOMStoreThreePhaseCommitCohort.INSTANCE; + break; + case 1: + final Entry e = Iterables.getOnlyElement( + txContextWrappers.entrySet()); + ret = createSingleCommitCohort(e.getKey(), e.getValue()); + break; + default: + ret = createMultiCommitCohort(txContextWrappers.entrySet()); } - return txFutureCallback; - } - - public String getTransactionChainId() { - return transactionChainId; - } - - protected ActorContext getActorContext() { - return actorContext; - } - - /** - * Interfaces for transaction operations to be invoked later. - */ - private static interface TransactionOperation { - void invoke(TransactionContext transactionContext); - } - - /** - * This interface returns a Guava Future - */ - private static interface ReadOperation { - CheckedFuture invoke(TransactionContext transactionContext); - } + txContextFactory.onTransactionReady(getIdentifier(), ret.getCohortFutures()); - /** - * This interface returns a Scala Future - */ - private static interface FutureOperation { - Future invoke(TransactionContext transactionContext); + final Throwable debugContext = getDebugContext(); + return debugContext == null ? ret : new DebugThreePhaseCommitCohort(getIdentifier(), ret, debugContext); } - /** - * 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(); - - /** - * 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; - } + @SuppressWarnings({ "rawtypes", "unchecked" }) + private AbstractThreePhaseCommitCohort createSingleCommitCohort(final String shardName, + final TransactionContextWrapper contextWrapper) { + LOG.debug("Tx {} Readying transaction for shard {}", getIdentifier(), shardName); - /** - * 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(); - } + final OperationCallback.Reference operationCallbackRef = + new OperationCallback.Reference(OperationCallback.NO_OP_CALLBACK); - /** - * 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); + final TransactionContext transactionContext = contextWrapper.getTransactionContext(); + final Future future; + if (transactionContext == null) { + final Promise promise = akka.dispatch.Futures.promise(); + contextWrapper.maybeExecuteTransactionOperation(new TransactionOperation() { + @Override + public void invoke(final TransactionContext newTransactionContext) { + promise.completeWith(getDirectCommitFuture(newTransactionContext, operationCallbackRef)); } - } - } - - - Future enqueueFutureOperation(final FutureOperation op) { - - Future future; - - if (transactionContext != null) { - future = op.invoke(transactionContext); - } 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 Promise promise = akka.dispatch.Futures.promise(); - addTxOperationOnComplete(new TransactionOperation() { - @Override - public void invoke(TransactionContext transactionContext) { - promise.completeWith(op.invoke(transactionContext)); - } - }); - - future = promise.future(); - } - - return future; - } - - CheckedFuture enqueueReadOperation(final ReadOperation op) { - - CheckedFuture future; - - if (transactionContext != null) { - future = op.invoke(transactionContext); - } 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(); - addTxOperationOnComplete(new TransactionOperation() { - @Override - public void invoke(TransactionContext transactionContext) { - Futures.addCallback(op.invoke(transactionContext), new FutureCallback() { - @Override - public void onSuccess(T data) { - proxyFuture.set(data); - } - - @Override - public void onFailure(Throwable t) { - proxyFuture.setException(t); - } - }); - } - }); - - future = MappingCheckedFuture.create(proxyFuture, ReadFailedException.MAPPER); - } - - return future; - } - - void enqueueModifyOperation(final TransactionOperation op) { - - if (transactionContext != null) { - op.invoke(transactionContext); - } 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. - addTxOperationOnComplete(op); - } - } - - - - - - /** - * 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()); + }); + future = promise.future(); + } else { + // avoid the creation of a promise and a TransactionOperation + future = getDirectCommitFuture(transactionContext, operationCallbackRef); } - @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); + return new SingleCommitCohortProxy(txContextFactory.getActorContext(), future, getIdentifier(), + operationCallbackRef); + } - actorContext.getActorSystem().scheduler().scheduleOnce(CREATE_TX_TRY_INTERVAL, - new Runnable() { - @Override - public void run() { - tryCreateTransaction(); - } - }, actorContext.getActorSystem().dispatcher()); - return; - } - } + private Future getDirectCommitFuture(final TransactionContext transactionContext, + final OperationCallback.Reference operationCallbackRef) { + TransactionRateLimitingCallback rateLimitingCallback = new TransactionRateLimitingCallback( + txContextFactory.getActorContext()); + operationCallbackRef.set(rateLimitingCallback); + rateLimitingCallback.run(); + return transactionContext.directCommit(); + } - // 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()); + private AbstractThreePhaseCommitCohort createMultiCommitCohort( + final Set> txContextWrapperEntries) { - 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())); + final List cohorts = new ArrayList<>(txContextWrapperEntries.size()); + for (Entry e : txContextWrapperEntries) { + LOG.debug("Tx {} Readying transaction for shard {}", getIdentifier(), e.getKey()); - localTransactionContext = new NoOpTransactionContext(exception, identifier); - } + final TransactionContextWrapper wrapper = e.getValue(); - for(TransactionOperation oper: txOperationsOnComplete) { - oper.invoke(localTransactionContext); - } - - txOperationsOnComplete.clear(); + // The remote tx version is obtained the via TransactionContext which may not be available yet so + // we pass a Supplier to dynamically obtain it. Once the ready Future is resolved the + // TransactionContext is available. + Supplier txVersionSupplier = () -> wrapper.getTransactionContext().getTransactionVersion(); - // We're done invoking the TransactionOperations so we can now publish the - // TransactionContext. - transactionContext = localTransactionContext; - } + cohorts.add(new ThreePhaseCommitCohortProxy.CohortInfo(wrapper.readyTransaction(), txVersionSupplier)); } - 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.isPathLocal(transactionPath); - - return new TransactionContextImpl(transactionPath, transactionActor, identifier, - actorContext, schemaContext, isTxActorLocal, reply.getVersion()); - } + return new ThreePhaseCommitCohortProxy(txContextFactory.getActorContext(), cohorts, getIdentifier()); } - 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 String shardNameFromIdentifier(final YangInstanceIdentifier path) { + return txContextFactory.getActorContext().getShardStrategyFactory().getStrategy(path).findShard(path); } - 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 TransactionContextWrapper getContextWrapper(final YangInstanceIdentifier path) { + return getContextWrapper(shardNameFromIdentifier(path)); } - 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; - } - - private Future executeOperationAsync(SerializableMessage msg) { - return actorContext.executeOperationAsync(getActor(), isTxActorLocal ? msg : msg.toSerializable()); - } - - @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. - - final Future replyFuture = executeOperationAsync(new ReadyTransaction()); - - // 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); - - recordedOperationFutures.add(executeOperationAsync(new DeleteData(path))); - } - - @Override - public void mergeData(YangInstanceIdentifier path, NormalizedNode data) { - LOG.debug("Tx {} mergeData called path = {}", identifier, path); - - recordedOperationFutures.add(executeOperationAsync(new MergeData(path, data, schemaContext))); - } - - @Override - public void writeData(YangInstanceIdentifier path, NormalizedNode data) { - LOG.debug("Tx {} writeData called path = {}", identifier, path); - - recordedOperationFutures.add(executeOperationAsync(new WriteData(path, data, schemaContext))); - } - - @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)); - } - } - } - }; - - Future readFuture = executeOperationAsync(new ReadData(path)); - - 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. - - 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); - } - } - }; - - combinedFutures.onComplete(onComplete, actorContext.getActorSystem().dispatcher()); - } - - return MappingCheckedFuture.create(returnFuture, ReadFailedException.MAPPER); + private TransactionContextWrapper getContextWrapper(final String shardName) { + final TransactionContextWrapper existing = txContextWrappers.get(shardName); + if (existing != null) { + return existing; } - 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)); - } - } - } - }; - - Future future = executeOperationAsync(new DataExists(path)); - - future.onComplete(onComplete, actorContext.getActorSystem().dispatcher()); - } + final TransactionContextWrapper fresh = txContextFactory.newTransactionContextWrapper(this, shardName); + txContextWrappers.put(shardName, fresh); + return fresh; } - private static class NoOpTransactionContext extends AbstractTransactionContext { - - private final Logger LOG = LoggerFactory.getLogger(NoOpTransactionContext.class); - - 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); - } + TransactionType getType() { + return type; + } - @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)); - } + boolean isReady() { + return state != TransactionState.OPEN; + } - @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)); - } + ActorContext getActorContext() { + return txContextFactory.getActorContext(); } }