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=7703f484c73e687391ff5dd9ffe1739afd201c0f;hp=ec198510d3586f88dee40d04f9294a3fb370a9ae;hb=112e6b1bfeed9c7125a073d1015d05e31f006bbf;hpb=b3c034675957f963c5878ce1e5e183ec2de8b5e2 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 ec198510d3..7703f484c7 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 @@ -9,8 +9,8 @@ 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; @@ -18,10 +18,18 @@ 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.SettableFuture; - -import org.opendaylight.controller.cluster.datastore.exceptions.PrimaryNotFoundException; +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; @@ -34,6 +42,7 @@ 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.utils.ActorContext; @@ -46,17 +55,9 @@ import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; import org.opendaylight.yangtools.yang.model.api.SchemaContext; import org.slf4j.Logger; import org.slf4j.LoggerFactory; - -import scala.Function1; import scala.concurrent.Future; -import scala.runtime.AbstractFunction1; - -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.concurrent.ConcurrentHashMap; -import java.util.concurrent.atomic.AtomicBoolean; -import java.util.concurrent.atomic.AtomicLong; +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 @@ -72,18 +73,14 @@ import java.util.concurrent.atomic.AtomicLong; */ public class TransactionProxy implements DOMStoreReadWriteTransaction { - private final TransactionChainProxy transactionChainProxy; - - - - public enum TransactionType { + public static enum TransactionType { READ_ONLY, WRITE_ONLY, READ_WRITE } - static Function1 SAME_FAILURE_TRANSFORMER = new AbstractFunction1< - Throwable, Throwable>() { + static final Mapper SAME_FAILURE_TRANSFORMER = + new Mapper() { @Override public Throwable apply(Throwable failure) { return failure; @@ -92,9 +89,13 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { private static final AtomicLong counter = new AtomicLong(); - private static final Logger - LOG = LoggerFactory.getLogger(TransactionProxy.class); + 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 @@ -173,36 +174,31 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { private List remoteTransactionActors; private AtomicBoolean remoteTransactionActorsMB; - private final Map remoteTransactionPaths = new HashMap<>(); + /** + * Stores the create transaction results per shard. + */ + private final Map txFutureCallbackMap = new HashMap<>(); private final TransactionType transactionType; private final ActorContext actorContext; private final TransactionIdentifier identifier; + private final String transactionChainId; private final SchemaContext schemaContext; private boolean inReadyState; public TransactionProxy(ActorContext actorContext, TransactionType transactionType) { - this(actorContext, transactionType, null); - } - - @VisibleForTesting - List> getRecordedOperationFutures() { - List> recordedOperationFutures = Lists.newArrayList(); - for(TransactionContext transactionContext : remoteTransactionPaths.values()) { - recordedOperationFutures.addAll(transactionContext.getRecordedOperationFutures()); - } - - return recordedOperationFutures; + this(actorContext, transactionType, ""); } - public TransactionProxy(ActorContext actorContext, TransactionType transactionType, TransactionChainProxy transactionChainProxy) { + 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.transactionChainProxy = transactionChainProxy; + this.transactionChainId = transactionChainId; String memberName = actorContext.getCurrentMemberName(); if(memberName == null){ @@ -224,40 +220,71 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { new TransactionProxyCleanupPhantomReference(this); phantomReferenceCache.put(cleanup, cleanup); } - if(LOG.isDebugEnabled()) { - LOG.debug("Created txn {} of type {}", identifier, transactionType); + + LOG.debug("Created txn {} of type {} on chain {}", identifier, 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()); + } } + + return recordedOperationFutures; + } + + @VisibleForTesting + boolean hasTransactionContext() { + for(TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) { + TransactionContext transactionContext = txFutureCallback.getTransactionContext(); + if(transactionContext != null) { + return true; + } + } + + return false; } @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"); - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} read {}", identifier, path); - } - createTransactionIfMissing(actorContext, path); + LOG.debug("Tx {} read {}", identifier, path); - return transactionContext(path).readData(path); + TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); + return txFutureCallback.enqueueReadOperation(new ReadOperation>>() { + @Override + public CheckedFuture>, ReadFailedException> invoke( + TransactionContext transactionContext) { + return transactionContext.readData(path); + } + }); } @Override - public CheckedFuture exists(YangInstanceIdentifier path) { + public CheckedFuture exists(final YangInstanceIdentifier path) { Preconditions.checkState(transactionType != TransactionType.WRITE_ONLY, "Exists operation on write-only transaction is not allowed"); - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} exists {}", identifier, path); - } - createTransactionIfMissing(actorContext, path); + LOG.debug("Tx {} exists {}", identifier, path); - return transactionContext(path).dataExists(path); + TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); + return txFutureCallback.enqueueReadOperation(new ReadOperation() { + @Override + public CheckedFuture invoke(TransactionContext transactionContext) { + return transactionContext.dataExists(path); + } + }); } + private void checkModificationState() { Preconditions.checkState(transactionType != TransactionType.READ_ONLY, "Modification operation on read-only transaction is not allowed"); @@ -266,41 +293,51 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { } @Override - public void write(YangInstanceIdentifier path, NormalizedNode data) { + public void write(final YangInstanceIdentifier path, final NormalizedNode data) { checkModificationState(); - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} write {}", identifier, path); - } - createTransactionIfMissing(actorContext, path); + LOG.debug("Tx {} write {}", identifier, path); - transactionContext(path).writeData(path, data); + TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); + txFutureCallback.enqueueModifyOperation(new TransactionOperation() { + @Override + public void invoke(TransactionContext transactionContext) { + transactionContext.writeData(path, data); + } + }); } @Override - public void merge(YangInstanceIdentifier path, NormalizedNode data) { + public void merge(final YangInstanceIdentifier path, final NormalizedNode data) { checkModificationState(); - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} merge {}", identifier, path); - } - createTransactionIfMissing(actorContext, path); + LOG.debug("Tx {} merge {}", identifier, path); - transactionContext(path).mergeData(path, data); + TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); + txFutureCallback.enqueueModifyOperation(new TransactionOperation() { + @Override + public void invoke(TransactionContext transactionContext) { + transactionContext.mergeData(path, data); + } + }); } @Override - public void delete(YangInstanceIdentifier path) { + public void delete(final YangInstanceIdentifier path) { checkModificationState(); - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} delete {}", identifier, path); - } - createTransactionIfMissing(actorContext, path); - transactionContext(path).deleteData(path); + LOG.debug("Tx {} delete {}", identifier, path); + + TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); + txFutureCallback.enqueueModifyOperation(new TransactionOperation() { + @Override + public void invoke(TransactionContext transactionContext) { + transactionContext.deleteData(path); + } + }); } @Override @@ -310,29 +347,52 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { inReadyState = true; - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} Trying to get {} transactions ready for commit", identifier, - remoteTransactionPaths.size()); - } + LOG.debug("Tx {} Readying {} transactions for commit", identifier, + txFutureCallbackMap.size()); + List> cohortFutures = Lists.newArrayList(); - for(TransactionContext transactionContext : remoteTransactionPaths.values()) { + for(TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} Readying transaction for shard {}", identifier, - transactionContext.getShardName()); - } - cohortFutures.add(transactionContext.readyTransaction()); - } + LOG.debug("Tx {} Readying transaction for shard {} chain {}", identifier, + txFutureCallback.getShardName(), transactionChainId); - if(transactionChainProxy != null){ - transactionChainProxy.onTransactionReady(cohortFutures); + 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) { + } + + /** + * 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; @@ -340,11 +400,16 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { @Override public void close() { - for(TransactionContext transactionContext : remoteTransactionPaths.values()) { - transactionContext.closeTransaction(); + for (TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) { + txFutureCallback.enqueueModifyOperation(new TransactionOperation() { + @Override + public void invoke(TransactionContext transactionContext) { + transactionContext.closeTransaction(); + } + }); } - remoteTransactionPaths.clear(); + txFutureCallbackMap.clear(); if(transactionType == TransactionType.READ_ONLY) { remoteTransactionActors.clear(); @@ -352,90 +417,311 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { } } - private TransactionContext transactionContext(YangInstanceIdentifier path){ + private String shardNameFromIdentifier(YangInstanceIdentifier path){ + return ShardStrategyFactory.getStrategy(path).findShard(path); + } + + private TransactionFutureCallback getOrCreateTxFutureCallback(YangInstanceIdentifier path) { String shardName = shardNameFromIdentifier(path); - return remoteTransactionPaths.get(shardName); + TransactionFutureCallback txFutureCallback = txFutureCallbackMap.get(shardName); + if(txFutureCallback == null) { + Future findPrimaryFuture = actorContext.findPrimaryShardAsync(shardName); + + final TransactionFutureCallback newTxFutureCallback = + new TransactionFutureCallback(shardName); + + txFutureCallback = newTxFutureCallback; + txFutureCallbackMap.put(shardName, txFutureCallback); + + 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()); + } + + return txFutureCallback; } - private String shardNameFromIdentifier(YangInstanceIdentifier path){ - return ShardStrategyFactory.getStrategy(path).findShard(path); + 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); } - private void createTransactionIfMissing(ActorContext actorContext, - YangInstanceIdentifier path) { + /** + * This interface returns a Scala Future + */ + private static interface FutureOperation { + Future 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(); + + /** + * 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; + } - if(transactionChainProxy != null){ - transactionChainProxy.waitTillCurrentTransactionReady(); + TransactionContext getTransactionContext() { + return transactionContext; } - String shardName = ShardStrategyFactory.getStrategy(path).findShard(path); - TransactionContext transactionContext = - remoteTransactionPaths.get(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(); + } + + /** + * 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); + } + } + } + + + 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); + } - if (transactionContext != null) { - // A transaction already exists with that shard - return; + return future; } - try { - Optional primaryShard = actorContext.findPrimaryShard(shardName); - if (!primaryShard.isPresent()) { - throw new PrimaryNotFoundException("Primary could not be found for shard " + shardName); + 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); } + } + - Object response = actorContext.executeOperation(primaryShard.get(), - new CreateTransaction(identifier.toString(), this.transactionType.ordinal(), + + + + /** + * Performs a CreateTransaction try async. + */ + private void tryCreateTransaction() { + Future createTxFuture = sendCreateTransaction(primaryShard, + new CreateTransaction(identifier.toString(), + TransactionProxy.this.transactionType.ordinal(), getTransactionChainId()).toSerializable()); - if (response.getClass().equals(CreateTransactionReply.SERIALIZABLE_CLASS)) { - CreateTransactionReply reply = - CreateTransactionReply.fromSerializable(response); - String transactionPath = reply.getTransactionPath(); + createTxFuture.onComplete(this, actorContext.getActorSystem().dispatcher()); + } - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} Received transaction path = {}", identifier, transactionPath); + @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; } - 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); + // 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); + } - // Write to the memory barrier volatile to publish the above update to the - // remoteTransactionActors list for thread visibility. - remoteTransactionActorsMB.set(true); + for(TransactionOperation oper: txOperationsOnComplete) { + oper.invoke(localTransactionContext); } - transactionContext = new TransactionContextImpl(shardName, transactionPath, - transactionActor, identifier, actorContext, schemaContext); + txOperationsOnComplete.clear(); - remoteTransactionPaths.put(shardName, transactionContext); - } else { - throw new IllegalArgumentException(String.format( - "Invalid reply type {} for CreateTransaction", response.getClass())); - } - } catch (Exception e) { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} Creating NoOpTransaction because of : {}", identifier, e.getMessage()); + // We're done invoking the TransactionOperations so we can now publish the + // TransactionContext. + transactionContext = localTransactionContext; } - remoteTransactionPaths - .put(shardName, new NoOpTransactionContext(shardName, e, identifier)); } - } - public String getTransactionChainId() { - if(transactionChainProxy == null){ - return ""; + 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 transactionChainProxy.getTransactionChainId(); } - private interface TransactionContext { - String getShardName(); - void closeTransaction(); Future readyTransaction(); @@ -457,19 +743,12 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { private static abstract class AbstractTransactionContext implements TransactionContext { protected final TransactionIdentifier identifier; - protected final String shardName; protected final List> recordedOperationFutures = Lists.newArrayList(); - AbstractTransactionContext(String shardName, TransactionIdentifier identifier) { - this.shardName = shardName; + AbstractTransactionContext(TransactionIdentifier identifier) { this.identifier = identifier; } - @Override - public String getShardName() { - return shardName; - } - @Override public List> getRecordedOperationFutures() { return recordedOperationFutures; @@ -481,41 +760,46 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { private final ActorContext actorContext; private final SchemaContext schemaContext; - private final String actorPath; + private final String transactionPath; private final ActorSelection actor; - - private TransactionContextImpl(String shardName, String actorPath, - ActorSelection actor, TransactionIdentifier identifier, ActorContext actorContext, - SchemaContext schemaContext) { - super(shardName, identifier); - this.actorPath = actorPath; + 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() { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} closeTransaction called", identifier); - } + LOG.debug("Tx {} closeTransaction called", identifier); + actorContext.sendOperationAsync(getActor(), new CloseTransaction().toSerializable()); } @Override public Future readyTransaction() { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} readyTransaction called with {} previous recorded operations pending", + LOG.debug("Tx {} readyTransaction called with {} previous recorded operations pending", identifier, recordedOperationFutures.size()); - } + // Send the ReadyTransaction message to the Tx actor. - final Future replyFuture = actorContext.executeOperationAsync(getActor(), - new ReadyTransaction().toSerializable()); + 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 @@ -533,13 +817,12 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { // 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 AbstractFunction1, ActorSelection>() { + return combinedFutures.transform(new Mapper, ActorSelection>() { @Override - public ActorSelection apply(Iterable notUsed) { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} readyTransaction: pending recorded operations succeeded", + 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 @@ -549,15 +832,28 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { // Note the Future get call here won't block as it's complete. Object serializedReadyReply = replyFuture.value().get().get(); - if(serializedReadyReply.getClass().equals( - ReadyTransactionReply.SERIALIZABLE_CLASS)) { - ReadyTransactionReply reply = ReadyTransactionReply.fromSerializable( - serializedReadyReply); + 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); - return actorContext.actorSelection(reply.getCohortPath()); } else { // Throwing an exception here will fail the Future. - throw new IllegalArgumentException(String.format("Invalid reply type {}", serializedReadyReply.getClass())); } @@ -567,38 +863,31 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { @Override public void deleteData(YangInstanceIdentifier path) { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} deleteData called path = {}", identifier, path); - } - recordedOperationFutures.add(actorContext.executeOperationAsync(getActor(), - new DeleteData(path).toSerializable())); + LOG.debug("Tx {} deleteData called path = {}", identifier, path); + + recordedOperationFutures.add(executeOperationAsync(new DeleteData(path))); } @Override public void mergeData(YangInstanceIdentifier path, NormalizedNode data) { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} mergeData called path = {}", identifier, path); - } - recordedOperationFutures.add(actorContext.executeOperationAsync(getActor(), - new MergeData(path, data, schemaContext).toSerializable())); + LOG.debug("Tx {} mergeData called path = {}", identifier, path); + + recordedOperationFutures.add(executeOperationAsync(new MergeData(path, data, schemaContext))); } @Override public void writeData(YangInstanceIdentifier path, NormalizedNode data) { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} writeData called path = {}", identifier, path); - } - recordedOperationFutures.add(actorContext.executeOperationAsync(getActor(), - new WriteData(path, data, schemaContext).toSerializable())); + LOG.debug("Tx {} writeData called path = {}", identifier, path); + + recordedOperationFutures.add(executeOperationAsync(new WriteData(path, data, schemaContext))); } @Override public CheckedFuture>, ReadFailedException> readData( final YangInstanceIdentifier path) { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} readData called path = {}", identifier, 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 @@ -608,10 +897,9 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { if(recordedOperationFutures.isEmpty()) { finishReadData(path, returnFuture); } else { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} readData: verifying {} previous recorded operations", + 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. @@ -619,15 +907,14 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { 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) { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} readData: a recorded operation failed: {}", + 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)); @@ -646,42 +933,37 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { private void finishReadData(final YangInstanceIdentifier path, final SettableFuture>> returnFuture) { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} finishReadData called path = {}", identifier, path); - } + 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) { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} read operation failed: {}", identifier, failure); - } + LOG.debug("Tx {} read operation failed: {}", identifier, failure); returnFuture.setException(new ReadFailedException( "Error reading data for path " + path, failure)); } else { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} read operation succeeded", identifier, failure); - } - if (readResponse.getClass().equals(ReadDataReply.SERIALIZABLE_CLASS)) { - ReadDataReply reply = ReadDataReply.fromSerializable(schemaContext, - path, readResponse); - if (reply.getNormalizedNode() == null) { - returnFuture.set(Optional.>absent()); - } else { - returnFuture.set(Optional.>of( - reply.getNormalizedNode())); - } + 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)); + "Invalid response reading data for path " + path)); } } } }; - Future readFuture = actorContext.executeOperationAsync(getActor(), - new ReadData(path).toSerializable()); + Future readFuture = executeOperationAsync(new ReadData(path)); + readFuture.onComplete(onComplete, actorContext.getActorSystem().dispatcher()); } @@ -689,9 +971,8 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { public CheckedFuture dataExists( final YangInstanceIdentifier path) { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} dataExists called path = {}", identifier, 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 @@ -702,10 +983,9 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { if(recordedOperationFutures.isEmpty()) { finishDataExists(path, returnFuture); } else { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} dataExists: verifying {} previous recorded operations", + 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. @@ -718,10 +998,8 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { public void onComplete(Throwable failure, Iterable notUsed) throws Throwable { if(failure != null) { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} dataExists: a recorded operation failed: {}", + 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)); @@ -740,25 +1018,24 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { private void finishDataExists(final YangInstanceIdentifier path, final SettableFuture returnFuture) { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} finishDataExists called path = {}", identifier, path); - } + 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) { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} dataExists operation failed: {}", identifier, failure); - } + LOG.debug("Tx {} dataExists operation failed: {}", identifier, failure); returnFuture.setException(new ReadFailedException( "Error checking data exists for path " + path, failure)); } else { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} dataExists operation succeeded", identifier, failure); - } - if (response.getClass().equals(DataExistsReply.SERIALIZABLE_CLASS)) { - returnFuture.set(Boolean.valueOf(DataExistsReply. - fromSerializable(response).exists())); + 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)); @@ -767,8 +1044,8 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { } }; - Future future = actorContext.executeOperationAsync(getActor(), - new DataExists(path).toSerializable()); + Future future = executeOperationAsync(new DataExists(path)); + future.onComplete(onComplete, actorContext.getActorSystem().dispatcher()); } } @@ -777,66 +1054,51 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { private final Logger LOG = LoggerFactory.getLogger(NoOpTransactionContext.class); - private final Exception failure; + private final Throwable failure; - public NoOpTransactionContext(String shardName, Exception failure, - TransactionIdentifier identifier){ - super(shardName, identifier); + public NoOpTransactionContext(Throwable failure, TransactionIdentifier identifier){ + super(identifier); this.failure = failure; } @Override public void closeTransaction() { - if(LOG.isDebugEnabled()) { - LOG.debug("NoOpTransactionContext {} closeTransaction called", identifier); - } + LOG.debug("NoOpTransactionContext {} closeTransaction called", identifier); } @Override public Future readyTransaction() { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} readyTransaction called", identifier); - } + LOG.debug("Tx {} readyTransaction called", identifier); return akka.dispatch.Futures.failed(failure); } @Override public void deleteData(YangInstanceIdentifier path) { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} deleteData called path = {}", identifier, path); - } + LOG.debug("Tx {} deleteData called path = {}", identifier, path); } @Override public void mergeData(YangInstanceIdentifier path, NormalizedNode data) { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} mergeData called path = {}", identifier, path); - } + LOG.debug("Tx {} mergeData called path = {}", identifier, path); } @Override public void writeData(YangInstanceIdentifier path, NormalizedNode data) { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} writeData called path = {}", identifier, path); - } + LOG.debug("Tx {} writeData called path = {}", identifier, path); } @Override public CheckedFuture>, ReadFailedException> readData( - YangInstanceIdentifier path) { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} readData called path = {}", identifier, path); - } + YangInstanceIdentifier path) { + LOG.debug("Tx {} readData called path = {}", identifier, path); return Futures.immediateFailedCheckedFuture(new ReadFailedException( "Error reading data for path " + path, failure)); } @Override public CheckedFuture dataExists( - YangInstanceIdentifier path) { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} dataExists called path = {}", identifier, path); - } + YangInstanceIdentifier path) { + LOG.debug("Tx {} dataExists called path = {}", identifier, path); return Futures.immediateFailedCheckedFuture(new ReadFailedException( "Error checking exists for path " + path, failure)); }