*/
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.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;
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;
abstract class AbstractProxyTransaction implements Identifiable<TransactionIdentifier> {
/**
* 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 final long sequence;
private long delta = 0;
private final String string;
State(final String string) {
- this.string = Preconditions.checkNotNull(string);
+ this.string = requireNonNull(string);
}
@Override
}
State getPrevState() {
- return Verify.verifyNotNull(prevState, "Attempted to access previous state, which was not set");
+ return verifyNotNull(prevState, "Attempted to access previous state, which was not set");
}
void setPrevState(final State prevState) {
- Verify.verify(this.prevState == null, "Attempted to set previous state to %s when we already have %s",
- prevState, this.prevState);
- this.prevState = Preconditions.checkNotNull(prevState);
+ verify(this.prevState == null, "Attempted to set previous state to %s when we already have %s", prevState,
+ this.prevState);
+ this.prevState = requireNonNull(prevState);
// We cannot have duplicate successor states, so this check is sufficient
- this.done = DONE.equals(prevState);
+ done = DONE.equals(prevState);
}
// To be called from safe contexts, where successor is known to be completed
AbstractProxyTransaction getSuccessor() {
- return Verify.verifyNotNull(successor);
+ return verifyNotNull(successor);
}
void setSuccessor(final AbstractProxyTransaction successor) {
- Verify.verify(this.successor == null, "Attempted to set successor to %s when we already have %s",
- successor, this.successor);
- this.successor = Preconditions.checkNotNull(successor);
+ verify(this.successor == null, "Attempted to set successor to %s when we already have %s", successor,
+ this.successor);
+ this.successor = requireNonNull(successor);
}
boolean isDone() {
private volatile State state;
AbstractProxyTransaction(final ProxyHistory parent, final boolean isDone) {
- this.parent = Preconditions.checkNotNull(parent);
+ this.parent = requireNonNull(parent);
if (isDone) {
state = DONE;
// DONE implies previous seal operation completed
doDelete(path);
}
- final void merge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> 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<Boolean, ReadFailedException> exists(final YangInstanceIdentifier path) {
+ final FluentFuture<Boolean> exists(final YangInstanceIdentifier path) {
checkNotSealed();
return doExists(path);
}
- final CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> read(final YangInstanceIdentifier path) {
+ final FluentFuture<Optional<NormalizedNode>> read(final YangInstanceIdentifier path) {
checkNotSealed();
return doRead(path);
}
final void seal() {
// Transition user-visible state first
final boolean success = markSealed();
- Preconditions.checkState(success, "Proxy %s was already sealed", getIdentifier());
+ checkState(success, "Proxy %s was already sealed", getIdentifier());
- if (!sealAndSend(Optional.absent())) {
+ if (!sealAndSend(OptionalLong.empty())) {
sealSuccessor();
}
}
// 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);
+ final Optional<ModifyTransactionRequest> optState = flushState();
+ if (optState.isPresent()) {
+ forwardToSuccessor(successor, optState.get(), null);
+ }
successor.predecessorSealed();
}
private void predecessorSealed() {
- if (markSealed() && !sealAndSend(Optional.absent())) {
+ if (markSealed() && !sealAndSend(OptionalLong.empty())) {
sealSuccessor();
}
}
- void sealOnly() {
- parent.onTransactionSealed(this);
- final boolean success = STATE_UPDATER.compareAndSet(this, OPEN, SEALED);
- Verify.verify(success, "Attempted to replay seal on %s", this);
+ /**
+ * 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();
}
/**
* @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 Optional<Long> enqueuedTicks) {
- parent.onTransactionSealed(this);
+ 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);
}
}
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;
}
}
}
- final void recordSuccessfulRequest(final @Nonnull TransactionRequest<?> req) {
- successfulRequests.add(Verify.verifyNotNull(req));
+ final void recordSuccessfulRequest(final @NonNull TransactionRequest<?> req) {
+ successfulRequests.add(verifyNotNull(req));
}
final void recordFinishedRequest(final Response<?, ?> response) {
});
}
- final void abort(final VotingFuture<Void> ret) {
+ final void abort(final VotingFuture<Empty> ret) {
checkSealed();
sendDoAbort(t -> {
} 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
synchronized (this) {
if (STATE_UPDATER.compareAndSet(this, SEALED, FLUSHED)) {
final SettableFuture<Boolean> 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(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
// Precludes startReconnect() from interfering with the fast path
synchronized (this) {
if (STATE_UPDATER.compareAndSet(this, SEALED, FLUSHED)) {
- final TransactionRequest<?> req = Verify.verifyNotNull(commitRequest(true));
+ final TransactionRequest<?> req = verifyNotNull(commitRequest(true));
sendRequest(req, t -> {
if (t instanceof TransactionCanCommitSuccess) {
} else if (t instanceof RequestFailure) {
ret.voteNo(((RequestFailure<?, ?>) t).getCause().unwrap());
} else {
- ret.voteNo(new IllegalStateException("Unhandled response " + t.getClass()));
+ ret.voteNo(unhandledResponseException(t));
}
recordSuccessfulRequest(req);
} else if (t instanceof RequestFailure) {
ret.voteNo(((RequestFailure<?, ?>) t).getCause().unwrap());
} else {
- ret.voteNo(new IllegalStateException("Unhandled response " + t.getClass()));
+ ret.voteNo(unhandledResponseException(t));
}
onPreCommitComplete(req);
} else if (t instanceof RequestFailure) {
ret.voteNo(((RequestFailure<?, ?>) t).getCause().unwrap());
} else {
- ret.voteNo(new IllegalStateException("Unhandled response " + t.getClass()));
+ ret.voteNo(unhandledResponseException(t));
}
LOG.debug("Transaction {} doCommit completed", this);
final State prevState = STATE_UPDATER.getAndSet(this, nextState);
LOG.debug("Start reconnect of proxy {} previous state {}", this, prevState);
- Verify.verify(!(prevState instanceof SuccessorState), "Proxy %s duplicate reconnect attempt after %s", this,
+ verify(!(prevState instanceof SuccessorState), "Proxy %s duplicate reconnect attempt after %s", this,
prevState);
// We have asserted a slow-path state, seal(), canCommit(), directCommit() are forced to slow paths, which will
for (Object obj : successfulRequests) {
if (obj instanceof TransactionRequest) {
LOG.debug("Forwarding successful request {} to successor {}", obj, successor);
- successor.doReplayRequest((TransactionRequest<?>) obj, resp -> { }, now);
+ successor.doReplayRequest((TransactionRequest<?>) obj, resp -> { /*NOOP*/ }, now);
} else {
- Verify.verify(obj instanceof IncrementSequence);
+ verify(obj instanceof IncrementSequence);
final IncrementSequence increment = (IncrementSequence) obj;
successor.doReplayRequest(new IncrementTransactionSequenceRequest(getIdentifier(),
- increment.getSequence(), localActor(), isSnapshotOnly(), increment.getDelta()), resp -> { },
- now);
+ increment.getSequence(), localActor(), isSnapshotOnly(),
+ increment.getDelta()), resp -> { /*NOOP*/ }, now);
LOG.debug("Incrementing sequence {} to successor {}", obj, successor);
}
}
final Request<?, ?> 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.doReplayRequest((TransactionRequest<?>) req, e.getCallback(), e.getEnqueuedTicks());
it.remove();
*/
if (SEALED.equals(prevState)) {
LOG.debug("Proxy {} reconnected while being sealed, propagating state to successor {}", this, successor);
- flushState(successor);
+ final long enqueuedTicks = parent.currentTime();
+ final Optional<ModifyTransactionRequest> optState = flushState();
+ if (optState.isPresent()) {
+ successor.handleReplayedRemoteRequest(optState.get(), null, enqueuedTicks);
+ }
if (successor.markSealed()) {
- successor.sealAndSend(Optional.of(parent.currentTime()));
+ successor.sealAndSend(OptionalLong.of(enqueuedTicks));
}
}
}
abstract void doDelete(YangInstanceIdentifier path);
- abstract void doMerge(YangInstanceIdentifier path, NormalizedNode<?, ?> data);
+ abstract void doMerge(YangInstanceIdentifier path, NormalizedNode data);
- abstract void doWrite(YangInstanceIdentifier path, NormalizedNode<?, ?> data);
+ abstract void doWrite(YangInstanceIdentifier path, NormalizedNode data);
- abstract CheckedFuture<Boolean, ReadFailedException> doExists(YangInstanceIdentifier path);
+ abstract FluentFuture<Boolean> doExists(YangInstanceIdentifier path);
- abstract CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> doRead(YangInstanceIdentifier path);
+ abstract FluentFuture<Optional<NormalizedNode>> doRead(YangInstanceIdentifier path);
@GuardedBy("this")
- abstract void flushState(AbstractProxyTransaction successor);
+ abstract Optional<ModifyTransactionRequest> flushState();
abstract TransactionRequest<?> abortRequest();
abstract void handleReplayedRemoteRequest(TransactionRequest<?> request,
@Nullable Consumer<Response<?, ?>> callback, long enqueuedTicks);
+ private static 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();
Code Review / controller.git / blobdiff