X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;ds=sidebyside;f=opendaylight%2Fmd-sal%2Fsal-distributed-datastore%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fdatabroker%2Factors%2Fdds%2FAbstractProxyTransaction.java;h=14ad54699161a60719ea846d353c46e73fb4adea;hb=HEAD;hp=46af74a5630999e0c75f430955875754c274dcb5;hpb=e1c283de301355cb8fa3f7d4fa28a6dd0af501eb;p=controller.git
diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/databroker/actors/dds/AbstractProxyTransaction.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/databroker/actors/dds/AbstractProxyTransaction.java
index 46af74a563..14ad546991 100644
--- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/databroker/actors/dds/AbstractProxyTransaction.java
+++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/databroker/actors/dds/AbstractProxyTransaction.java
@@ -7,29 +7,34 @@
*/
package org.opendaylight.controller.cluster.databroker.actors.dds;
+import static com.google.common.base.Preconditions.checkState;
+import static com.google.common.base.Verify.verify;
+import static com.google.common.base.Verify.verifyNotNull;
+import static java.util.Objects.requireNonNull;
+
import akka.actor.ActorRef;
import com.google.common.base.MoreObjects;
-import com.google.common.base.Optional;
-import com.google.common.base.Preconditions;
-import com.google.common.base.Throwables;
-import com.google.common.base.Verify;
import com.google.common.collect.Iterables;
-import com.google.common.util.concurrent.CheckedFuture;
+import com.google.common.util.concurrent.FluentFuture;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.SettableFuture;
import java.util.ArrayDeque;
import java.util.Deque;
import java.util.Iterator;
+import java.util.Optional;
+import java.util.OptionalLong;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.atomic.AtomicIntegerFieldUpdater;
import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
import java.util.function.Consumer;
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
-import javax.annotation.concurrent.GuardedBy;
-import javax.annotation.concurrent.NotThreadSafe;
+import org.checkerframework.checker.lock.qual.GuardedBy;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.controller.cluster.access.client.ConnectionEntry;
import org.opendaylight.controller.cluster.access.commands.AbstractLocalTransactionRequest;
+import org.opendaylight.controller.cluster.access.commands.ClosedTransactionException;
+import org.opendaylight.controller.cluster.access.commands.IncrementTransactionSequenceRequest;
+import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequest;
import org.opendaylight.controller.cluster.access.commands.TransactionAbortRequest;
import org.opendaylight.controller.cluster.access.commands.TransactionAbortSuccess;
import org.opendaylight.controller.cluster.access.commands.TransactionCanCommitSuccess;
@@ -43,8 +48,8 @@ import org.opendaylight.controller.cluster.access.concepts.Request;
import org.opendaylight.controller.cluster.access.concepts.RequestFailure;
import org.opendaylight.controller.cluster.access.concepts.Response;
import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
-import org.opendaylight.mdsal.common.api.ReadFailedException;
import org.opendaylight.yangtools.concepts.Identifiable;
+import org.opendaylight.yangtools.yang.common.Empty;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
import org.slf4j.Logger;
@@ -60,33 +65,43 @@ import org.slf4j.LoggerFactory;
*
* This class interacts with the queueing mechanism in ClientActorBehavior, hence once we arrive at a decision
* to use either a local or remote implementation, we are stuck with it. We can re-evaluate on the next transaction.
- *
- * @author Robert Varga
*/
-abstract class AbstractProxyTransaction implements Identifiable {
+abstract sealed class AbstractProxyTransaction implements Identifiable
+ permits LocalProxyTransaction, RemoteProxyTransaction {
/**
* Marker object used instead of read-type of requests, which are satisfied only once. This has a lower footprint
- * and allows compressing multiple requests into a single entry.
+ * and allows compressing multiple requests into a single entry. This class is not thread-safe.
*/
- @NotThreadSafe
private static final class IncrementSequence {
- private long delta = 1;
+ private final long sequence;
+ private long delta = 0;
+
+ IncrementSequence(final long sequence) {
+ this.sequence = sequence;
+ }
long getDelta() {
return delta;
}
+ long getSequence() {
+ return sequence;
+ }
+
void incrementDelta() {
delta++;
}
}
- // Generic state base class. Direct instances are used for fast paths, sub-class is used for successor transitions
+ /**
+ * Base class for representing logical state of this proxy. See individual instantiations and {@link SuccessorState}
+ * for details.
+ */
private static class State {
private final String string;
State(final String string) {
- this.string = Preconditions.checkNotNull(string);
+ this.string = requireNonNull(string);
}
@Override
@@ -95,14 +110,27 @@ abstract class AbstractProxyTransaction implements Identifiable
+ * When a user operation encounters this state, it synchronizes on the it and wait until reconnection completes,
+ * at which point the request is routed to the successor transaction. This is a relatively heavy-weight solution
+ * to the problem of state transfer, but the user will observe it only if the race condition is hit.
+ */
+ private static class SuccessorState extends State {
private final CountDownLatch latch = new CountDownLatch(1);
private AbstractProxyTransaction successor;
private State prevState;
+ // SUCCESSOR + DONE
+ private boolean done;
+
SuccessorState() {
- super("successor");
+ super("SUCCESSOR");
}
// Synchronize with succession process and return the successor
@@ -111,7 +139,7 @@ abstract class AbstractProxyTransaction implements Identifiable STATE_UPDATER =
AtomicReferenceFieldUpdater.newUpdater(AbstractProxyTransaction.class, State.class, "state");
- private static final State OPEN = new State("open");
- private static final State SEALED = new State("sealed");
- private static final State FLUSHED = new State("flushed");
+
+ /**
+ * Transaction has been open and is being actively worked on.
+ */
+ private static final State OPEN = new State("OPEN");
+
+ /**
+ * Transaction has been sealed by the user, but it has not completed flushing to the backed, yet. This is
+ * a transition state, as we are waiting for the user to initiate commit procedures.
+ *
+ *
+ * Since the reconnect mechanics relies on state replay for transactions, this state needs to be flushed into the
+ * queue to re-create state in successor transaction (which may be based on different messages as locality may have
+ * changed). Hence the transition to {@link #FLUSHED} state needs to be handled in a thread-safe manner.
+ */
+ private static final State SEALED = new State("SEALED");
+
+ /**
+ * Transaction state has been flushed into the queue, i.e. it is visible by the successor and potentially
+ * the backend. At this point the transaction does not hold any state besides successful requests, all other state
+ * is held either in the connection's queue or the successor object.
+ *
+ *
+ * Transition to this state indicates we have all input from the user we need to initiate the correct commit
+ * protocol.
+ */
+ private static final State FLUSHED = new State("FLUSHED");
+
+ /**
+ * Transaction state has been completely resolved, we have received confirmation of the transaction fate from
+ * the backend. The only remaining task left to do is finishing up the state cleanup, which is done via purge
+ * request. We need to hang on to the transaction until that is done, as we have to make sure backend completes
+ * purging its state -- otherwise we could have a leak on the backend.
+ */
+ private static final State DONE = new State("DONE");
// Touched from client actor thread only
private final Deque successfulRequests = new ArrayDeque<>();
@@ -180,18 +252,32 @@ abstract class AbstractProxyTransaction implements Identifiable {
+ command.run();
+ return behavior;
+ });
}
final ActorRef localActor() {
return parent.localActor();
}
- private void incrementSequence(final long delta) {
+ final void incrementSequence(final long delta) {
sequence += delta;
LOG.debug("Transaction {} incremented sequence to {}", this, sequence);
}
@@ -208,24 +294,24 @@ abstract class AbstractProxyTransaction implements Identifiable data) {
+ final void merge(final YangInstanceIdentifier path, final NormalizedNode data) {
checkReadWrite();
checkNotSealed();
doMerge(path, data);
}
- final void write(final YangInstanceIdentifier path, final NormalizedNode, ?> data) {
+ final void write(final YangInstanceIdentifier path, final NormalizedNode data) {
checkReadWrite();
checkNotSealed();
doWrite(path, data);
}
- final CheckedFuture exists(final YangInstanceIdentifier path) {
+ final FluentFuture exists(final YangInstanceIdentifier path) {
checkNotSealed();
return doExists(path);
}
- final CheckedFuture>, ReadFailedException> read(final YangInstanceIdentifier path) {
+ final FluentFuture> read(final YangInstanceIdentifier path) {
checkNotSealed();
return doRead(path);
}
@@ -242,49 +328,90 @@ abstract class AbstractProxyTransaction implements Identifiable optState = flushState();
+ if (optState.isPresent()) {
+ forwardToSuccessor(successor, optState.orElseThrow(), null);
}
+ successor.predecessorSealed();
}
- private void internalSeal() {
- doSeal();
- parent.onTransactionSealed(this);
+ private void predecessorSealed() {
+ if (markSealed() && !sealAndSend(OptionalLong.empty())) {
+ sealSuccessor();
+ }
+ }
- // Now deal with state transfer, which can occur via successor or a follow-up canCommit() or directCommit().
- if (!STATE_UPDATER.compareAndSet(this, OPEN, SEALED)) {
- // Slow path: wait for the successor to complete
- final AbstractProxyTransaction successor = awaitSuccessor();
+ /**
+ * Seal this transaction. If this method reports false, the caller needs to deal with propagating the seal operation
+ * towards the successor.
+ *
+ * @return True if seal operation was successful, false if this proxy has a successor.
+ */
+ boolean sealOnly() {
+ return sealState();
+ }
- // At this point the successor has completed transition and is possibly visible by the user thread, which is
- // still stuck here. The successor has not seen final part of our state, nor the fact it is sealed.
- // Propagate state and seal the successor.
- flushState(successor);
- successor.ensureSealed();
- }
+ /**
+ * Seal this transaction and potentially send it out towards the backend. If this method reports false, the caller
+ * needs to deal with propagating the seal operation towards the successor.
+ *
+ * @param enqueuedTicks Enqueue ticks when this is invoked from replay path.
+ * @return True if seal operation was successful, false if this proxy has a successor.
+ */
+ boolean sealAndSend(final OptionalLong enqueuedTicks) {
+ return sealState();
+ }
+
+ private boolean sealState() {
+ parent.onTransactionSealed(this);
+ // Transition internal state to sealed and detect presence of a successor
+ return STATE_UPDATER.compareAndSet(this, OPEN, SEALED);
+ }
+
+ /**
+ * Mark this proxy as having been sealed.
+ *
+ * @return True if this call has transitioned to sealed state.
+ */
+ final boolean markSealed() {
+ return SEALED_UPDATER.compareAndSet(this, 0, 1);
}
private void checkNotSealed() {
- Preconditions.checkState(sealed == 0, "Transaction %s has already been sealed", getIdentifier());
+ checkState(sealed == 0, "Transaction %s has already been sealed", getIdentifier());
}
private void checkSealed() {
- Preconditions.checkState(sealed != 0, "Transaction %s has not been sealed yet", getIdentifier());
+ checkState(sealed != 0, "Transaction %s has not been sealed yet", getIdentifier());
}
private SuccessorState getSuccessorState() {
final State local = state;
- Verify.verify(local instanceof SuccessorState, "State %s has unexpected class", local);
+ verify(local instanceof SuccessorState, "State %s has unexpected class", local);
return (SuccessorState) local;
}
@@ -294,16 +421,16 @@ abstract class AbstractProxyTransaction implements Identifiable req) {
- successfulRequests.add(Verify.verifyNotNull(req));
+ final void recordSuccessfulRequest(final @NonNull TransactionRequest> req) {
+ successfulRequests.add(verifyNotNull(req));
}
- final void recordFinishedRequest() {
+ final void recordFinishedRequest(final Response, ?> response) {
final Object last = successfulRequests.peekLast();
if (last instanceof IncrementSequence) {
((IncrementSequence) last).incrementDelta();
} else {
- successfulRequests.addLast(new IncrementSequence());
+ successfulRequests.addLast(new IncrementSequence(response.getSequence()));
}
}
@@ -313,34 +440,51 @@ abstract class AbstractProxyTransaction implements Identifiable {
+ LOG.debug("Transaction {} abort completed with {}", getIdentifier(), resp);
+ enqueuePurge();
+ });
}
- final void abort(final VotingFuture ret) {
+ final void abort(final VotingFuture ret) {
checkSealed();
- sendAbort(t -> {
+ sendDoAbort(t -> {
if (t instanceof TransactionAbortSuccess) {
ret.voteYes();
} else if (t instanceof RequestFailure) {
ret.voteNo(((RequestFailure, ?>) t).getCause().unwrap());
} else {
- ret.voteNo(new IllegalStateException("Unhandled response " + t.getClass()));
+ ret.voteNo(unhandledResponseException(t));
}
// This is a terminal request, hence we do not need to record it
LOG.debug("Transaction {} abort completed", this);
- sendPurge();
+ enqueuePurge();
});
}
final void enqueueAbort(final Consumer> callback, final long enqueuedTicks) {
+ checkNotSealed();
+ parent.abortTransaction(this);
+
+ enqueueRequest(abortRequest(), resp -> {
+ LOG.debug("Transaction {} abort completed with {}", getIdentifier(), resp);
+ // Purge will be sent by the predecessor's callback
+ if (callback != null) {
+ callback.accept(resp);
+ }
+ }, enqueuedTicks);
+ }
+
+ final void enqueueDoAbort(final Consumer> callback, final long enqueuedTicks) {
enqueueRequest(new TransactionAbortRequest(getIdentifier(), nextSequence(), localActor()), callback,
enqueuedTicks);
}
- final void sendAbort(final Consumer> callback) {
+ final void sendDoAbort(final Consumer> callback) {
sendRequest(new TransactionAbortRequest(getIdentifier(), nextSequence(), localActor()), callback);
}
@@ -358,18 +502,25 @@ abstract class AbstractProxyTransaction implements Identifiable ret = SettableFuture.create();
- sendRequest(Verify.verifyNotNull(commitRequest(false)), t -> {
+ sendRequest(verifyNotNull(commitRequest(false)), t -> {
if (t instanceof TransactionCommitSuccess) {
ret.set(Boolean.TRUE);
} else if (t instanceof RequestFailure) {
- ret.setException(((RequestFailure, ?>) t).getCause().unwrap());
+ final Throwable cause = ((RequestFailure, ?>) t).getCause().unwrap();
+ if (cause instanceof ClosedTransactionException) {
+ // This is okay, as it indicates the transaction has been completed. It can happen
+ // when we lose connectivity with the backend after it has received the request.
+ ret.set(Boolean.TRUE);
+ } else {
+ ret.setException(cause);
+ }
} else {
- ret.setException(new IllegalStateException("Unhandled response " + t.getClass()));
+ ret.setException(unhandledResponseException(t));
}
// This is a terminal request, hence we do not need to record it
LOG.debug("Transaction {} directCommit completed", this);
- sendPurge();
+ enqueuePurge();
});
return ret;
@@ -387,7 +538,7 @@ abstract class AbstractProxyTransaction implements Identifiable req = Verify.verifyNotNull(commitRequest(true));
+ final TransactionRequest> req = verifyNotNull(commitRequest(true));
sendRequest(req, t -> {
if (t instanceof TransactionCanCommitSuccess) {
@@ -395,7 +546,7 @@ abstract class AbstractProxyTransaction implements Identifiable) t).getCause().unwrap());
} else {
- ret.voteNo(new IllegalStateException("Unhandled response " + t.getClass()));
+ ret.voteNo(unhandledResponseException(t));
}
recordSuccessfulRequest(req);
@@ -426,7 +577,7 @@ abstract class AbstractProxyTransaction implements Identifiable) t).getCause().unwrap());
} else {
- ret.voteNo(new IllegalStateException("Unhandled response " + t.getClass()));
+ ret.voteNo(unhandledResponseException(t));
}
onPreCommitComplete(req);
@@ -459,31 +610,49 @@ abstract class AbstractProxyTransaction implements Identifiable) t).getCause().unwrap());
} else {
- ret.voteNo(new IllegalStateException("Unhandled response " + t.getClass()));
+ ret.voteNo(unhandledResponseException(t));
}
LOG.debug("Transaction {} doCommit completed", this);
- sendPurge();
+
+ // Needed for ProxyHistory$Local data tree rebase points.
+ parent.completeTransaction(this);
+
+ enqueuePurge();
});
}
- final void sendPurge() {
- successfulRequests.clear();
+ private void enqueuePurge() {
+ enqueuePurge(null);
+ }
- final TransactionRequest> req = new TransactionPurgeRequest(getIdentifier(), nextSequence(), localActor());
- sendRequest(req, t -> {
- LOG.debug("Transaction {} purge completed", this);
- parent.completeTransaction(this);
- });
+ final void enqueuePurge(final Consumer> callback) {
+ // Purge request are dispatched internally, hence should not wait
+ enqueuePurge(callback, parent.currentTime());
}
- final void enqueuePurge(final long enqueuedTicks) {
+ final void enqueuePurge(final Consumer> callback, final long enqueuedTicks) {
+ LOG.debug("{}: initiating purge", this);
+
+ final State prev = state;
+ if (prev instanceof SuccessorState) {
+ ((SuccessorState) prev).setDone();
+ } else {
+ final boolean success = STATE_UPDATER.compareAndSet(this, prev, DONE);
+ if (!success) {
+ LOG.warn("{}: moved from state {} while we were purging it", this, prev);
+ }
+ }
+
successfulRequests.clear();
- final TransactionRequest> req = new TransactionPurgeRequest(getIdentifier(), nextSequence(), localActor());
- enqueueRequest(req, t -> {
- LOG.debug("Transaction {} purge completed", this);
- parent.completeTransaction(this);
+ enqueueRequest(new TransactionPurgeRequest(getIdentifier(), nextSequence(), localActor()), resp -> {
+ LOG.debug("{}: purge completed", this);
+ parent.purgeTransaction(this);
+
+ if (callback != null) {
+ callback.accept(resp);
+ }
}, enqueuedTicks);
}
@@ -495,7 +664,7 @@ abstract class AbstractProxyTransaction implements Identifiable enqueuedEntries) {
+ final void replayMessages(final ProxyHistory successorHistory, final Iterable enqueuedEntries) {
final SuccessorState local = getSuccessorState();
+ final State prevState = local.getPrevState();
+
+ final AbstractProxyTransaction successor = successorHistory.createTransactionProxy(getIdentifier(),
+ isSnapshotOnly(), local.isDone());
+ LOG.debug("{} created successor {}", this, successor);
local.setSuccessor(successor);
// Replay successful requests first
@@ -522,10 +695,14 @@ abstract class AbstractProxyTransaction implements Identifiable) obj, resp -> { }, now);
+ successor.doReplayRequest((TransactionRequest>) obj, resp -> { /*NOOP*/ }, now);
} else {
- Verify.verify(obj instanceof IncrementSequence);
- successor.incrementSequence(((IncrementSequence) obj).getDelta());
+ verify(obj instanceof IncrementSequence);
+ final IncrementSequence increment = (IncrementSequence) obj;
+ successor.doReplayRequest(new IncrementTransactionSequenceRequest(getIdentifier(),
+ increment.getSequence(), localActor(), isSnapshotOnly(),
+ increment.getDelta()), resp -> { /*NOOP*/ }, now);
+ LOG.debug("Incrementing sequence {} to successor {}", obj, successor);
}
}
LOG.debug("{} replayed {} successful requests", getIdentifier(), successfulRequests.size());
@@ -539,9 +716,9 @@ abstract class AbstractProxyTransaction implements Identifiable req = e.getRequest();
if (getIdentifier().equals(req.getTarget())) {
- Verify.verify(req instanceof TransactionRequest, "Unhandled request %s", req);
+ verify(req instanceof TransactionRequest, "Unhandled request %s", req);
LOG.debug("Replaying queued request {} to successor {}", req, successor);
- successor.replayRequest((TransactionRequest>) req, e.getCallback(), e.getEnqueuedTicks());
+ successor.doReplayRequest((TransactionRequest>) req, e.getCallback(), e.getEnqueuedTicks());
it.remove();
}
}
@@ -551,11 +728,16 @@ abstract class AbstractProxyTransaction implements Identifiable optState = flushState();
+ if (optState.isPresent()) {
+ successor.handleReplayedRemoteRequest(optState.orElseThrow(), null, enqueuedTicks);
+ }
+ if (successor.markSealed()) {
+ successor.sealAndSend(OptionalLong.of(enqueuedTicks));
+ }
}
}
@@ -570,7 +752,7 @@ abstract class AbstractProxyTransaction implements Identifiable request, final Consumer> callback,
+ private void doReplayRequest(final TransactionRequest> request, final Consumer> callback,
final long enqueuedTicks) {
if (request instanceof AbstractLocalTransactionRequest) {
handleReplayedLocalRequest((AbstractLocalTransactionRequest>) request, callback, enqueuedTicks);
@@ -610,24 +792,27 @@ abstract class AbstractProxyTransaction implements Identifiable request, final Consumer> callback,
+ final long enqueuedTicks) {
+ getSuccessorState().getSuccessor().doReplayRequest(request, callback, enqueuedTicks);
+ }
+
abstract boolean isSnapshotOnly();
abstract void doDelete(YangInstanceIdentifier path);
- abstract void doMerge(YangInstanceIdentifier path, NormalizedNode, ?> data);
-
- abstract void doWrite(YangInstanceIdentifier path, NormalizedNode, ?> data);
+ abstract void doMerge(YangInstanceIdentifier path, NormalizedNode data);
- abstract CheckedFuture doExists(YangInstanceIdentifier path);
+ abstract void doWrite(YangInstanceIdentifier path, NormalizedNode data);
- abstract CheckedFuture>, ReadFailedException> doRead(YangInstanceIdentifier path);
+ abstract FluentFuture doExists(YangInstanceIdentifier path);
- abstract void doSeal();
-
- abstract void doAbort();
+ abstract FluentFuture> doRead(YangInstanceIdentifier path);
@GuardedBy("this")
- abstract void flushState(AbstractProxyTransaction successor);
+ abstract Optional flushState();
+
+ abstract TransactionRequest> abortRequest();
abstract TransactionRequest> commitRequest(boolean coordinated);
@@ -669,6 +854,14 @@ abstract class AbstractProxyTransaction implements Identifiable request,
@Nullable Consumer> callback, long enqueuedTicks);
+ static final @NonNull IllegalArgumentException unhandledRequest(final TransactionRequest> request) {
+ return new IllegalArgumentException("Unhandled request " + request);
+ }
+
+ private static @NonNull IllegalStateException unhandledResponseException(final Response, ?> resp) {
+ return new IllegalStateException("Unhandled response " + resp.getClass());
+ }
+
@Override
public final String toString() {
return MoreObjects.toStringHelper(this).add("identifier", getIdentifier()).add("state", state).toString();