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%2FThreePhaseCommitCohortProxy.java;h=a7a5b31b174e4e0d03db192aa367a43ebe67ad62;hb=34bc6ec632529a0dfe419aa7404bb42a456fbc96;hp=fc455b193e27118f6dcfcc2de93032f2676c5619;hpb=54916d10764a5234881040e9a68ae35d63b3dac9;p=controller.git diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ThreePhaseCommitCohortProxy.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ThreePhaseCommitCohortProxy.java index fc455b193e..a7a5b31b17 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ThreePhaseCommitCohortProxy.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ThreePhaseCommitCohortProxy.java @@ -13,6 +13,7 @@ import akka.actor.ActorSelection; import akka.dispatch.Futures; import akka.dispatch.OnComplete; +import com.google.common.annotations.VisibleForTesting; import com.google.common.collect.Lists; import com.google.common.util.concurrent.ListenableFuture; import com.google.common.util.concurrent.SettableFuture; @@ -31,6 +32,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; import scala.concurrent.Future; +import scala.runtime.AbstractFunction1; import java.util.Collections; import java.util.List; @@ -40,32 +42,85 @@ import java.util.List; */ public class ThreePhaseCommitCohortProxy implements DOMStoreThreePhaseCommitCohort{ - private static final Logger LOG = LoggerFactory.getLogger(DistributedDataStore.class); + private static final Logger LOG = LoggerFactory.getLogger(ThreePhaseCommitCohortProxy.class); private final ActorContext actorContext; - private final List cohortPaths; + private final List> cohortPathFutures; + private volatile List cohortPaths; private final String transactionId; - public ThreePhaseCommitCohortProxy(ActorContext actorContext, List cohortPaths, - String transactionId) { + public ThreePhaseCommitCohortProxy(ActorContext actorContext, + List> cohortPathFutures, String transactionId) { this.actorContext = actorContext; - this.cohortPaths = cohortPaths; + this.cohortPathFutures = cohortPathFutures; this.transactionId = transactionId; } + private Future buildCohortPathsList() { + + Future> combinedFutures = Futures.sequence(cohortPathFutures, + actorContext.getActorSystem().dispatcher()); + + return combinedFutures.transform(new AbstractFunction1, Void>() { + @Override + public Void apply(Iterable paths) { + cohortPaths = Lists.newArrayList(paths); + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {} successfully built cohort path list: {}", + transactionId, cohortPaths); + } + return null; + } + }, TransactionProxy.SAME_FAILURE_TRANSFORMER, actorContext.getActorSystem().dispatcher()); + } + @Override public ListenableFuture canCommit() { - LOG.debug("txn {} canCommit", transactionId); + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {} canCommit", transactionId); + } + final SettableFuture returnFuture = SettableFuture.create(); + + // The first phase of canCommit is to gather the list of cohort actor paths that will + // participate in the commit. buildCohortPathsList combines the cohort path Futures into + // one Future which we wait on asynchronously here. The cohort actor paths are + // extracted from ReadyTransactionReply messages by the Futures that were obtained earlier + // and passed to us from upstream processing. If any one fails then we'll fail canCommit. + + buildCohortPathsList().onComplete(new OnComplete() { + @Override + public void onComplete(Throwable failure, Void notUsed) throws Throwable { + if(failure != null) { + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {}: a cohort path Future failed: {}", transactionId, failure); + } + returnFuture.setException(failure); + } else { + finishCanCommit(returnFuture); + } + } + }, actorContext.getActorSystem().dispatcher()); + + return returnFuture; + } + + private void finishCanCommit(final SettableFuture returnFuture) { + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {} finishCanCommit", transactionId); + } + // The last phase of canCommit is to invoke all the cohort actors asynchronously to perform + // their canCommit processing. If any one fails then we'll fail canCommit. Future> combinedFuture = invokeCohorts(new CanCommitTransaction().toSerializable()); - final SettableFuture returnFuture = SettableFuture.create(); - combinedFuture.onComplete(new OnComplete>() { @Override public void onComplete(Throwable failure, Iterable responses) throws Throwable { if(failure != null) { + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {}: a canCommit cohort Future failed: {}", transactionId, failure); + } returnFuture.setException(failure); return; } @@ -86,24 +141,23 @@ public class ThreePhaseCommitCohortProxy implements DOMStoreThreePhaseCommitCoho return; } } - + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {}: canCommit returning result: {}", transactionId, result); + } returnFuture.set(Boolean.valueOf(result)); } }, actorContext.getActorSystem().dispatcher()); - - return returnFuture; } private Future> invokeCohorts(Object message) { List> futureList = Lists.newArrayListWithCapacity(cohortPaths.size()); for(ActorPath actorPath : cohortPaths) { - - LOG.debug("txn {} Sending {} to {}", transactionId, message, actorPath); - + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {}: Sending {} to cohort {}", transactionId, message, actorPath); + } ActorSelection cohort = actorContext.actorSelection(actorPath); - futureList.add(actorContext.executeRemoteOperationAsync(cohort, message, - ActorContext.ASK_DURATION)); + futureList.add(actorContext.executeRemoteOperationAsync(cohort, message)); } return Futures.sequence(futureList, actorContext.getActorSystem().dispatcher()); @@ -111,39 +165,75 @@ public class ThreePhaseCommitCohortProxy implements DOMStoreThreePhaseCommitCoho @Override public ListenableFuture preCommit() { - LOG.debug("txn {} preCommit", transactionId); - return voidOperation(new PreCommitTransaction().toSerializable(), + return voidOperation("preCommit", new PreCommitTransaction().toSerializable(), PreCommitTransactionReply.SERIALIZABLE_CLASS, true); } @Override public ListenableFuture abort() { - LOG.debug("txn {} abort", transactionId); - // Note - we pass false for propagateException. In the front-end data broker, this method // is called when one of the 3 phases fails with an exception. We'd rather have that // original exception propagated to the client. If our abort fails and we propagate the // exception then that exception will supersede and suppress the original exception. But // it's the original exception that is the root cause and of more interest to the client. - return voidOperation(new AbortTransaction().toSerializable(), + return voidOperation("abort", new AbortTransaction().toSerializable(), AbortTransactionReply.SERIALIZABLE_CLASS, false); } @Override public ListenableFuture commit() { - LOG.debug("txn {} commit", transactionId); - return voidOperation(new CommitTransaction().toSerializable(), + return voidOperation("commit", new CommitTransaction().toSerializable(), CommitTransactionReply.SERIALIZABLE_CLASS, true); } - private ListenableFuture voidOperation(final Object message, + private ListenableFuture voidOperation(final String operationName, final Object message, final Class expectedResponseClass, final boolean propagateException) { - Future> combinedFuture = invokeCohorts(message); - + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {} {}", transactionId, operationName); + } final SettableFuture returnFuture = SettableFuture.create(); + // The cohort actor list should already be built at this point by the canCommit phase but, + // if not for some reason, we'll try to build it here. + + if(cohortPaths != null) { + finishVoidOperation(operationName, message, expectedResponseClass, propagateException, + returnFuture); + } else { + buildCohortPathsList().onComplete(new OnComplete() { + @Override + public void onComplete(Throwable failure, Void notUsed) throws Throwable { + if(failure != null) { + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {}: a {} cohort path Future failed: {}", transactionId, + operationName, failure); + } + if(propagateException) { + returnFuture.setException(failure); + } else { + returnFuture.set(null); + } + } else { + finishVoidOperation(operationName, message, expectedResponseClass, + propagateException, returnFuture); + } + } + }, actorContext.getActorSystem().dispatcher()); + } + + return returnFuture; + } + + private void finishVoidOperation(final String operationName, final Object message, + final Class expectedResponseClass, final boolean propagateException, + final SettableFuture returnFuture) { + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {} finish {}", transactionId, operationName); + } + Future> combinedFuture = invokeCohorts(message); + combinedFuture.onComplete(new OnComplete>() { @Override public void onComplete(Throwable failure, Iterable responses) throws Throwable { @@ -161,6 +251,10 @@ public class ThreePhaseCommitCohortProxy implements DOMStoreThreePhaseCommitCoho } if(exceptionToPropagate != null) { + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {}: a {} cohort Future failed: {}", transactionId, + operationName, exceptionToPropagate); + } if(propagateException) { // We don't log the exception here to avoid redundant logging since we're // propagating to the caller in MD-SAL core who will log it. @@ -169,20 +263,24 @@ public class ThreePhaseCommitCohortProxy implements DOMStoreThreePhaseCommitCoho // Since the caller doesn't want us to propagate the exception we'll also // not log it normally. But it's usually not good to totally silence // exceptions so we'll log it to debug level. - LOG.debug(String.format("%s failed", message.getClass().getSimpleName()), + if(LOG.isDebugEnabled()) { + LOG.debug(String.format("%s failed", message.getClass().getSimpleName()), exceptionToPropagate); + } returnFuture.set(null); } } else { + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {}: {} succeeded", transactionId, operationName); + } returnFuture.set(null); } } }, actorContext.getActorSystem().dispatcher()); - - return returnFuture; } - public List getCohortPaths() { - return Collections.unmodifiableList(this.cohortPaths); + @VisibleForTesting + List> getCohortPathFutures() { + return Collections.unmodifiableList(cohortPathFutures); } }