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=715f48c3492156d1b14005462da2c26aacb1768c;hp=5b5b1296af08e42c2278b6db80ac05cbf08329c6;hb=531621aac4cff9d39cbd8668a53bdeba8a0e6d81;hpb=9228eee6e438894b091f7bee8a4ba7b53286ef8f 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..715f48c349 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,20 @@ 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.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.Futures; import com.google.common.util.concurrent.SettableFuture; +import org.opendaylight.controller.cluster.datastore.exceptions.PrimaryNotFoundException; import org.opendaylight.controller.cluster.datastore.identifiers.TransactionIdentifier; import org.opendaylight.controller.cluster.datastore.messages.CloseTransaction; import org.opendaylight.controller.cluster.datastore.messages.CreateTransaction; @@ -45,12 +47,15 @@ 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.ArrayList; 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; /** @@ -66,30 +71,138 @@ import java.util.concurrent.atomic.AtomicLong; *

*/ public class TransactionProxy implements DOMStoreReadWriteTransaction { + + private final TransactionChainProxy transactionChainProxy; + + + public enum TransactionType { READ_ONLY, WRITE_ONLY, READ_WRITE } + static Function1 SAME_FAILURE_TRANSFORMER = new AbstractFunction1< + Throwable, Throwable>() { + @Override + public Throwable apply(Throwable failure) { + return failure; + } + }; + private static final AtomicLong counter = new AtomicLong(); private static final Logger LOG = LoggerFactory.getLogger(TransactionProxy.class); + /** + * 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; + + private final Map remoteTransactionPaths = new HashMap<>(); + private final TransactionType transactionType; private final ActorContext actorContext; - private final Map remoteTransactionPaths = new HashMap<>(); private final TransactionIdentifier identifier; private final SchemaContext schemaContext; private boolean inReadyState; - 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"); + 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; + } + + public TransactionProxy(ActorContext actorContext, TransactionType transactionType, TransactionChainProxy transactionChainProxy) { + 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; String memberName = actorContext.getCurrentMemberName(); if(memberName == null){ @@ -97,10 +210,23 @@ 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. - LOG.debug("Created txn {}", identifier); + remoteTransactionActors = Lists.newArrayList(); + remoteTransactionActorsMB = new AtomicBoolean(); + TransactionProxyCleanupPhantomReference cleanup = + new TransactionProxyCleanupPhantomReference(this); + phantomReferenceCache.put(cleanup, cleanup); + } + if(LOG.isDebugEnabled()) { + LOG.debug("Created txn {} of type {}", identifier, transactionType); + } } @Override @@ -110,8 +236,9 @@ 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); - + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {} read {}", identifier, path); + } createTransactionIfMissing(actorContext, path); return transactionContext(path).readData(path); @@ -123,8 +250,9 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { Preconditions.checkState(transactionType != TransactionType.WRITE_ONLY, "Exists operation on write-only transaction is not allowed"); - LOG.debug("txn {} exists {}", identifier, path); - + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {} exists {}", identifier, path); + } createTransactionIfMissing(actorContext, path); return transactionContext(path).dataExists(path); @@ -134,7 +262,7 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { 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 @@ -142,8 +270,9 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { checkModificationState(); - LOG.debug("txn {} write {}", identifier, path); - + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {} write {}", identifier, path); + } createTransactionIfMissing(actorContext, path); transactionContext(path).writeData(path, data); @@ -154,8 +283,9 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { checkModificationState(); - LOG.debug("txn {} merge {}", identifier, path); - + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {} merge {}", identifier, path); + } createTransactionIfMissing(actorContext, path); transactionContext(path).mergeData(path, data); @@ -165,9 +295,9 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { public void delete(YangInstanceIdentifier path) { checkModificationState(); - - LOG.debug("txn {} delete {}", identifier, path); - + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {} delete {}", identifier, path); + } createTransactionIfMissing(actorContext, path); transactionContext(path).deleteData(path); @@ -180,31 +310,27 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { inReadyState = true; - List cohortPaths = new ArrayList<>(); - - LOG.debug("txn {} Trying to get {} transactions ready for commit", identifier, + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {} Trying to get {} transactions ready for commit", identifier, remoteTransactionPaths.size()); + } + List> cohortFutures = Lists.newArrayList(); for(TransactionContext transactionContext : remoteTransactionPaths.values()) { - LOG.debug("txn {} Readying transaction for shard {}", identifier, + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {} Readying transaction for shard {}", identifier, transactionContext.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)); - } else { - LOG.error("Was expecting {} but got {}", ReadyTransactionReply.SERIALIZABLE_CLASS, - result.getClass()); } + cohortFutures.add(transactionContext.readyTransaction()); } - return new ThreePhaseCommitCohortProxy(actorContext, cohortPaths, identifier.toString()); + if(transactionChainProxy != null){ + transactionChainProxy.onTransactionReady(cohortFutures); + } + + return new ThreePhaseCommitCohortProxy(actorContext, cohortFutures, + identifier.toString()); } @Override @@ -217,6 +343,13 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { for(TransactionContext transactionContext : remoteTransactionPaths.values()) { transactionContext.closeTransaction(); } + + remoteTransactionPaths.clear(); + + if(transactionType == TransactionType.READ_ONLY) { + remoteTransactionActors.clear(); + remoteTransactionActorsMB.set(true); + } } private TransactionContext transactionContext(YangInstanceIdentifier path){ @@ -228,54 +361,90 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { return ShardStrategyFactory.getStrategy(path).findShard(path); } - private void createTransactionIfMissing(ActorContext actorContext, YangInstanceIdentifier path) { + private void createTransactionIfMissing(ActorContext actorContext, + YangInstanceIdentifier path) { + + if(transactionChainProxy != null){ + transactionChainProxy.waitTillCurrentTransactionReady(); + } + String shardName = ShardStrategyFactory.getStrategy(path).findShard(path); TransactionContext transactionContext = remoteTransactionPaths.get(shardName); - if(transactionContext != null){ + if (transactionContext != null) { // A transaction already exists with that shard return; } try { - Object response = actorContext.executeShardOperation(shardName, - new CreateTransaction(identifier.toString(),this.transactionType.ordinal() ).toSerializable(), - ActorContext.ASK_DURATION); + Optional primaryShard = actorContext.findPrimaryShard(shardName); + if (!primaryShard.isPresent()) { + throw new PrimaryNotFoundException("Primary could not be found for shard " + shardName); + } + + Object response = actorContext.executeOperation(primaryShard.get(), + new CreateTransaction(identifier.toString(), this.transactionType.ordinal(), + getTransactionChainId()).toSerializable()); if (response.getClass().equals(CreateTransactionReply.SERIALIZABLE_CLASS)) { CreateTransactionReply reply = CreateTransactionReply.fromSerializable(response); String transactionPath = reply.getTransactionPath(); - LOG.debug("txn {} Received transaction path = {}", identifier, transactionPath); + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {} Received transaction 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); - ActorSelection transactionActor = - actorContext.actorSelection(transactionPath); - transactionContext = - new TransactionContextImpl(shardName, transactionPath, - transactionActor); + transactionContext = new TransactionContextImpl(shardName, transactionPath, + transactionActor, identifier, actorContext, schemaContext, isTxActorLocal); remoteTransactionPaths.put(shardName, transactionContext); } else { - LOG.error("Was expecting {} but got {}", CreateTransactionReply.SERIALIZABLE_CLASS, - response.getClass()); + 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()); } - } catch(Exception e){ - LOG.error("txn {} Creating NoOpTransaction because of : {}", identifier, e.getMessage()); - remoteTransactionPaths.put(shardName, new NoOpTransactionContext(shardName, e)); + remoteTransactionPaths + .put(shardName, new NoOpTransactionContext(shardName, e, identifier)); } } + public String getTransactionChainId() { + if(transactionChainProxy == null){ + return ""; + } + return transactionChainProxy.getTransactionChainId(); + } + + private interface TransactionContext { String getShardName(); - String getResolvedCohortPath(String cohortPath); + void closeTransaction(); - public void closeTransaction(); + Future readyTransaction(); - public Object readyTransaction(); + void writeData(YangInstanceIdentifier path, NormalizedNode data); void deleteData(YangInstanceIdentifier path); @@ -284,23 +453,20 @@ 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 String shardName; + protected final List> recordedOperationFutures = Lists.newArrayList(); - private TransactionContextImpl(String shardName, String actorPath, - ActorSelection actor) { + AbstractTransactionContext(String shardName, TransactionIdentifier identifier) { this.shardName = shardName; - this.actorPath = actorPath; - this.actor = actor; + this.identifier = identifier; } @Override @@ -308,96 +474,311 @@ public class TransactionProxy implements DOMStoreReadWriteTransaction { return shardName; } - private ActorSelection getActor() { - return actor; + @Override + public List> getRecordedOperationFutures() { + return recordedOperationFutures; } + } - @Override - public String getResolvedCohortPath(String cohortPath) { - return actorContext.resolvePath(actorPath, cohortPath); + 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 actorPath; + private final ActorSelection actor; + private final boolean isTxActorLocal; + + private TransactionContextImpl(String shardName, String actorPath, + ActorSelection actor, TransactionIdentifier identifier, ActorContext actorContext, + SchemaContext schemaContext, boolean isTxActorLocal) { + super(shardName, identifier); + this.actorPath = actorPath; + this.actor = actor; + this.actorContext = actorContext; + this.schemaContext = schemaContext; + this.isTxActorLocal = isTxActorLocal; + } + + private ActorSelection getActor() { + return actor; } @Override public void closeTransaction() { - actorContext.sendRemoteOperationAsync(getActor(), new CloseTransaction().toSerializable()); + if(LOG.isDebugEnabled()) { + 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() { + if(LOG.isDebugEnabled()) { + 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 AbstractFunction1, ActorSelection>() { + @Override + public ActorSelection apply(Iterable notUsed) { + if(LOG.isDebugEnabled()) { + 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); + return actorContext.actorSelection(reply.getCohortPath()); + + } 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() ); + if(LOG.isDebugEnabled()) { + 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()); + if(LOG.isDebugEnabled()) { + 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) { + if(LOG.isDebugEnabled()) { + 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) { + if(LOG.isDebugEnabled()) { + 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 { + if(LOG.isDebugEnabled()) { + 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) { + if(LOG.isDebugEnabled()) { + 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) { + + if(LOG.isDebugEnabled()) { + 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) { + if(LOG.isDebugEnabled()) { + 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())); - } + if(LOG.isDebugEnabled()) { + 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) { + if(LOG.isDebugEnabled()) { + 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 { + if(LOG.isDebugEnabled()) { + 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) { + if(LOG.isDebugEnabled()) { + 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) { + + if(LOG.isDebugEnabled()) { + 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); + } 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())); + if(LOG.isDebugEnabled()) { + 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 +787,80 @@ 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 Logger LOG = LoggerFactory.getLogger(NoOpTransactionContext.class); - private final String shardName; private final Exception failure; - private ActorRef cohort; - - public NoOpTransactionContext(String shardName, Exception failure){ - this.shardName = shardName; + public NoOpTransactionContext(String shardName, Exception failure, + TransactionIdentifier identifier){ + super(shardName, identifier); this.failure = failure; } @Override - public String getShardName() { - return shardName; - + public void closeTransaction() { + if(LOG.isDebugEnabled()) { + LOG.debug("NoOpTransactionContext {} closeTransaction called", identifier); + } } @Override - public String getResolvedCohortPath(String cohortPath) { - return cohort.path().toString(); + public Future readyTransaction() { + if(LOG.isDebugEnabled()) { + 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) { + if(LOG.isDebugEnabled()) { + 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) { + if(LOG.isDebugEnabled()) { + 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) { + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {} writeData called path = {}", identifier, path); + } } @Override public CheckedFuture>, ReadFailedException> readData( YangInstanceIdentifier path) { - LOG.warn("txn {} readData called path = {}", identifier, path); + if(LOG.isDebugEnabled()) { + 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( + @Override + public CheckedFuture dataExists( YangInstanceIdentifier path) { - LOG.warn("txn {} dataExists called path = {}", identifier, path); + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {} dataExists called path = {}", identifier, path); + } return Futures.immediateFailedCheckedFuture(new ReadFailedException( "Error checking exists for path " + path, failure)); } } - - - }