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%2FThreePhaseCommitCohortProxy.java;h=932c36fe3469f00b5c1d5ed6b38706f48783117f;hp=fc455b193e27118f6dcfcc2de93032f2676c5619;hb=448bd0847750815fca81f20535014d1b08531e52;hpb=9228eee6e438894b091f7bee8a4ba7b53286ef8f 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..932c36fe34 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 @@ -8,64 +8,115 @@ package org.opendaylight.controller.cluster.datastore; -import akka.actor.ActorPath; 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; - +import java.util.Collections; +import java.util.List; import org.opendaylight.controller.cluster.datastore.messages.AbortTransaction; import org.opendaylight.controller.cluster.datastore.messages.AbortTransactionReply; import org.opendaylight.controller.cluster.datastore.messages.CanCommitTransaction; import org.opendaylight.controller.cluster.datastore.messages.CanCommitTransactionReply; import org.opendaylight.controller.cluster.datastore.messages.CommitTransaction; import org.opendaylight.controller.cluster.datastore.messages.CommitTransactionReply; -import org.opendaylight.controller.cluster.datastore.messages.PreCommitTransaction; -import org.opendaylight.controller.cluster.datastore.messages.PreCommitTransactionReply; import org.opendaylight.controller.cluster.datastore.utils.ActorContext; import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort; import org.slf4j.Logger; import org.slf4j.LoggerFactory; - import scala.concurrent.Future; - -import java.util.Collections; -import java.util.List; +import scala.runtime.AbstractFunction1; /** * ThreePhaseCommitCohortProxy represents a set of remote cohort proxies */ public class ThreePhaseCommitCohortProxy implements DOMStoreThreePhaseCommitCohort{ - private static final Logger LOG = LoggerFactory.getLogger(DistributedDataStore.class); + private static final Logger LOG = LoggerFactory.getLogger(ThreePhaseCommitCohortProxy.class); + + private static final ListenableFuture IMMEDIATE_SUCCESS = + com.google.common.util.concurrent.Futures.immediateFuture(null); private final ActorContext actorContext; - private final List cohortPaths; + private final List> cohortFutures; + private volatile List cohorts; private final String transactionId; - public ThreePhaseCommitCohortProxy(ActorContext actorContext, List cohortPaths, - String transactionId) { + public ThreePhaseCommitCohortProxy(ActorContext actorContext, + List> cohortFutures, String transactionId) { this.actorContext = actorContext; - this.cohortPaths = cohortPaths; + this.cohortFutures = cohortFutures; this.transactionId = transactionId; } + private Future buildCohortList() { + + Future> combinedFutures = Futures.sequence(cohortFutures, + actorContext.getActorSystem().dispatcher()); + + return combinedFutures.transform(new AbstractFunction1, Void>() { + @Override + public Void apply(Iterable actorSelections) { + cohorts = Lists.newArrayList(actorSelections); + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {} successfully built cohort path list: {}", + transactionId, cohorts); + } + 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(); - Future> combinedFuture = - invokeCohorts(new CanCommitTransaction().toSerializable()); + // 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. - final SettableFuture returnFuture = SettableFuture.create(); + buildCohortList().onComplete(new OnComplete() { + @Override + public void onComplete(Throwable failure, Void notUsed) throws Throwable { + if(failure != null) { + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {}: a cohort 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(transactionId).toSerializable()); 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; } @@ -82,28 +133,26 @@ public class ThreePhaseCommitCohortProxy implements DOMStoreThreePhaseCommitCoho } else { LOG.error("Unexpected response type {}", response.getClass()); returnFuture.setException(new IllegalArgumentException( - String.format("Unexpected response type {}", response.getClass()))); + String.format("Unexpected response type %s", response.getClass()))); 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); - - ActorSelection cohort = actorContext.actorSelection(actorPath); + List> futureList = Lists.newArrayListWithCapacity(cohorts.size()); + for(ActorSelection cohort : cohorts) { + if(LOG.isDebugEnabled()) { + LOG.debug("Tx {}: Sending {} to cohort {}", transactionId, message, cohort); + } - futureList.add(actorContext.executeRemoteOperationAsync(cohort, message, - ActorContext.ASK_DURATION)); + futureList.add(actorContext.executeOperationAsync(cohort, message)); } return Futures.sequence(futureList, actorContext.getActorSystem().dispatcher()); @@ -111,39 +160,76 @@ public class ThreePhaseCommitCohortProxy implements DOMStoreThreePhaseCommitCoho @Override public ListenableFuture preCommit() { - LOG.debug("txn {} preCommit", transactionId); - return voidOperation(new PreCommitTransaction().toSerializable(), - PreCommitTransactionReply.SERIALIZABLE_CLASS, true); + // We don't need to do anything here - preCommit is done atomically with the commit phase + // by the shard. + return IMMEDIATE_SUCCESS; } @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(transactionId).toSerializable(), AbortTransactionReply.SERIALIZABLE_CLASS, false); } @Override public ListenableFuture commit() { - LOG.debug("txn {} commit", transactionId); - return voidOperation(new CommitTransaction().toSerializable(), + return voidOperation("commit", new CommitTransaction(transactionId).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(cohorts != null) { + finishVoidOperation(operationName, message, expectedResponseClass, propagateException, + returnFuture); + } else { + buildCohortList().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 { @@ -153,7 +239,7 @@ public class ThreePhaseCommitCohortProxy implements DOMStoreThreePhaseCommitCoho for(Object response: responses) { if(!response.getClass().equals(expectedResponseClass)) { exceptionToPropagate = new IllegalArgumentException( - String.format("Unexpected response type {}", + String.format("Unexpected response type %s", response.getClass())); break; } @@ -161,6 +247,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 +259,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> getCohortFutures() { + return Collections.unmodifiableList(cohortFutures); } }