import com.google.common.util.concurrent.CheckedFuture;
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.function.Consumer;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
import org.opendaylight.controller.cluster.access.commands.TransactionAbortRequest;
import org.opendaylight.controller.cluster.access.commands.TransactionAbortSuccess;
import org.opendaylight.controller.cluster.access.commands.TransactionCanCommitSuccess;
import org.opendaylight.controller.cluster.access.commands.TransactionPreCommitRequest;
import org.opendaylight.controller.cluster.access.commands.TransactionPreCommitSuccess;
import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
+import org.opendaylight.controller.cluster.access.concepts.RequestException;
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.controller.md.sal.common.api.data.ReadFailedException;
+import org.opendaylight.mdsal.common.api.ReadFailedException;
import org.opendaylight.yangtools.concepts.Identifiable;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
/**
* Class translating transaction operations towards a particular backend shard.
*
+ * <p>
* This class is not safe to access from multiple application threads, as is usual for transactions. Internal state
* transitions coming from interactions with backend are expected to be thread-safe.
*
+ * <p>
* 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<TransactionIdentifier> {
- private final DistributedDataStoreClientBehavior client;
+ private static final class IncrementSequence {
+ private long delta = 1;
+ long getDelta() {
+ return delta;
+ }
+
+ void incrementDelta() {
+ delta++;
+ }
+ }
+
+ private static final Logger LOG = LoggerFactory.getLogger(AbstractProxyTransaction.class);
+
+ private final Deque<Object> successfulRequests = new ArrayDeque<>();
+ private final ProxyHistory parent;
+
+ private AbstractProxyTransaction successor;
private long sequence;
private boolean sealed;
- AbstractProxyTransaction(final DistributedDataStoreClientBehavior client) {
- this.client = Preconditions.checkNotNull(client);
+ AbstractProxyTransaction(final ProxyHistory parent) {
+ this.parent = Preconditions.checkNotNull(parent);
}
final ActorRef localActor() {
- return client.self();
+ return parent.localActor();
+ }
+
+ private void incrementSequence(final long delta) {
+ sequence += delta;
+ LOG.debug("Transaction {} incremented sequence to {}", this, sequence);
}
final long nextSequence() {
- return sequence++;
+ final long ret = sequence++;
+ LOG.debug("Transaction {} allocated sequence {}", this, ret);
+ return ret;
}
final void delete(final YangInstanceIdentifier path) {
- checkSealed();
+ checkNotSealed();
doDelete(path);
}
final void merge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
- checkSealed();
+ checkNotSealed();
doMerge(path, data);
}
final void write(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
- checkSealed();
+ checkNotSealed();
doWrite(path, data);
}
final CheckedFuture<Boolean, ReadFailedException> exists(final YangInstanceIdentifier path) {
- checkSealed();
+ checkNotSealed();
return doExists(path);
}
final CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> read(final YangInstanceIdentifier path) {
- checkSealed();
+ checkNotSealed();
return doRead(path);
}
- final void sendRequest(final TransactionRequest<?> request, final Consumer<Response<?, ?>> completer) {
- client.sendRequest(request, completer);
+ final void sendRequest(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback) {
+ LOG.debug("Transaction proxy {} sending request {} callback {}", this, request, callback);
+ parent.sendRequest(request, callback);
}
/**
- * Seal this transaction before it is either
+ * Seal this transaction before it is either committed or aborted.
*/
final void seal() {
- checkSealed();
+ checkNotSealed();
doSeal();
sealed = true;
+ parent.onTransactionSealed(this);
+ }
+
+ private void checkNotSealed() {
+ Preconditions.checkState(!sealed, "Transaction %s has already been sealed", getIdentifier());
}
private void checkSealed() {
Preconditions.checkState(sealed, "Transaction %s has not been sealed yet", getIdentifier());
}
+ final void recordSuccessfulRequest(final @Nonnull TransactionRequest<?> req) {
+ successfulRequests.add(Verify.verifyNotNull(req));
+ }
+
+ final void recordFinishedRequest() {
+ final Object last = successfulRequests.peekLast();
+ if (last instanceof IncrementSequence) {
+ ((IncrementSequence) last).incrementDelta();
+ } else {
+ successfulRequests.addLast(new IncrementSequence());
+ }
+ }
+
/**
* Abort this transaction. This is invoked only for read-only transactions and will result in an explicit message
* being sent to the backend.
*/
final void abort() {
- checkSealed();
+ checkNotSealed();
doAbort();
+ parent.abortTransaction(this);
+ }
+
+ final void abort(final VotingFuture<Void> ret) {
+ checkSealed();
+
+ sendAbort(t -> {
+ if (t instanceof TransactionAbortSuccess) {
+ ret.voteYes();
+ } else if (t instanceof RequestFailure) {
+ ret.voteNo(((RequestFailure<?, ?>) t).getCause());
+ } else {
+ ret.voteNo(new IllegalStateException("Unhandled response " + t.getClass()));
+ }
+
+ // This is a terminal request, hence we do not need to record it
+ LOG.debug("Transaction {} abort completed", this);
+ parent.completeTransaction(this);
+ });
+ }
+
+ final void sendAbort(final Consumer<Response<?, ?>> callback) {
+ sendRequest(new TransactionAbortRequest(getIdentifier(), nextSequence(), localActor()), callback);
}
/**
checkSealed();
final SettableFuture<Boolean> ret = SettableFuture.create();
- sendRequest(Verify.verifyNotNull(doCommit(false)), t -> {
+ sendRequest(Verify.verifyNotNull(commitRequest(false)), t -> {
if (t instanceof TransactionCommitSuccess) {
ret.set(Boolean.TRUE);
} else if (t instanceof RequestFailure) {
} else {
ret.setException(new IllegalStateException("Unhandled response " + t.getClass()));
}
+
+ // This is a terminal request, hence we do not need to record it
+ LOG.debug("Transaction {} directCommit completed", this);
+ parent.completeTransaction(this);
});
return ret;
}
- void abort(final VotingFuture<Void> ret) {
- checkSealed();
-
- sendRequest(new TransactionAbortRequest(getIdentifier(), nextSequence(), localActor()), t -> {
- if (t instanceof TransactionAbortSuccess) {
- ret.voteYes();
- } else if (t instanceof RequestFailure) {
- ret.voteNo(((RequestFailure<?, ?>) t).getCause());
- } else {
- ret.voteNo(new IllegalStateException("Unhandled response " + t.getClass()));
- }
- });
- }
void canCommit(final VotingFuture<?> ret) {
checkSealed();
- sendRequest(Verify.verifyNotNull(doCommit(true)), t -> {
+ final TransactionRequest<?> req = Verify.verifyNotNull(commitRequest(true));
+ sendRequest(req, t -> {
if (t instanceof TransactionCanCommitSuccess) {
ret.voteYes();
} else if (t instanceof RequestFailure) {
} else {
ret.voteNo(new IllegalStateException("Unhandled response " + t.getClass()));
}
+
+ recordSuccessfulRequest(req);
+ LOG.debug("Transaction {} canCommit completed", this);
});
}
void preCommit(final VotingFuture<?> ret) {
checkSealed();
- sendRequest(new TransactionPreCommitRequest(getIdentifier(), nextSequence(), localActor()), t-> {
+ final TransactionRequest<?> req = new TransactionPreCommitRequest(getIdentifier(), nextSequence(),
+ localActor());
+ sendRequest(req, t -> {
if (t instanceof TransactionPreCommitSuccess) {
ret.voteYes();
} else if (t instanceof RequestFailure) {
} else {
ret.voteNo(new IllegalStateException("Unhandled response " + t.getClass()));
}
+
+ recordSuccessfulRequest(req);
+ LOG.debug("Transaction {} preCommit completed", this);
});
}
void doCommit(final VotingFuture<?> ret) {
checkSealed();
- sendRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), t-> {
+ sendRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), t -> {
if (t instanceof TransactionCommitSuccess) {
ret.voteYes();
} else if (t instanceof RequestFailure) {
} else {
ret.voteNo(new IllegalStateException("Unhandled response " + t.getClass()));
}
+
+ LOG.debug("Transaction {} doCommit completed", this);
+ parent.completeTransaction(this);
});
}
+ final void replaySuccessfulRequests(final AbstractProxyTransaction successor) {
+ this.successor = Preconditions.checkNotNull(successor);
+
+ for (Object obj : successfulRequests) {
+ if (obj instanceof TransactionRequest) {
+ LOG.debug("Forwarding request {} to successor {}", obj, successor);
+ successor.handleForwardedRemoteRequest((TransactionRequest<?>) obj, null);
+ } else {
+ Verify.verify(obj instanceof IncrementSequence);
+ successor.incrementSequence(((IncrementSequence) obj).getDelta());
+ }
+ }
+ LOG.debug("{} replayed {} successful requests", getIdentifier(), successfulRequests.size());
+ successfulRequests.clear();
+ }
+
+ /**
+ * Invoked from a retired connection for requests which have been in-flight and need to be re-adjusted
+ * and forwarded to the successor connection.
+ *
+ * @param request Request to be forwarded
+ * @param callback Original callback
+ * @throws RequestException when the request is unhandled by the successor
+ */
+ final void replayRequest(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback)
+ throws RequestException {
+ Preconditions.checkState(successor != null, "%s does not have a successor set", this);
+
+ if (successor instanceof LocalProxyTransaction) {
+ forwardToLocal((LocalProxyTransaction)successor, request, callback);
+ } else if (successor instanceof RemoteProxyTransaction) {
+ forwardToRemote((RemoteProxyTransaction)successor, request, callback);
+ } else {
+ throw new IllegalStateException("Unhandled successor " + successor);
+ }
+ }
+
abstract void doDelete(final YangInstanceIdentifier path);
abstract void doMerge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data);
abstract CheckedFuture<Boolean, ReadFailedException> doExists(final YangInstanceIdentifier path);
- abstract CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> doRead(final YangInstanceIdentifier path);
+ abstract CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> doRead(
+ final YangInstanceIdentifier path);
abstract void doSeal();
abstract void doAbort();
- abstract TransactionRequest<?> doCommit(boolean coordinated);
+ abstract TransactionRequest<?> commitRequest(boolean coordinated);
+
+ /**
+ * Invoked from {@link RemoteProxyTransaction} when it replays its successful requests to its successor. There is
+ * no equivalent of this call from {@link LocalProxyTransaction} because it does not send a request until all
+ * operations are packaged in the message.
+ *
+ * <p>
+ * Note: this method is invoked by the predecessor on the successor.
+ *
+ * @param request Request which needs to be forwarded
+ * @param callback Callback to be invoked once the request completes
+ */
+ abstract void handleForwardedRemoteRequest(TransactionRequest<?> request,
+ @Nullable Consumer<Response<?, ?>> callback);
+
+ /**
+ * Replay a request originating in this proxy to a successor remote proxy.
+ */
+ abstract void forwardToRemote(RemoteProxyTransaction successor, TransactionRequest<?> request,
+ Consumer<Response<?, ?>> callback) throws RequestException;
+
+ /**
+ * Replay a request originating in this proxy to a successor local proxy.
+ */
+ abstract void forwardToLocal(LocalProxyTransaction successor, TransactionRequest<?> request,
+ Consumer<Response<?, ?>> callback) throws RequestException;
}
Code Review / controller.git / blobdiff