X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-distributed-datastore%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fdatastore%2FTransactionProxy.java;h=40880d907580bbaec6a81756d07b3b8b37210ade;hb=2ce392e287211179691e9ad9c738a6776effacd8;hp=5b5b1296af08e42c2278b6db80ac05cbf08329c6;hpb=aa83d1e4b013eecde3c79b00cca538bd4763c2d4;p=controller.git diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionProxy.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionProxy.java index 5b5b1296af..40880d9075 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 @@ -8,18 +8,28 @@ package org.opendaylight.controller.cluster.datastore; -import akka.actor.ActorPath; -import akka.actor.ActorRef; import akka.actor.ActorSelection; -import akka.actor.Props; +import akka.dispatch.Mapper; import akka.dispatch.OnComplete; - +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.FinalizablePhantomReference; +import com.google.common.base.FinalizableReferenceQueue; import com.google.common.base.Optional; import com.google.common.base.Preconditions; +import com.google.common.collect.Lists; import com.google.common.util.concurrent.CheckedFuture; +import com.google.common.util.concurrent.FutureCallback; import com.google.common.util.concurrent.Futures; import com.google.common.util.concurrent.SettableFuture; - +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; @@ -44,14 +54,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.concurrent.Future; - -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -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 @@ -66,30 +71,133 @@ import java.util.concurrent.atomic.AtomicLong; *

