2 * Copyright (c) 2014 Brocade Communications Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.cluster.databroker;
10 import static com.google.common.base.Preconditions.checkArgument;
11 import static java.util.Objects.requireNonNull;
12 import static org.opendaylight.mdsal.dom.broker.TransactionCommitFailedExceptionMapper.CAN_COMMIT_ERROR_MAPPER;
13 import static org.opendaylight.mdsal.dom.broker.TransactionCommitFailedExceptionMapper.COMMIT_ERROR_MAPPER;
14 import static org.opendaylight.mdsal.dom.broker.TransactionCommitFailedExceptionMapper.PRE_COMMIT_MAPPER;
16 import com.google.common.annotations.Beta;
17 import com.google.common.util.concurrent.AbstractFuture;
18 import com.google.common.util.concurrent.FluentFuture;
19 import com.google.common.util.concurrent.FutureCallback;
20 import com.google.common.util.concurrent.Futures;
21 import com.google.common.util.concurrent.ListenableFuture;
22 import com.google.common.util.concurrent.MoreExecutors;
23 import java.util.Collection;
24 import java.util.Iterator;
25 import java.util.List;
27 import java.util.concurrent.Executor;
28 import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException;
29 import org.opendaylight.controller.cluster.datastore.exceptions.ShardLeaderNotRespondingException;
30 import org.opendaylight.mdsal.common.api.CommitInfo;
31 import org.opendaylight.mdsal.common.api.DataStoreUnavailableException;
32 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
33 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
34 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
35 import org.opendaylight.mdsal.dom.broker.TransactionCommitFailedExceptionMapper;
36 import org.opendaylight.mdsal.dom.spi.store.DOMStore;
37 import org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort;
38 import org.opendaylight.yangtools.util.DurationStatisticsTracker;
39 import org.opendaylight.yangtools.yang.common.Empty;
40 import org.slf4j.Logger;
41 import org.slf4j.LoggerFactory;
44 * ConcurrentDOMDataBroker commits transactions concurrently. The 3
45 * commit phases (canCommit, preCommit, and commit) are performed serially and non-blocking
46 * (ie async) per transaction but multiple transaction commits can run concurrent.
48 * @author Thomas Pantelis
51 public class ConcurrentDOMDataBroker extends AbstractDOMBroker {
52 private static final Logger LOG = LoggerFactory.getLogger(ConcurrentDOMDataBroker.class);
53 private static final String CAN_COMMIT = "CAN_COMMIT";
54 private static final String PRE_COMMIT = "PRE_COMMIT";
55 private static final String COMMIT = "COMMIT";
57 private final DurationStatisticsTracker commitStatsTracker;
60 * This executor is used to execute Future listener callback Runnables async.
62 private final Executor clientFutureCallbackExecutor;
64 public ConcurrentDOMDataBroker(final Map<LogicalDatastoreType, DOMStore> datastores,
65 final Executor listenableFutureExecutor) {
66 this(datastores, listenableFutureExecutor, DurationStatisticsTracker.createConcurrent());
69 public ConcurrentDOMDataBroker(final Map<LogicalDatastoreType, DOMStore> datastores,
70 final Executor listenableFutureExecutor, final DurationStatisticsTracker commitStatsTracker) {
72 clientFutureCallbackExecutor = requireNonNull(listenableFutureExecutor);
73 this.commitStatsTracker = requireNonNull(commitStatsTracker);
76 public DurationStatisticsTracker getCommitStatsTracker() {
77 return commitStatsTracker;
81 protected FluentFuture<? extends CommitInfo> commit(final DOMDataTreeWriteTransaction transaction,
82 final Collection<DOMStoreThreePhaseCommitCohort> cohorts) {
84 checkArgument(transaction != null, "Transaction must not be null.");
85 checkArgument(cohorts != null, "Cohorts must not be null.");
86 LOG.debug("Tx: {} is submitted for execution.", transaction.getIdentifier());
88 if (cohorts.isEmpty()) {
89 return CommitInfo.emptyFluentFuture();
92 final AsyncNotifyingSettableFuture clientSubmitFuture =
93 new AsyncNotifyingSettableFuture(clientFutureCallbackExecutor);
95 doCanCommit(clientSubmitFuture, transaction, cohorts);
97 return FluentFuture.from(clientSubmitFuture);
100 private void doCanCommit(final AsyncNotifyingSettableFuture clientSubmitFuture,
101 final DOMDataTreeWriteTransaction transaction,
102 final Collection<DOMStoreThreePhaseCommitCohort> cohorts) {
104 final long startTime = System.nanoTime();
106 final Iterator<DOMStoreThreePhaseCommitCohort> cohortIterator = cohorts.iterator();
108 // Not using Futures.allAsList here to avoid its internal overhead.
109 FutureCallback<Boolean> futureCallback = new FutureCallback<>() {
111 public void onSuccess(final Boolean result) {
112 if (result == null || !result) {
113 handleException(clientSubmitFuture, transaction, cohorts, CAN_COMMIT, CAN_COMMIT_ERROR_MAPPER,
114 new TransactionCommitFailedException("Can Commit failed, no detailed cause available."));
115 } else if (!cohortIterator.hasNext()) {
116 // All cohorts completed successfully - we can move on to the preCommit phase
117 doPreCommit(startTime, clientSubmitFuture, transaction, cohorts);
119 Futures.addCallback(cohortIterator.next().canCommit(), this, MoreExecutors.directExecutor());
124 public void onFailure(final Throwable failure) {
125 handleException(clientSubmitFuture, transaction, cohorts, CAN_COMMIT, CAN_COMMIT_ERROR_MAPPER, failure);
129 Futures.addCallback(cohortIterator.next().canCommit(), futureCallback, MoreExecutors.directExecutor());
132 private void doPreCommit(final long startTime, final AsyncNotifyingSettableFuture clientSubmitFuture,
133 final DOMDataTreeWriteTransaction transaction,
134 final Collection<DOMStoreThreePhaseCommitCohort> cohorts) {
136 final Iterator<DOMStoreThreePhaseCommitCohort> cohortIterator = cohorts.iterator();
138 // Not using Futures.allAsList here to avoid its internal overhead.
139 FutureCallback<Empty> futureCallback = new FutureCallback<>() {
141 public void onSuccess(final Empty result) {
142 if (!cohortIterator.hasNext()) {
143 // All cohorts completed successfully - we can move on to the commit phase
144 doCommit(startTime, clientSubmitFuture, transaction, cohorts);
146 Futures.addCallback(cohortIterator.next().preCommit(), this, MoreExecutors.directExecutor());
151 public void onFailure(final Throwable failure) {
152 handleException(clientSubmitFuture, transaction, cohorts, PRE_COMMIT, PRE_COMMIT_MAPPER, failure);
156 Futures.addCallback(cohortIterator.next().preCommit(), futureCallback, MoreExecutors.directExecutor());
159 private void doCommit(final long startTime, final AsyncNotifyingSettableFuture clientSubmitFuture,
160 final DOMDataTreeWriteTransaction transaction,
161 final Collection<DOMStoreThreePhaseCommitCohort> cohorts) {
163 final Iterator<DOMStoreThreePhaseCommitCohort> cohortIterator = cohorts.iterator();
165 // Not using Futures.allAsList here to avoid its internal overhead.
166 final FutureCallback<CommitInfo> futureCallback = new FutureCallback<>() {
168 public void onSuccess(final CommitInfo result) {
169 if (!cohortIterator.hasNext()) {
170 // All cohorts completed successfully - we're done.
171 commitStatsTracker.addDuration(System.nanoTime() - startTime);
173 clientSubmitFuture.set();
175 Futures.addCallback(cohortIterator.next().commit(), this, MoreExecutors.directExecutor());
180 public void onFailure(final Throwable throwable) {
181 handleException(clientSubmitFuture, transaction, cohorts, COMMIT, COMMIT_ERROR_MAPPER, throwable);
185 Futures.addCallback(cohortIterator.next().commit(), futureCallback, MoreExecutors.directExecutor());
188 private static void handleException(final AsyncNotifyingSettableFuture clientSubmitFuture,
189 final DOMDataTreeWriteTransaction transaction,
190 final Collection<DOMStoreThreePhaseCommitCohort> cohorts,
191 final String phase, final TransactionCommitFailedExceptionMapper exMapper,
192 final Throwable throwable) {
194 if (clientSubmitFuture.isDone()) {
195 // We must have had failures from multiple cohorts.
199 // Use debug instead of warn level here because this exception gets propagate back to the caller via the Future
200 LOG.debug("Tx: {} Error during phase {}, starting Abort", transaction.getIdentifier(), phase, throwable);
202 // Transaction failed - tell all cohorts to abort.
203 @SuppressWarnings("unchecked")
204 ListenableFuture<Empty>[] canCommitFutures = new ListenableFuture[cohorts.size()];
206 for (DOMStoreThreePhaseCommitCohort cohort : cohorts) {
207 canCommitFutures[index++] = cohort.abort();
210 // Propagate the original exception
212 if (throwable instanceof NoShardLeaderException || throwable instanceof ShardLeaderNotRespondingException) {
213 e = new DataStoreUnavailableException(throwable.getMessage(), throwable);
214 } else if (throwable instanceof Exception) {
215 e = (Exception)throwable;
217 e = new RuntimeException("Unexpected error occurred", throwable);
219 clientSubmitFuture.setException(exMapper.apply(e));
221 ListenableFuture<List<Empty>> combinedFuture = Futures.allAsList(canCommitFutures);
222 Futures.addCallback(combinedFuture, new FutureCallback<List<Empty>>() {
224 public void onSuccess(final List<Empty> result) {
225 // Propagate the original exception to the client.
226 LOG.debug("Tx: {} aborted successfully", transaction.getIdentifier());
230 public void onFailure(final Throwable failure) {
231 LOG.error("Tx: {} Error during Abort.", transaction.getIdentifier(), failure);
233 }, MoreExecutors.directExecutor());
237 * A settable future that uses an {@link Executor} to execute listener callback Runnables,
238 * registered via {@link #addListener}, asynchronously when this future completes. This is
239 * done to guarantee listener executions are off-loaded onto another thread to avoid blocking
240 * the thread that completed this future, as a common use case is to pass an executor that runs
241 * tasks in the same thread as the caller (ie MoreExecutors#sameThreadExecutor)
242 * to {@link #addListener}.
243 * FIXME: This class should probably be moved to yangtools common utils for re-usability and
244 * unified with AsyncNotifyingListenableFutureTask.
246 private static class AsyncNotifyingSettableFuture extends AbstractFuture<CommitInfo> {
248 * ThreadLocal used to detect if the task completion thread is running the future listener Runnables.
250 private static final ThreadLocal<Boolean> ON_TASK_COMPLETION_THREAD_TL = new ThreadLocal<>();
252 private final Executor listenerExecutor;
254 AsyncNotifyingSettableFuture(final Executor listenerExecutor) {
255 this.listenerExecutor = requireNonNull(listenerExecutor);
259 public void addListener(final Runnable listener, final Executor executor) {
260 // Wrap the listener Runnable in a DelegatingRunnable. If the specified executor is one
261 // that runs tasks in the same thread as the caller submitting the task
262 // (e.g. {@link com.google.common.util.concurrent.MoreExecutors#sameThreadExecutor}) and
263 // the listener is executed from the #set methods, then the DelegatingRunnable will detect
264 // this via the ThreadLocal and submit the listener Runnable to the listenerExecutor.
266 // On the other hand, if this task is already complete, the call to ExecutionList#add in
267 // superclass will execute the listener Runnable immediately and, since the ThreadLocal
268 // won't be set, the DelegatingRunnable will run the listener Runnable inline.
269 super.addListener(new DelegatingRunnable(listener, listenerExecutor), executor);
273 ON_TASK_COMPLETION_THREAD_TL.set(Boolean.TRUE);
275 return super.set(CommitInfo.empty());
277 ON_TASK_COMPLETION_THREAD_TL.set(null);
282 protected boolean setException(final Throwable throwable) {
283 ON_TASK_COMPLETION_THREAD_TL.set(Boolean.TRUE);
285 return super.setException(throwable);
287 ON_TASK_COMPLETION_THREAD_TL.set(null);
291 private static final class DelegatingRunnable implements Runnable {
292 private final Runnable delegate;
293 private final Executor executor;
295 DelegatingRunnable(final Runnable delegate, final Executor executor) {
296 this.delegate = requireNonNull(delegate);
297 this.executor = requireNonNull(executor);
302 if (ON_TASK_COMPLETION_THREAD_TL.get() != null) {
303 // We're running on the task completion thread so off-load to the executor.
304 LOG.trace("Submitting ListenenableFuture Runnable from thread {} to executor {}",
305 Thread.currentThread().getName(), executor);
306 executor.execute(delegate);
308 // We're not running on the task completion thread so run the delegate inline.
309 LOG.trace("Executing ListenenableFuture Runnable on this thread: {}",
310 Thread.currentThread().getName());
318 public String toString() {
319 return "Clustered ConcurrentDOMDataBroker";