*/
package org.opendaylight.controller.cluster.datastore;
+import akka.dispatch.ExecutionContexts;
+import akka.dispatch.OnComplete;
import com.google.common.base.Preconditions;
-import com.google.common.util.concurrent.Futures;
-import com.google.common.util.concurrent.ListenableFuture;
+import com.google.common.base.Verify;
+import com.google.common.primitives.UnsignedLong;
+import com.google.common.util.concurrent.FutureCallback;
+import java.util.Optional;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeoutException;
+import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
+import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateTip;
import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import scala.concurrent.Future;
final class SimpleShardDataTreeCohort extends ShardDataTreeCohort {
private static final Logger LOG = LoggerFactory.getLogger(SimpleShardDataTreeCohort.class);
- private static final ListenableFuture<Boolean> TRUE_FUTURE = Futures.immediateFuture(Boolean.TRUE);
- private static final ListenableFuture<Void> VOID_FUTURE = Futures.immediateFuture(null);
+
private final DataTreeModification transaction;
private final ShardDataTree dataTree;
+ private final TransactionIdentifier transactionId;
+ private final CompositeDataTreeCohort userCohorts;
+
+ private State state = State.READY;
private DataTreeCandidateTip candidate;
+ private FutureCallback<?> callback;
+ private Exception nextFailure;
- SimpleShardDataTreeCohort(final ShardDataTree dataTree, final DataTreeModification transaction) {
+ SimpleShardDataTreeCohort(final ShardDataTree dataTree, final DataTreeModification transaction,
+ final TransactionIdentifier transactionId, final CompositeDataTreeCohort userCohorts) {
this.dataTree = Preconditions.checkNotNull(dataTree);
this.transaction = Preconditions.checkNotNull(transaction);
+ this.transactionId = Preconditions.checkNotNull(transactionId);
+ this.userCohorts = Preconditions.checkNotNull(userCohorts);
+ }
+
+ @Override
+ public TransactionIdentifier getIdentifier() {
+ return transactionId;
}
@Override
}
@Override
- public ListenableFuture<Boolean> canCommit() {
- try {
- dataTree.getDataTree().validate(transaction);
- LOG.debug("Transaction {} validated", transaction);
- return TRUE_FUTURE;
- } catch (Exception e) {
- return Futures.immediateFailedFuture(e);
+ DataTreeModification getDataTreeModification() {
+ return transaction;
+ }
+
+ private void checkState(final State expected) {
+ Preconditions.checkState(state == expected, "State %s does not match expected state %s", state, expected);
+ }
+
+ @Override
+ public void canCommit(final FutureCallback<Void> newCallback) {
+ if (state == State.CAN_COMMIT_PENDING) {
+ return;
}
+
+ checkState(State.READY);
+ this.callback = Preconditions.checkNotNull(newCallback);
+ state = State.CAN_COMMIT_PENDING;
+ dataTree.startCanCommit(this);
}
@Override
- public ListenableFuture<Void> preCommit() {
- try {
- candidate = dataTree.getDataTree().prepare(transaction);
- /*
- * FIXME: this is the place where we should be interacting with persistence, specifically by invoking
- * persist on the candidate (which gives us a Future).
- */
- LOG.debug("Transaction {} prepared candidate {}", transaction, candidate);
- return VOID_FUTURE;
- } catch (Exception e) {
- LOG.debug("Transaction {} failed to prepare", transaction, e);
- return Futures.immediateFailedFuture(e);
+ public void preCommit(final FutureCallback<DataTreeCandidate> newCallback) {
+ checkState(State.CAN_COMMIT_COMPLETE);
+ this.callback = Preconditions.checkNotNull(newCallback);
+ state = State.PRE_COMMIT_PENDING;
+
+ if (nextFailure == null) {
+ dataTree.startPreCommit(this);
+ } else {
+ failedPreCommit(nextFailure);
}
}
@Override
- public ListenableFuture<Void> abort() {
- // No-op, really
- return VOID_FUTURE;
+ public void abort(final FutureCallback<Void> abortCallback) {
+ if (!dataTree.startAbort(this)) {
+ abortCallback.onSuccess(null);
+ return;
+ }
+
+ candidate = null;
+ state = State.ABORTED;
+
+ final Optional<Future<Iterable<Object>>> maybeAborts = userCohorts.abort();
+ if (!maybeAborts.isPresent()) {
+ abortCallback.onSuccess(null);
+ return;
+ }
+
+ final Future<Iterable<Object>> aborts = maybeAborts.get();
+ if (aborts.isCompleted()) {
+ abortCallback.onSuccess(null);
+ return;
+ }
+
+ aborts.onComplete(new OnComplete<Iterable<Object>>() {
+ @Override
+ public void onComplete(final Throwable failure, final Iterable<Object> objs) {
+ if (failure != null) {
+ abortCallback.onFailure(failure);
+ } else {
+ abortCallback.onSuccess(null);
+ }
+ }
+ }, ExecutionContexts.global());
}
@Override
- public ListenableFuture<Void> commit() {
+ public void commit(final FutureCallback<UnsignedLong> newCallback) {
+ checkState(State.PRE_COMMIT_COMPLETE);
+ this.callback = Preconditions.checkNotNull(newCallback);
+ state = State.COMMIT_PENDING;
+
+ if (nextFailure == null) {
+ dataTree.startCommit(this, candidate);
+ } else {
+ failedCommit(nextFailure);
+ }
+ }
+
+ private <T> FutureCallback<T> switchState(final State newState) {
+ @SuppressWarnings("unchecked")
+ final FutureCallback<T> ret = (FutureCallback<T>) this.callback;
+ this.callback = null;
+ LOG.debug("Transaction {} changing state from {} to {}", transactionId, state, newState);
+ this.state = newState;
+ return ret;
+ }
+
+ void setNewCandidate(DataTreeCandidateTip dataTreeCandidate) {
+ checkState(State.PRE_COMMIT_COMPLETE);
+ this.candidate = Verify.verifyNotNull(dataTreeCandidate);
+ }
+
+ void successfulCanCommit() {
+ switchState(State.CAN_COMMIT_COMPLETE).onSuccess(null);
+ }
+
+ void failedCanCommit(final Exception cause) {
+ switchState(State.FAILED).onFailure(cause);
+ }
+
+ /**
+ * Run user-defined canCommit and preCommit hooks. We want to run these before we initiate persistence so that
+ * any failure to validate is propagated before we record the transaction.
+ *
+ * @param dataTreeCandidate {@link DataTreeCandidate} under consideration
+ * @throws ExecutionException if the operation fails
+ * @throws TimeoutException if the operation times out
+ */
+ // FIXME: this should be asynchronous
+ void userPreCommit(final DataTreeCandidate dataTreeCandidate) throws ExecutionException, TimeoutException {
+ userCohorts.reset();
+ userCohorts.canCommit(dataTreeCandidate);
+ userCohorts.preCommit();
+ }
+
+ void successfulPreCommit(final DataTreeCandidateTip dataTreeCandidate) {
+ LOG.trace("Transaction {} prepared candidate {}", transaction, dataTreeCandidate);
+ this.candidate = Verify.verifyNotNull(dataTreeCandidate);
+ switchState(State.PRE_COMMIT_COMPLETE).onSuccess(dataTreeCandidate);
+ }
+
+ void failedPreCommit(final Exception cause) {
+ if (LOG.isTraceEnabled()) {
+ LOG.trace("Transaction {} failed to prepare", transaction, cause);
+ } else {
+ LOG.error("Transaction {} failed to prepare", transactionId, cause);
+ }
+
+ userCohorts.abort();
+ switchState(State.FAILED).onFailure(cause);
+ }
+
+ void successfulCommit(final UnsignedLong journalIndex) {
try {
- dataTree.getDataTree().commit(candidate);
- } catch (Exception e) {
- LOG.error("Transaction {} failed to commit", transaction, e);
- return Futures.immediateFailedFuture(e);
+ userCohorts.commit();
+ } catch (TimeoutException | ExecutionException e) {
+ // We are probably dead, depending on what the cohorts end up doing
+ LOG.error("User cohorts failed to commit", e);
}
- LOG.debug("Transaction {} committed, proceeding to notify", transaction);
- dataTree.notifyListeners(candidate);
- return VOID_FUTURE;
+ switchState(State.COMMITTED).onSuccess(journalIndex);
+ }
+
+ void failedCommit(final Exception cause) {
+ if (LOG.isTraceEnabled()) {
+ LOG.trace("Transaction {} failed to commit", transaction, cause);
+ } else {
+ LOG.error("Transaction failed to commit", cause);
+ }
+
+ userCohorts.abort();
+ switchState(State.FAILED).onFailure(cause);
+ }
+
+ void finishCommitPending() {
+ checkState(State.COMMIT_PENDING);
+ // We want to switch the state but keep the callback.
+ callback = switchState(State.FINISH_COMMIT_PENDING);
+ }
+
+ @Override
+ public State getState() {
+ return state;
+ }
+
+ void reportFailure(final Exception cause) {
+ this.nextFailure = Preconditions.checkNotNull(cause);
+ }
+
+ @Override
+ public boolean isFailed() {
+ return state == State.FAILED || nextFailure != null;
}
}
Code Review / controller.git / blobdiff