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=5f82584f856cc69b987c473178232d3aea6b3a66;hp=57749a1a736bc935da74222ca984d834083d6206;hb=b65e66f7b1bafb0d0c5fbe1c569835eb890f672a;hpb=559c2b6afa7714572e01b52029acaa4d5a7315e2 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 57749a1a73..5f82584f85 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 @@ -5,72 +5,121 @@ * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ - package org.opendaylight.controller.cluster.datastore; +import static com.google.common.base.Preconditions.checkState; +import static java.util.Objects.requireNonNull; + import akka.actor.ActorSelection; -import akka.dispatch.Futures; import akka.dispatch.OnComplete; -import com.google.common.collect.Lists; +import com.google.common.util.concurrent.FutureCallback; +import com.google.common.util.concurrent.Futures; import com.google.common.util.concurrent.ListenableFuture; +import com.google.common.util.concurrent.MoreExecutors; import com.google.common.util.concurrent.SettableFuture; -import java.util.Collections; +import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; +import java.util.ArrayList; import java.util.Iterator; import java.util.List; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.function.Supplier; +import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier; 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.utils.ActorContext; +import org.opendaylight.controller.cluster.datastore.utils.ActorUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import scala.concurrent.Future; -import scala.runtime.AbstractFunction1; /** - * ThreePhaseCommitCohortProxy represents a set of remote cohort proxies + * ThreePhaseCommitCohortProxy represents a set of remote cohort proxies. */ public class ThreePhaseCommitCohortProxy extends AbstractThreePhaseCommitCohort { private static final Logger LOG = LoggerFactory.getLogger(ThreePhaseCommitCohortProxy.class); - private final ActorContext actorContext; - private final List> cohortFutures; - private volatile List cohorts; - private final String transactionId; + private static final MessageSupplier COMMIT_MESSAGE_SUPPLIER = new MessageSupplier() { + @Override + public Object newMessage(final TransactionIdentifier transactionId, final short version) { + return new CommitTransaction(transactionId, version).toSerializable(); + } - public ThreePhaseCommitCohortProxy(ActorContext actorContext, - List> cohortFutures, String transactionId) { - this.actorContext = actorContext; - this.cohortFutures = cohortFutures; - this.transactionId = transactionId; - } + @Override + public boolean isSerializedReplyType(final Object reply) { + return CommitTransactionReply.isSerializedType(reply); + } + }; - private Future buildCohortList() { + private static final MessageSupplier ABORT_MESSAGE_SUPPLIER = new MessageSupplier() { + @Override + public Object newMessage(final TransactionIdentifier transactionId, final short version) { + return new AbortTransaction(transactionId, version).toSerializable(); + } - Future> combinedFutures = Futures.sequence(cohortFutures, - actorContext.getClientDispatcher()); + @Override + public boolean isSerializedReplyType(final Object reply) { + return AbortTransactionReply.isSerializedType(reply); + } + }; + + private final ActorUtils actorUtils; + private final List cohorts; + private final SettableFuture cohortsResolvedFuture = SettableFuture.create(); + private final TransactionIdentifier transactionId; + private volatile OperationCallback commitOperationCallback; + + public ThreePhaseCommitCohortProxy(final ActorUtils actorUtils, final List cohorts, + final TransactionIdentifier transactionId) { + this.actorUtils = actorUtils; + this.cohorts = cohorts; + this.transactionId = requireNonNull(transactionId); + + if (cohorts.isEmpty()) { + cohortsResolvedFuture.set(null); + } + } - 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); + private ListenableFuture resolveCohorts() { + if (cohortsResolvedFuture.isDone()) { + return cohortsResolvedFuture; + } + + final AtomicInteger completed = new AtomicInteger(cohorts.size()); + final Object lock = new Object(); + for (final CohortInfo info: cohorts) { + info.getActorFuture().onComplete(new OnComplete() { + @Override + public void onComplete(final Throwable failure, final ActorSelection actor) { + synchronized (lock) { + boolean done = completed.decrementAndGet() == 0; + if (failure != null) { + LOG.debug("Tx {}: a cohort Future failed", transactionId, failure); + cohortsResolvedFuture.setException(failure); + } else if (!cohortsResolvedFuture.isDone()) { + LOG.debug("Tx {}: cohort actor {} resolved", transactionId, actor); + + info.setResolvedActor(actor); + if (done) { + LOG.debug("Tx {}: successfully resolved all cohort actors", transactionId); + cohortsResolvedFuture.set(null); + } + } + } } - return null; - } - }, TransactionProxy.SAME_FAILURE_TRANSFORMER, actorContext.getClientDispatcher()); + }, actorUtils.getClientDispatcher()); + } + + return cohortsResolvedFuture; } @Override public ListenableFuture canCommit() { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} canCommit", transactionId); - } + 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 @@ -79,56 +128,59 @@ public class ThreePhaseCommitCohortProxy extends AbstractThreePhaseCommitCohort< // 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. - buildCohortList().onComplete(new OnComplete() { + Futures.addCallback(resolveCohorts(), new FutureCallback() { @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); - } + public void onSuccess(final Void notUsed) { + finishCanCommit(returnFuture); + } + + @Override + public void onFailure(final Throwable failure) { + returnFuture.setException(failure); } - }, actorContext.getClientDispatcher()); + }, MoreExecutors.directExecutor()); return returnFuture; } + @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD", + justification = "https://github.com/spotbugs/spotbugs/issues/811") private void finishCanCommit(final SettableFuture returnFuture) { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} finishCanCommit", transactionId); - } + LOG.debug("Tx {} finishCanCommit", transactionId); // For empty transactions return immediately - if(cohorts.size() == 0){ - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {}: canCommit returning result: {}", transactionId, true); - } + if (cohorts.size() == 0) { + LOG.debug("Tx {}: canCommit returning result true", transactionId); returnFuture.set(Boolean.TRUE); return; } - final Object message = new CanCommitTransaction(transactionId).toSerializable(); + commitOperationCallback = new TransactionRateLimitingCallback(actorUtils); + commitOperationCallback.run(); - final Iterator iterator = cohorts.iterator(); + final Iterator iterator = cohorts.iterator(); final OnComplete onComplete = new OnComplete() { @Override - public void onComplete(Throwable failure, Object response) throws Throwable { + public void onComplete(final Throwable failure, final Object response) { if (failure != null) { - if (LOG.isDebugEnabled()) { - LOG.debug("Tx {}: a canCommit cohort Future failed: {}", transactionId, failure); - } + LOG.debug("Tx {}: a canCommit cohort Future failed", transactionId, failure); + returnFuture.setException(failure); + commitOperationCallback.failure(); return; } + // Only the first call to pause takes effect - subsequent calls before resume are no-ops. So + // this means we'll only time the first transaction canCommit which should be fine. + commitOperationCallback.pause(); + boolean result = true; - if (response.getClass().equals(CanCommitTransactionReply.SERIALIZABLE_CLASS)) { - CanCommitTransactionReply reply = - CanCommitTransactionReply.fromSerializable(response); + if (CanCommitTransactionReply.isSerializedType(response)) { + CanCommitTransactionReply reply = CanCommitTransactionReply.fromSerializable(response); + + LOG.debug("Tx {}: received {}", transactionId, response); + if (!reply.getCanCommit()) { result = false; } @@ -139,35 +191,41 @@ public class ThreePhaseCommitCohortProxy extends AbstractThreePhaseCommitCohort< return; } - if(iterator.hasNext() && result){ - Future future = actorContext.executeOperationAsync(iterator.next(), message, - actorContext.getTransactionCommitOperationTimeout()); - future.onComplete(this, actorContext.getClientDispatcher()); + if (iterator.hasNext() && result) { + sendCanCommitTransaction(iterator.next(), this); } else { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {}: canCommit returning result: {}", transactionId, result); - } + LOG.debug("Tx {}: canCommit returning result: {}", transactionId, result); returnFuture.set(Boolean.valueOf(result)); } } }; - Future future = actorContext.executeOperationAsync(iterator.next(), message, - actorContext.getTransactionCommitOperationTimeout()); - future.onComplete(onComplete, actorContext.getClientDispatcher()); + sendCanCommitTransaction(iterator.next(), onComplete); } - private Future> invokeCohorts(Object message) { - 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.executeOperationAsync(cohort, message, actorContext.getTransactionCommitOperationTimeout())); + private void sendCanCommitTransaction(final CohortInfo toCohortInfo, final OnComplete onComplete) { + CanCommitTransaction message = new CanCommitTransaction(transactionId, toCohortInfo.getActorVersion()); + + LOG.debug("Tx {}: sending {} to {}", transactionId, message, toCohortInfo.getResolvedActor()); + + Future future = actorUtils.executeOperationAsync(toCohortInfo.getResolvedActor(), + message.toSerializable(), actorUtils.getTransactionCommitOperationTimeout()); + future.onComplete(onComplete, actorUtils.getClientDispatcher()); + } + + private Future> invokeCohorts(final MessageSupplier messageSupplier) { + List> futureList = new ArrayList<>(cohorts.size()); + for (CohortInfo cohort : cohorts) { + Object message = messageSupplier.newMessage(transactionId, cohort.getActorVersion()); + + LOG.debug("Tx {}: Sending {} to cohort {}", transactionId, message , cohort.getResolvedActor()); + + futureList.add(actorUtils.executeOperationAsync(cohort.getResolvedActor(), message, + actorUtils.getTransactionCommitOperationTimeout())); } - return Futures.sequence(futureList, actorContext.getClientDispatcher()); + return akka.dispatch.Futures.sequence(futureList, actorUtils.getClientDispatcher()); } @Override @@ -185,98 +243,97 @@ public class ThreePhaseCommitCohortProxy extends AbstractThreePhaseCommitCohort< // 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("abort", new AbortTransaction(transactionId).toSerializable(), - AbortTransactionReply.SERIALIZABLE_CLASS, false); + return voidOperation("abort", ABORT_MESSAGE_SUPPLIER, + AbortTransactionReply.class, false, OperationCallback.NO_OP_CALLBACK); } @Override public ListenableFuture commit() { - OperationCallback operationCallback = cohortFutures.isEmpty() ? OperationCallback.NO_OP_CALLBACK : - new TransactionRateLimitingCallback(actorContext); + OperationCallback operationCallback = commitOperationCallback != null ? commitOperationCallback : + OperationCallback.NO_OP_CALLBACK; - return voidOperation("commit", new CommitTransaction(transactionId).toSerializable(), - CommitTransactionReply.SERIALIZABLE_CLASS, true, operationCallback); + return voidOperation("commit", COMMIT_MESSAGE_SUPPLIER, + CommitTransactionReply.class, true, operationCallback); } - private ListenableFuture voidOperation(final String operationName, final Object message, - final Class expectedResponseClass, final boolean propagateException) { - return voidOperation(operationName, message, expectedResponseClass, propagateException, - OperationCallback.NO_OP_CALLBACK); + @SuppressWarnings("checkstyle:IllegalCatch") + private static boolean successfulFuture(final ListenableFuture future) { + if (!future.isDone()) { + return false; + } + + try { + future.get(); + return true; + } catch (Exception e) { + return false; + } } - private ListenableFuture voidOperation(final String operationName, final Object message, - final Class expectedResponseClass, final boolean propagateException, final OperationCallback callback) { + private ListenableFuture voidOperation(final String operationName, + final MessageSupplier messageSupplier, final Class expectedResponseClass, + final boolean propagateException, final OperationCallback callback) { + LOG.debug("Tx {} {}", transactionId, operationName); - 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, + ListenableFuture future = resolveCohorts(); + if (successfulFuture(future)) { + finishVoidOperation(operationName, messageSupplier, expectedResponseClass, propagateException, returnFuture, callback); } else { - buildCohortList().onComplete(new OnComplete() { + Futures.addCallback(future, new FutureCallback() { @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); - } + public void onSuccess(final Void notUsed) { + finishVoidOperation(operationName, messageSupplier, expectedResponseClass, + propagateException, returnFuture, callback); + } + + @Override + public void onFailure(final Throwable failure) { + LOG.debug("Tx {}: a {} cohort path Future failed", transactionId, operationName, failure); + + if (propagateException) { + returnFuture.setException(failure); } else { - finishVoidOperation(operationName, message, expectedResponseClass, - propagateException, returnFuture, callback); + returnFuture.set(null); } } - }, actorContext.getClientDispatcher()); + }, MoreExecutors.directExecutor()); } return returnFuture; } - private void finishVoidOperation(final String operationName, final Object message, + private void finishVoidOperation(final String operationName, final MessageSupplier messageSupplier, final Class expectedResponseClass, final boolean propagateException, final SettableFuture returnFuture, final OperationCallback callback) { - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} finish {}", transactionId, operationName); - } + LOG.debug("Tx {} finish {}", transactionId, operationName); - callback.run(); + callback.resume(); - Future> combinedFuture = invokeCohorts(message); + Future> combinedFuture = invokeCohorts(messageSupplier); combinedFuture.onComplete(new OnComplete>() { @Override - public void onComplete(Throwable failure, Iterable responses) throws Throwable { - + public void onComplete(final Throwable failure, final Iterable responses) { Throwable exceptionToPropagate = failure; - if(exceptionToPropagate == null) { - for(Object response: responses) { - if(!response.getClass().equals(expectedResponseClass)) { + if (exceptionToPropagate == null) { + for (Object response: responses) { + if (!response.getClass().equals(expectedResponseClass)) { exceptionToPropagate = new IllegalArgumentException( - String.format("Unexpected response type %s", - response.getClass())); + String.format("Unexpected response type %s", response.getClass())); break; } } } - if(exceptionToPropagate != null) { - - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {}: a {} cohort Future failed: {}", transactionId, - operationName, exceptionToPropagate); - } - if(propagateException) { + if (exceptionToPropagate != null) { + 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. returnFuture.setException(exceptionToPropagate); @@ -284,29 +341,63 @@ public class ThreePhaseCommitCohortProxy extends AbstractThreePhaseCommitCohort< // 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. - if(LOG.isDebugEnabled()) { - LOG.debug(String.format("%s failed", message.getClass().getSimpleName()), - exceptionToPropagate); - } returnFuture.set(null); } callback.failure(); } else { + LOG.debug("Tx {}: {} succeeded", transactionId, operationName); - if(LOG.isDebugEnabled()) { - LOG.debug("Tx {}: {} succeeded", transactionId, operationName); - } returnFuture.set(null); callback.success(); } } - }, actorContext.getClientDispatcher()); + }, actorUtils.getClientDispatcher()); } @Override List> getCohortFutures() { - return Collections.unmodifiableList(cohortFutures); + List> cohortFutures = new ArrayList<>(cohorts.size()); + for (CohortInfo info: cohorts) { + cohortFutures.add(info.getActorFuture()); + } + + return cohortFutures; + } + + static class CohortInfo { + private final Future actorFuture; + private final Supplier actorVersionSupplier; + + private volatile ActorSelection resolvedActor; + + CohortInfo(final Future actorFuture, final Supplier actorVersionSupplier) { + this.actorFuture = actorFuture; + this.actorVersionSupplier = actorVersionSupplier; + } + + Future getActorFuture() { + return actorFuture; + } + + ActorSelection getResolvedActor() { + return resolvedActor; + } + + void setResolvedActor(final ActorSelection resolvedActor) { + this.resolvedActor = resolvedActor; + } + + short getActorVersion() { + checkState(resolvedActor != null, "getActorVersion cannot be called until the actor is resolved"); + return actorVersionSupplier.get(); + } + } + + private interface MessageSupplier { + Object newMessage(TransactionIdentifier transactionId, short version); + + boolean isSerializedReplyType(Object reply); } }