*/ public class TransactionProxy implements DOMStoreReadWriteTransaction { - public enum TransactionType { + + public static enum TransactionType { READ_ONLY, WRITE_ONLY, READ_WRITE } + 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); + 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 TransactionType transactionType; private final ActorContext actorContext; - private final Map remoteTransactionPaths = new HashMap<>(); private final TransactionIdentifier identifier; + private final String transactionChainId; private final SchemaContext schemaContext; private boolean inReadyState; + public TransactionProxy(ActorContext actorContext, TransactionType transactionType) { + this(actorContext, transactionType, ""); + } + public TransactionProxy(ActorContext actorContext, TransactionType transactionType, - SchemaContext schemaContext) { - this.actorContext = Preconditions.checkNotNull(actorContext, "actorContext should not be null"); - this.transactionType = Preconditions.checkNotNull(transactionType, "transactionType should not be null"); - this.schemaContext = Preconditions.checkNotNull(schemaContext, "schemaContext should not be null"); + 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){ @@ -97,10 +205,35 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { } this.identifier = TransactionIdentifier.builder().memberName(memberName).counter( - counter.getAndIncrement()).build(); + 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(); - LOG.debug("Created txn {}", identifier); + TransactionProxyCleanupPhantomReference cleanup = + new TransactionProxyCleanupPhantomReference(this); + phantomReferenceCache.put(cleanup, cleanup); + } + + LOG.debug("Created txn {} of type {}", identifier, transactionType); + } + + @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; } @Override @@ -110,67 +243,158 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { Preconditions.checkState(transactionType != TransactionType.WRITE_ONLY, "Read operation on write-only transaction is not allowed"); - LOG.debug("txn {} read {}", identifier, path); + LOG.debug("Tx {} read {}", identifier, path); - createTransactionIfMissing(actorContext, path); + TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); + TransactionContext transactionContext = txFutureCallback.getTransactionContext(); - return transactionContext(path).readData(path); + CheckedFuture>, ReadFailedException> future; + if(transactionContext != null) { + future = transactionContext.readData(path); + } else { + // The shard Tx hasn't been created yet so add the Tx operation to the Tx Future + // callback to be executed after the Tx is created. + final SettableFuture>> proxyFuture = SettableFuture.create(); + txFutureCallback.addTxOperationOnComplete(new TransactionOperation() { + @Override + public void invoke(TransactionContext transactionContext) { + Futures.addCallback(transactionContext.readData(path), + new FutureCallback>>() { + @Override + public void onSuccess(Optional> data) { + proxyFuture.set(data); + } + + @Override + public void onFailure(Throwable t) { + proxyFuture.setException(t); + } + }); + } + }); + + future = MappingCheckedFuture.create(proxyFuture, ReadFailedException.MAPPER); + } + + return future; } @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"); - LOG.debug("txn {} exists {}", identifier, path); + LOG.debug("Tx {} exists {}", identifier, path); + + TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); + TransactionContext transactionContext = txFutureCallback.getTransactionContext(); - createTransactionIfMissing(actorContext, path); + CheckedFuture future; + if(transactionContext != null) { + future = transactionContext.dataExists(path); + } else { + // The shard Tx hasn't been created yet so add the Tx operation to the Tx Future + // callback to be executed after the Tx is created. + final SettableFuture proxyFuture = SettableFuture.create(); + txFutureCallback.addTxOperationOnComplete(new TransactionOperation() { + @Override + public void invoke(TransactionContext transactionContext) { + Futures.addCallback(transactionContext.dataExists(path), + new FutureCallback() { + @Override + public void onSuccess(Boolean exists) { + proxyFuture.set(exists); + } + + @Override + public void onFailure(Throwable t) { + proxyFuture.setException(t); + } + }); + } + }); + + future = MappingCheckedFuture.create(proxyFuture, ReadFailedException.MAPPER); + } - return transactionContext(path).dataExists(path); + return future; } 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 allowed"); + "Transaction is sealed - further modifications are not allowed"); } @Override - public void write(YangInstanceIdentifier path, NormalizedNode data) { + public void write(final YangInstanceIdentifier path, final NormalizedNode data) { checkModificationState(); - LOG.debug("txn {} write {}", identifier, path); - - createTransactionIfMissing(actorContext, path); + LOG.debug("Tx {} write {}", identifier, path); - transactionContext(path).writeData(path, data); + TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); + TransactionContext transactionContext = txFutureCallback.getTransactionContext(); + if(transactionContext != null) { + transactionContext.writeData(path, data); + } else { + // The shard Tx hasn't been created yet so add the Tx operation to the Tx Future + // callback to be executed after the Tx is created. + txFutureCallback.addTxOperationOnComplete(new TransactionOperation() { + @Override + public void invoke(TransactionContext transactionContext) { + transactionContext.writeData(path, data); + } + }); + } } @Override - public void merge(YangInstanceIdentifier path, NormalizedNode data) { + public void merge(final YangInstanceIdentifier path, final NormalizedNode data) { checkModificationState(); - LOG.debug("txn {} merge {}", identifier, path); - - createTransactionIfMissing(actorContext, path); + LOG.debug("Tx {} merge {}", identifier, path); - transactionContext(path).mergeData(path, data); + TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); + TransactionContext transactionContext = txFutureCallback.getTransactionContext(); + if(transactionContext != null) { + transactionContext.mergeData(path, data); + } else { + // The shard Tx hasn't been created yet so add the Tx operation to the Tx Future + // callback to be executed after the Tx is created. + txFutureCallback.addTxOperationOnComplete(new TransactionOperation() { + @Override + public void invoke(TransactionContext transactionContext) { + transactionContext.mergeData(path, data); + } + }); + } } @Override - public void delete(YangInstanceIdentifier path) { + public void delete(final YangInstanceIdentifier path) { checkModificationState(); - LOG.debug("txn {} delete {}", identifier, path); + LOG.debug("Tx {} delete {}", identifier, path); - createTransactionIfMissing(actorContext, path); - - transactionContext(path).deleteData(path); + TransactionFutureCallback txFutureCallback = getOrCreateTxFutureCallback(path); + TransactionContext transactionContext = txFutureCallback.getTransactionContext(); + if(transactionContext != null) { + transactionContext.deleteData(path); + } else { + // The shard Tx hasn't been created yet so add the Tx operation to the Tx Future + // callback to be executed after the Tx is created. + txFutureCallback.addTxOperationOnComplete(new TransactionOperation() { + @Override + public void invoke(TransactionContext transactionContext) { + transactionContext.deleteData(path); + } + }); + } } @Override @@ -180,31 +404,58 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { inReadyState = true; - List cohortPaths = new ArrayList<>(); + LOG.debug("Tx {} Readying {} transactions for commit", identifier, + txFutureCallbackMap.size()); - LOG.debug("txn {} Trying to get {} transactions ready for commit", identifier, - remoteTransactionPaths.size()); + List> cohortFutures = Lists.newArrayList(); - for(TransactionContext transactionContext : remoteTransactionPaths.values()) { + for(TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) { - LOG.debug("txn {} Readying transaction for shard {}", identifier, - transactionContext.getShardName()); + LOG.debug("Tx {} Readying transaction for shard {}", identifier, + txFutureCallback.getShardName()); - Object result = transactionContext.readyTransaction(); - - if(result.getClass().equals(ReadyTransactionReply.SERIALIZABLE_CLASS)){ - ReadyTransactionReply reply = ReadyTransactionReply.fromSerializable( - actorContext.getActorSystem(),result); - String resolvedCohortPath = transactionContext.getResolvedCohortPath( - reply.getCohortPath().toString()); - cohortPaths.add(actorContext.actorFor(resolvedCohortPath)); + TransactionContext transactionContext = txFutureCallback.getTransactionContext(); + if(transactionContext != null) { + cohortFutures.add(transactionContext.readyTransaction()); } else { - LOG.error("Was expecting {} but got {}", ReadyTransactionReply.SERIALIZABLE_CLASS, - result.getClass()); + // The shard Tx hasn't been created yet so create a promise to ready the Tx later + // after it's created. + final Promise cohortPromise = akka.dispatch.Futures.promise(); + txFutureCallback.addTxOperationOnComplete(new TransactionOperation() { + @Override + public void invoke(TransactionContext transactionContext) { + cohortPromise.completeWith(transactionContext.readyTransaction()); + } + }); + + cohortFutures.add(cohortPromise.future()); } } - return new ThreePhaseCommitCohortProxy(actorContext, cohortPaths, identifier.toString()); + 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 @@ -214,68 +465,235 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { @Override public void close() { - for(TransactionContext transactionContext : remoteTransactionPaths.values()) { - transactionContext.closeTransaction(); + for(TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) { + TransactionContext transactionContext = txFutureCallback.getTransactionContext(); + if(transactionContext != null) { + transactionContext.closeTransaction(); + } else { + txFutureCallback.addTxOperationOnComplete(new TransactionOperation() { + @Override + public void invoke(TransactionContext transactionContext) { + transactionContext.closeTransaction(); + } + }); + } } - } - private TransactionContext transactionContext(YangInstanceIdentifier path){ - String shardName = shardNameFromIdentifier(path); - return remoteTransactionPaths.get(shardName); + txFutureCallbackMap.clear(); + + if(transactionType == TransactionType.READ_ONLY) { + remoteTransactionActors.clear(); + remoteTransactionActorsMB.set(true); + } } private String shardNameFromIdentifier(YangInstanceIdentifier path){ return ShardStrategyFactory.getStrategy(path).findShard(path); } - private void createTransactionIfMissing(ActorContext actorContext, YangInstanceIdentifier path) { - String shardName = 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); + + final TransactionFutureCallback newTxFutureCallback = + new TransactionFutureCallback(shardName); - TransactionContext transactionContext = - remoteTransactionPaths.get(shardName); + txFutureCallback = newTxFutureCallback; + txFutureCallbackMap.put(shardName, txFutureCallback); - if(transactionContext != null){ - // A transaction already exists with that shard - return; + 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()); } - try { - Object response = actorContext.executeShardOperation(shardName, - new CreateTransaction(identifier.toString(),this.transactionType.ordinal() ).toSerializable(), - ActorContext.ASK_DURATION); - if (response.getClass().equals(CreateTransactionReply.SERIALIZABLE_CLASS)) { - CreateTransactionReply reply = - CreateTransactionReply.fromSerializable(response); + return txFutureCallback; + } - String transactionPath = reply.getTransactionPath(); + public String getTransactionChainId() { + return transactionChainId; + } - LOG.debug("txn {} Received transaction path = {}", identifier, transactionPath); + /** + * Interface for a transaction operation to be invoked later. + */ + private static interface TransactionOperation { + void invoke(TransactionContext transactionContext); + } - ActorSelection transactionActor = - actorContext.actorSelection(transactionPath); - transactionContext = - new TransactionContextImpl(shardName, transactionPath, - transactionActor); + /** + * 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()); - remoteTransactionPaths.put(shardName, transactionContext); - } else { - LOG.error("Was expecting {} but got {}", CreateTransactionReply.SERIALIZABLE_CLASS, - response.getClass()); + private final String shardName; + + TransactionFutureCallback(String shardName) { + this.shardName = shardName; + } + + String getShardName() { + return shardName; + } + + TransactionContext getTransactionContext() { + return transactionContext; + } + + + /** + * Sets the target primary shard and initiates a CreateTransaction try. + */ + void setPrimaryShard(ActorSelection primaryShard) { + LOG.debug("Tx {} Primary shard found - trying create transaction", identifier); + + this.primaryShard = primaryShard; + tryCreateTransaction(); + } + + /** + * Adds a TransactionOperation to be executed after the CreateTransaction completes. + */ + void addTxOperationOnComplete(TransactionOperation operation) { + synchronized(txOperationsOnComplete) { + if(transactionContext == null) { + LOG.debug("Tx {} Adding operation on complete {}", identifier); + + txOperationsOnComplete.add(operation); + } else { + operation.invoke(transactionContext); + } } - } catch(Exception e){ - LOG.error("txn {} Creating NoOpTransaction because of : {}", identifier, e.getMessage()); - remoteTransactionPaths.put(shardName, new NoOpTransactionContext(shardName, e)); + } + + /** + * Performs a CreateTransaction try async. + */ + private void tryCreateTransaction() { + Future createTxFuture = sendCreateTransaction(primaryShard, + new CreateTransaction(identifier.toString(), + TransactionProxy.this.transactionType.ordinal(), + getTransactionChainId()).toSerializable()); + + createTxFuture.onComplete(this, actorContext.getActorSystem().dispatcher()); + } + + @Override + public void onComplete(Throwable failure, Object response) { + if(failure instanceof NoShardLeaderException) { + // There's no leader for the shard yet - schedule and try again, unless we're out + // of retries. Note: createTxTries is volatile as it may be written by different + // threads however not concurrently, therefore decrementing it non-atomically here + // is ok. + if(--createTxTries > 0) { + LOG.debug("Tx {} Shard {} has no leader yet - scheduling create Tx retry", + identifier, shardName); + + actorContext.getActorSystem().scheduler().scheduleOnce(CREATE_TX_TRY_INTERVAL, + new Runnable() { + @Override + public void run() { + tryCreateTransaction(); + } + }, actorContext.getActorSystem().dispatcher()); + return; + } + } + + // Create the TransactionContext from the response or failure and execute delayed + // TransactionOperations. This entire section is done atomically (ie synchronized) with + // respect to #addTxOperationOnComplete to handle timing issues and ensure no + // TransactionOperation is missed and that they are processed in the order they occurred. + synchronized(txOperationsOnComplete) { + if(failure != null) { + LOG.debug("Tx {} Creating NoOpTransaction because of error: {}", identifier, + failure.getMessage()); + + transactionContext = new NoOpTransactionContext(failure, identifier); + } else if (response.getClass().equals(CreateTransactionReply.SERIALIZABLE_CLASS)) { + createValidTransactionContext(CreateTransactionReply.fromSerializable(response)); + } else { + IllegalArgumentException exception = new IllegalArgumentException(String.format( + "Invalid reply type %s for CreateTransaction", response.getClass())); + + transactionContext = new NoOpTransactionContext(exception, identifier); + } + + for(TransactionOperation oper: txOperationsOnComplete) { + oper.invoke(transactionContext); + } + + txOperationsOnComplete.clear(); + } + } + + private void createValidTransactionContext(CreateTransactionReply reply) { + String transactionPath = reply.getTransactionPath(); + + LOG.debug("Tx {} Received transaction actor path {}", identifier, transactionPath); + + ActorSelection transactionActor = actorContext.actorSelection(transactionPath); + + if (transactionType == TransactionType.READ_ONLY) { + // Add the actor to the remoteTransactionActors list for access by the + // cleanup PhantonReference. + remoteTransactionActors.add(transactionActor); + + // Write to the memory barrier volatile to publish the above update to the + // remoteTransactionActors list for thread visibility. + remoteTransactionActorsMB.set(true); + } + + // TxActor is always created where the leader of the shard is. + // Check if TxActor is created in the same node + boolean isTxActorLocal = actorContext.isLocalPath(transactionPath); + + transactionContext = new TransactionContextImpl(transactionPath, transactionActor, identifier, + actorContext, schemaContext, isTxActorLocal, reply.getVersion()); } } private interface TransactionContext { - String getShardName(); + void closeTransaction(); - String getResolvedCohortPath(String cohortPath); + Future readyTransaction(); - public void closeTransaction(); - - public Object readyTransaction(); + void writeData(YangInstanceIdentifier path, NormalizedNode data); void deleteData(YangInstanceIdentifier path); @@ -284,120 +702,313 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { CheckedFuture>, ReadFailedException> readData( final YangInstanceIdentifier path); - void writeData(YangInstanceIdentifier path, NormalizedNode data); - CheckedFuture dataExists(YangInstanceIdentifier path); - } + List> getRecordedOperationFutures(); + } - private class TransactionContextImpl implements TransactionContext { - private final String shardName; - private final String actorPath; - private final ActorSelection actor; + private static abstract class AbstractTransactionContext implements TransactionContext { + protected final TransactionIdentifier identifier; + protected final List> recordedOperationFutures = Lists.newArrayList(); - private TransactionContextImpl(String shardName, String actorPath, - ActorSelection actor) { - this.shardName = shardName; - this.actorPath = actorPath; - this.actor = actor; + AbstractTransactionContext(TransactionIdentifier identifier) { + this.identifier = identifier; } @Override - public String getShardName() { - return shardName; + public List> getRecordedOperationFutures() { + return recordedOperationFutures; } + } - private ActorSelection getActor() { - return actor; + 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; } - @Override - public String getResolvedCohortPath(String cohortPath) { - return actorContext.resolvePath(actorPath, cohortPath); + private ActorSelection getActor() { + return actor; } @Override public void closeTransaction() { - actorContext.sendRemoteOperationAsync(getActor(), new CloseTransaction().toSerializable()); + LOG.debug("Tx {} closeTransaction called", identifier); + + actorContext.sendOperationAsync(getActor(), new CloseTransaction().toSerializable()); } @Override - public Object readyTransaction() { - return actorContext.executeRemoteOperation(getActor(), - new ReadyTransaction().toSerializable(), ActorContext.ASK_DURATION); + public Future readyTransaction() { + LOG.debug("Tx {} readyTransaction called with {} previous recorded operations pending", + identifier, recordedOperationFutures.size()); + + // Send the ReadyTransaction message to the Tx actor. + + ReadyTransaction readyTransaction = new ReadyTransaction(); + final Future replyFuture = actorContext.executeOperationAsync(getActor(), + isTxActorLocal ? readyTransaction : readyTransaction.toSerializable()); + + // Combine all the previously recorded put/merge/delete operation reply Futures and the + // ReadyTransactionReply Future into one Future. If any one fails then the combined + // Future will fail. We need all prior operations and the ready operation to succeed + // in order to attempt commit. + + List> futureList = + Lists.newArrayListWithCapacity(recordedOperationFutures.size() + 1); + futureList.addAll(recordedOperationFutures); + futureList.add(replyFuture); + + Future> combinedFutures = akka.dispatch.Futures.sequence(futureList, + actorContext.getActorSystem().dispatcher()); + + // Transform the combined Future into a Future that returns the cohort actor path from + // the ReadyTransactionReply. That's the end result of the ready operation. + + return combinedFutures.transform(new Mapper, ActorSelection>() { + @Override + public ActorSelection checkedApply(Iterable notUsed) { + LOG.debug("Tx {} readyTransaction: pending recorded operations succeeded", + identifier); + + // At this point all the Futures succeeded and we need to extract the cohort + // actor path from the ReadyTransactionReply. For the recorded operations, they + // don't return any data so we're only interested that they completed + // successfully. We could be paranoid and verify the correct reply types but + // that really should never happen so it's not worth the overhead of + // de-serializing each reply. + + // Note the Future get call here won't block as it's complete. + Object serializedReadyReply = replyFuture.value().get().get(); + if (serializedReadyReply instanceof ReadyTransactionReply) { + return actorContext.actorSelection(((ReadyTransactionReply)serializedReadyReply).getCohortPath()); + + } else if(serializedReadyReply.getClass().equals(ReadyTransactionReply.SERIALIZABLE_CLASS)) { + ReadyTransactionReply reply = ReadyTransactionReply.fromSerializable(serializedReadyReply); + String cohortPath = reply.getCohortPath(); + + // In Helium we used to return the local path of the actor which represented + // a remote ThreePhaseCommitCohort. The local path would then be converted to + // a remote path using this resolvePath method. To maintain compatibility with + // a Helium node we need to continue to do this conversion. + // At some point in the future when upgrades from Helium are not supported + // we could remove this code to resolvePath and just use the cohortPath as the + // resolved cohortPath + if(TransactionContextImpl.this.remoteTransactionVersion < CreateTransaction.HELIUM_1_VERSION) { + cohortPath = actorContext.resolvePath(transactionPath, cohortPath); + } + + return actorContext.actorSelection(cohortPath); + + } else { + // Throwing an exception here will fail the Future. + throw new IllegalArgumentException(String.format("Invalid reply type {}", + serializedReadyReply.getClass())); + } + } + }, SAME_FAILURE_TRANSFORMER, actorContext.getActorSystem().dispatcher()); } @Override public void deleteData(YangInstanceIdentifier path) { - actorContext.sendRemoteOperationAsync(getActor(), new DeleteData(path).toSerializable() ); + LOG.debug("Tx {} deleteData called path = {}", identifier, path); + + DeleteData deleteData = new DeleteData(path); + recordedOperationFutures.add(actorContext.executeOperationAsync(getActor(), + isTxActorLocal ? deleteData : deleteData.toSerializable())); } @Override public void mergeData(YangInstanceIdentifier path, NormalizedNode data) { - actorContext.sendRemoteOperationAsync(getActor(), - new MergeData(path, data, schemaContext).toSerializable()); + LOG.debug("Tx {} mergeData called path = {}", identifier, path); + + MergeData mergeData = new MergeData(path, data, schemaContext); + recordedOperationFutures.add(actorContext.executeOperationAsync(getActor(), + isTxActorLocal ? mergeData : mergeData.toSerializable())); + } + + @Override + public void writeData(YangInstanceIdentifier path, NormalizedNode data) { + LOG.debug("Tx {} writeData called path = {}", identifier, path); + + WriteData writeData = new WriteData(path, data, schemaContext); + recordedOperationFutures.add(actorContext.executeOperationAsync(getActor(), + isTxActorLocal ? writeData : writeData.toSerializable())); } @Override public CheckedFuture>, ReadFailedException> readData( - final YangInstanceIdentifier path) { + 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 response) throws Throwable { + 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 { - if (response.getClass().equals(ReadDataReply.SERIALIZABLE_CLASS)) { - ReadDataReply reply = ReadDataReply.fromSerializable(schemaContext, - path, response); - 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 future = actorContext.executeRemoteOperationAsync(getActor(), - new ReadData(path).toSerializable(), ActorContext.ASK_DURATION); - future.onComplete(onComplete, actorContext.getActorSystem().dispatcher()); - - return MappingCheckedFuture.create(returnFuture, ReadFailedException.MAPPER); - } + ReadData readData = new ReadData(path); + Future readFuture = actorContext.executeOperationAsync(getActor(), + isTxActorLocal ? readData : readData.toSerializable()); - @Override - public void writeData(YangInstanceIdentifier path, NormalizedNode data) { - actorContext.sendRemoteOperationAsync(getActor(), - new WriteData(path, data, schemaContext).toSerializable()); + readFuture.onComplete(onComplete, actorContext.getActorSystem().dispatcher()); } @Override public CheckedFuture dataExists( final YangInstanceIdentifier path) { + LOG.debug("Tx {} dataExists called path = {}", identifier, path); + final SettableFuture returnFuture = SettableFuture.create(); + // If there were any previous recorded put/merge/delete operation reply Futures then we + // must wait for them to successfully complete. This is necessary to honor the read + // uncommitted semantics of the public API contract. If any one fails then fail this + // request. + + if(recordedOperationFutures.isEmpty()) { + finishDataExists(path, returnFuture); + } else { + LOG.debug("Tx {} dataExists: verifying {} previous recorded operations", + identifier, recordedOperationFutures.size()); + + // Note: we make a copy of recordedOperationFutures to be on the safe side in case + // Futures#sequence accesses the passed List on a different thread, as + // recordedOperationFutures is not synchronized. + + 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 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 exists for path " + path, failure)); + "Error checking data exists for path " + path, failure)); } else { - 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)); @@ -406,83 +1017,65 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { } }; - Future future = actorContext.executeRemoteOperationAsync(getActor(), - new DataExists(path).toSerializable(), ActorContext.ASK_DURATION); - future.onComplete(onComplete, actorContext.getActorSystem().dispatcher()); + DataExists dataExists = new DataExists(path); + Future future = actorContext.executeOperationAsync(getActor(), + isTxActorLocal ? dataExists : dataExists.toSerializable()); - return MappingCheckedFuture.create(returnFuture, ReadFailedException.MAPPER); + future.onComplete(onComplete, actorContext.getActorSystem().dispatcher()); } } - private class NoOpTransactionContext implements TransactionContext { + private static class NoOpTransactionContext extends AbstractTransactionContext { - private final Logger - LOG = LoggerFactory.getLogger(NoOpTransactionContext.class); - - private final String shardName; - private final Exception failure; + private final Logger LOG = LoggerFactory.getLogger(NoOpTransactionContext.class); - private ActorRef cohort; + private final Throwable failure; - public NoOpTransactionContext(String shardName, Exception failure){ - this.shardName = shardName; + public NoOpTransactionContext(Throwable failure, TransactionIdentifier identifier){ + super(identifier); this.failure = failure; } @Override - public String getShardName() { - return shardName; - + public void closeTransaction() { + LOG.debug("NoOpTransactionContext {} closeTransaction called", identifier); } @Override - public String getResolvedCohortPath(String cohortPath) { - return cohort.path().toString(); + public Future readyTransaction() { + LOG.debug("Tx {} readyTransaction called", identifier); + return akka.dispatch.Futures.failed(failure); } @Override - public void closeTransaction() { - LOG.warn("txn {} closeTransaction called", identifier); - } - - @Override public Object readyTransaction() { - LOG.warn("txn {} readyTransaction called", identifier); - cohort = actorContext.getActorSystem().actorOf(Props.create(NoOpCohort.class)); - return new ReadyTransactionReply(cohort.path()).toSerializable(); + public void deleteData(YangInstanceIdentifier path) { + LOG.debug("Tx {} deleteData called path = {}", identifier, path); } @Override - public void deleteData(YangInstanceIdentifier path) { - LOG.warn("txt {} deleteData called path = {}", identifier, path); + public void mergeData(YangInstanceIdentifier path, NormalizedNode data) { + LOG.debug("Tx {} mergeData called path = {}", identifier, path); } @Override - public void mergeData(YangInstanceIdentifier path, - NormalizedNode data) { - LOG.warn("txn {} mergeData called path = {}", identifier, path); + public void writeData(YangInstanceIdentifier path, NormalizedNode data) { + LOG.debug("Tx {} writeData called path = {}", identifier, path); } @Override public CheckedFuture>, ReadFailedException> readData( - YangInstanceIdentifier path) { - LOG.warn("txn {} 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 void writeData(YangInstanceIdentifier path, - NormalizedNode data) { - LOG.warn("txn {} writeData called path = {}", identifier, path); - } - - @Override public CheckedFuture dataExists( - YangInstanceIdentifier path) { - LOG.warn("txn {} dataExists called path = {}", identifier, path); + @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)); } } - - - }