*/
package org.opendaylight.controller.cluster.databroker.actors.dds;
-import com.google.common.base.Preconditions;
-import com.google.common.base.Verify;
+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 com.google.common.util.concurrent.FluentFuture;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import java.util.Optional;
+import java.util.OptionalLong;
+import java.util.function.BiConsumer;
import java.util.function.Consumer;
-import javax.annotation.Nullable;
-import javax.annotation.concurrent.NotThreadSafe;
+import java.util.function.Supplier;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
+import org.opendaylight.controller.cluster.access.commands.AbortLocalTransactionRequest;
+import org.opendaylight.controller.cluster.access.commands.AbstractLocalTransactionRequest;
import org.opendaylight.controller.cluster.access.commands.CommitLocalTransactionRequest;
+import org.opendaylight.controller.cluster.access.commands.ExistsTransactionRequest;
import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequest;
+import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequestBuilder;
import org.opendaylight.controller.cluster.access.commands.PersistenceProtocol;
+import org.opendaylight.controller.cluster.access.commands.ReadTransactionRequest;
import org.opendaylight.controller.cluster.access.commands.TransactionAbortRequest;
import org.opendaylight.controller.cluster.access.commands.TransactionDelete;
import org.opendaylight.controller.cluster.access.commands.TransactionDoCommitRequest;
import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
import org.opendaylight.controller.cluster.access.commands.TransactionWrite;
import org.opendaylight.controller.cluster.access.concepts.Response;
+import org.opendaylight.controller.cluster.access.concepts.RuntimeRequestException;
import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
import org.opendaylight.controller.cluster.datastore.util.AbstractDataTreeModificationCursor;
+import org.opendaylight.mdsal.common.api.ReadFailedException;
+import org.opendaylight.yangtools.util.concurrent.FluentFutures;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
-import org.opendaylight.yangtools.yang.data.api.schema.tree.CursorAwareDataTreeModification;
-import org.opendaylight.yangtools.yang.data.api.schema.tree.CursorAwareDataTreeSnapshot;
-import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
-import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModificationCursor;
-import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
+import org.opendaylight.yangtools.yang.data.tree.api.CursorAwareDataTreeModification;
+import org.opendaylight.yangtools.yang.data.tree.api.CursorAwareDataTreeSnapshot;
+import org.opendaylight.yangtools.yang.data.tree.api.DataTreeModification;
+import org.opendaylight.yangtools.yang.data.tree.api.DataTreeModificationCursor;
+import org.opendaylight.yangtools.yang.data.tree.api.DataTreeSnapshot;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* An {@link AbstractProxyTransaction} for dispatching a transaction towards a shard leader which is co-located with
- * the client instance.
+ * the client instance. This class is NOT thread-safe.
*
* <p>
* It requires a {@link DataTreeSnapshot}, which is used to instantiated a new {@link DataTreeModification}. Operations
*
* @author Robert Varga
*/
-@NotThreadSafe
final class LocalReadWriteProxyTransaction extends LocalProxyTransaction {
private static final Logger LOG = LoggerFactory.getLogger(LocalReadWriteProxyTransaction.class);
- private CursorAwareDataTreeModification modification;
+ /**
+ * This field needs to be accessed via {@link #getModification()}, which performs state checking to ensure
+ * the modification can actually be accessed.
+ */
+ private final CursorAwareDataTreeModification modification;
+
+ private Supplier<? extends RuntimeException> closedException;
+
private CursorAwareDataTreeModification sealedModification;
+ /**
+ * Recorded failure from previous operations. Normally we would want to propagate the error directly to the
+ * offending call site, but that exposes inconsistency in behavior during initial connection, when we go through
+ * {@link RemoteProxyTransaction}, which detects this sort of issues at canCommit/directCommit time on the backend.
+ *
+ * <p>
+ * We therefore do not report incurred exceptions directly, but report them once the user attempts to commit
+ * this transaction.
+ */
+ private Exception recordedFailure;
+
+ @SuppressWarnings("checkstyle:IllegalCatch")
LocalReadWriteProxyTransaction(final ProxyHistory parent, final TransactionIdentifier identifier,
- final DataTreeSnapshot snapshot) {
- super(parent, identifier);
- this.modification = (CursorAwareDataTreeModification) snapshot.newModification();
+ final DataTreeSnapshot snapshot) {
+ super(parent, identifier, false);
+
+ if (snapshot instanceof FailedDataTreeModification failed) {
+ recordedFailure = failed.cause();
+ modification = failed;
+ } else {
+ CursorAwareDataTreeModification mod;
+ try {
+ mod = (CursorAwareDataTreeModification) snapshot.newModification();
+ } catch (Exception e) {
+ LOG.debug("Failed to instantiate modification for {}", identifier, e);
+ recordedFailure = e;
+ mod = new FailedDataTreeModification(snapshot.modelContext(), e);
+ }
+ modification = mod;
+ }
+ }
+
+ LocalReadWriteProxyTransaction(final ProxyHistory parent, final TransactionIdentifier identifier) {
+ super(parent, identifier, true);
+ // This is DONE transaction, this should never be touched
+ modification = null;
}
@Override
@Override
CursorAwareDataTreeSnapshot readOnlyView() {
- return modification;
+ return getModification();
}
@Override
+ FluentFuture<Boolean> doExists(final YangInstanceIdentifier path) {
+ final var ex = recordedFailure;
+ return ex == null ? super.doExists(path)
+ : FluentFutures.immediateFailedFluentFuture(ReadFailedException.MAPPER.apply(ex));
+ }
+
+ @Override
+ FluentFuture<Optional<NormalizedNode>> doRead(final YangInstanceIdentifier path) {
+ final var ex = recordedFailure;
+ return ex == null ? super.doRead(path)
+ : FluentFutures.immediateFailedFluentFuture(ReadFailedException.MAPPER.apply(ex));
+ }
+
+ @Override
+ @SuppressWarnings("checkstyle:IllegalCatch")
void doDelete(final YangInstanceIdentifier path) {
- modification.delete(path);
+ final CursorAwareDataTreeModification mod = getModification();
+ if (recordedFailure != null) {
+ LOG.debug("Transaction {} recorded failure, ignoring delete of {}", getIdentifier(), path);
+ return;
+ }
+
+ try {
+ mod.delete(path);
+ } catch (Exception e) {
+ LOG.debug("Transaction {} delete on {} incurred failure, delaying it until commit", getIdentifier(), path,
+ e);
+ recordedFailure = e;
+ }
}
@Override
- void doMerge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
- modification.merge(path, data);
+ @SuppressWarnings("checkstyle:IllegalCatch")
+ void doMerge(final YangInstanceIdentifier path, final NormalizedNode data) {
+ final CursorAwareDataTreeModification mod = getModification();
+ if (recordedFailure != null) {
+ LOG.debug("Transaction {} recorded failure, ignoring merge to {}", getIdentifier(), path);
+ return;
+ }
+
+ try {
+ mod.merge(path, data);
+ } catch (Exception e) {
+ LOG.debug("Transaction {} merge to {} incurred failure, delaying it until commit", getIdentifier(), path,
+ e);
+ recordedFailure = e;
+ }
}
@Override
- void doWrite(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
- modification.write(path, data);
+ @SuppressWarnings("checkstyle:IllegalCatch")
+ void doWrite(final YangInstanceIdentifier path, final NormalizedNode data) {
+ final CursorAwareDataTreeModification mod = getModification();
+ if (recordedFailure != null) {
+ LOG.debug("Transaction {} recorded failure, ignoring write to {}", getIdentifier(), path);
+ return;
+ }
+
+ try {
+ mod.write(path, data);
+ } catch (Exception e) {
+ LOG.debug("Transaction {} write to {} incurred failure, delaying it until commit", getIdentifier(), path,
+ e);
+ recordedFailure = e;
+ }
}
private RuntimeException abortedException() {
@Override
CommitLocalTransactionRequest commitRequest(final boolean coordinated) {
+ final CursorAwareDataTreeModification mod = getModification();
final CommitLocalTransactionRequest ret = new CommitLocalTransactionRequest(getIdentifier(), nextSequence(),
- localActor(), modification, coordinated);
- modification = new FailedDataTreeModification(this::submittedException);
+ localActor(), mod, recordedFailure, coordinated);
+ closedException = this::submittedException;
return ret;
}
+ private void sealModification() {
+ checkState(sealedModification == null, "Transaction %s is already sealed", this);
+ final CursorAwareDataTreeModification mod = getModification();
+ mod.ready();
+ sealedModification = mod;
+ }
+
+ @Override
+ boolean sealOnly() {
+ sealModification();
+ return super.sealOnly();
+ }
+
@Override
- void doSeal() {
- modification.ready();
- sealedModification = modification;
+ boolean sealAndSend(final OptionalLong enqueuedTicks) {
+ sealModification();
+ return super.sealAndSend(enqueuedTicks);
}
@Override
- void flushState(final AbstractProxyTransaction successor) {
+ Optional<ModifyTransactionRequest> flushState() {
+ final ModifyTransactionRequestBuilder b = new ModifyTransactionRequestBuilder(getIdentifier(), localActor());
+ b.setSequence(0);
+
sealedModification.applyToCursor(new AbstractDataTreeModificationCursor() {
@Override
- public void write(final PathArgument child, final NormalizedNode<?, ?> data) {
- successor.write(current().node(child), data);
+ public void write(final PathArgument child, final NormalizedNode data) {
+ b.addModification(new TransactionWrite(current().node(child), data));
}
@Override
- public void merge(final PathArgument child, final NormalizedNode<?, ?> data) {
- successor.merge(current().node(child), data);
+ public void merge(final PathArgument child, final NormalizedNode data) {
+ b.addModification(new TransactionMerge(current().node(child), data));
}
@Override
public void delete(final PathArgument child) {
- successor.delete(current().node(child));
+ b.addModification(new TransactionDelete(current().node(child)));
}
});
+
+ return Optional.of(b.build());
}
- DataTreeSnapshot getSnapshot() {
- Preconditions.checkState(sealedModification != null, "Proxy %s is not sealed yet", getIdentifier());
+ CursorAwareDataTreeSnapshot getSnapshot() {
+ checkState(sealedModification != null, "Proxy %s is not sealed yet", getIdentifier());
return sealedModification;
}
@Override
- void applyModifyTransactionRequest(final ModifyTransactionRequest request,
- final @Nullable Consumer<Response<?, ?>> callback) {
+ void applyForwardedModifyTransactionRequest(final ModifyTransactionRequest request,
+ final Consumer<Response<?, ?>> callback) {
+ commonModifyTransactionRequest(request, callback, this::sendRequest);
+ }
+
+ @Override
+ void replayModifyTransactionRequest(final ModifyTransactionRequest request,
+ final Consumer<Response<?, ?>> callback, final long enqueuedTicks) {
+ commonModifyTransactionRequest(request, callback, (req, cb) -> enqueueRequest(req, cb, enqueuedTicks));
+ }
+
+ private void commonModifyTransactionRequest(final ModifyTransactionRequest request,
+ final @Nullable Consumer<Response<?, ?>> callback,
+ final BiConsumer<TransactionRequest<?>, Consumer<Response<?, ?>>> sendMethod) {
for (final TransactionModification mod : request.getModifications()) {
if (mod instanceof TransactionWrite) {
- modification.write(mod.getPath(), ((TransactionWrite)mod).getData());
+ write(mod.getPath(), ((TransactionWrite)mod).getData());
} else if (mod instanceof TransactionMerge) {
- modification.merge(mod.getPath(), ((TransactionMerge)mod).getData());
+ merge(mod.getPath(), ((TransactionMerge)mod).getData());
} else if (mod instanceof TransactionDelete) {
- modification.delete(mod.getPath());
+ delete(mod.getPath());
} else {
throw new IllegalArgumentException("Unsupported modification " + mod);
}
}
- final
java.util.Optional<PersistenceProtocol> maybeProtocol = request.getPersistenceProtocol();
+ final Optional<PersistenceProtocol> maybeProtocol = request.getPersistenceProtocol();
if (maybeProtocol.isPresent()) {
- Verify.verify(callback != null, "Request {} has null callback", request);
- ensureSealed();
+ final var cb = verifyNotNull(callback, "Request %s has null callback", request);
+ if (markSealed()) {
+ sealOnly();
+ }
- switch (maybeProtocol.get()) {
+ switch (maybeProtocol.orElseThrow()) {
case ABORT:
- sendAbort(callback);
+ sendMethod.accept(new AbortLocalTransactionRequest(getIdentifier(), localActor()), cb);
break;
case READY:
- // No-op, as we have already issued a seal()
+ // No-op, as we have already issued a sealOnly() and we are not transmitting anything
break;
case SIMPLE:
- sendRequest(commitRequest(false), callback);
+ sendMethod.accept(commitRequest(false), cb);
break;
case THREE_PHASE:
- sendRequest(commitRequest(true), callback);
+ sendMethod.accept(commitRequest(true), cb);
break;
default:
- throw new IllegalArgumentException("Unhandled protocol " + maybeProtocol.get());
+ throw new IllegalArgumentException("Unhandled protocol " + maybeProtocol.orElseThrow());
}
}
}
@Override
- void handleForwardedRemoteRequest(final TransactionRequest<?> request,
- final @Nullable Consumer<Response<?, ?>> callback) {
+ void handleReplayedLocalRequest(final AbstractLocalTransactionRequest<?> request,
+ final Consumer<Response<?, ?>> callback, final long now) {
+ if (request instanceof CommitLocalTransactionRequest) {
+ enqueueRequest(rebaseCommit((CommitLocalTransactionRequest)request), callback, now);
+ } else {
+ super.handleReplayedLocalRequest(request, callback, now);
+ }
+ }
+
+ @Override
+ void handleReplayedRemoteRequest(final TransactionRequest<?> request,
+ final Consumer<Response<?, ?>> callback, final long enqueuedTicks) {
+ LOG.debug("Applying replayed request {}", request);
+
+ if (request instanceof TransactionPreCommitRequest) {
+ enqueueRequest(new TransactionPreCommitRequest(getIdentifier(), nextSequence(), localActor()), callback,
+ enqueuedTicks);
+ } else if (request instanceof TransactionDoCommitRequest) {
+ enqueueRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), callback,
+ enqueuedTicks);
+ } else if (request instanceof TransactionAbortRequest) {
+ enqueueDoAbort(callback, enqueuedTicks);
+ } else {
+ super.handleReplayedRemoteRequest(request, callback, enqueuedTicks);
+ }
+ }
+
+ @Override
+ void handleForwardedRemoteRequest(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback) {
LOG.debug("Applying forwarded request {}", request);
if (request instanceof TransactionPreCommitRequest) {
} else if (request instanceof TransactionDoCommitRequest) {
sendRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), callback);
} else if (request instanceof TransactionAbortRequest) {
- sendAbort(callback);
+ sendDoAbort(callback);
} else {
super.handleForwardedRemoteRequest(request, callback);
}
}
+ @Override
+ Response<?, ?> handleExistsRequest(final DataTreeSnapshot snapshot, final ExistsTransactionRequest request) {
+ final var ex = recordedFailure;
+ return ex == null ? super.handleExistsRequest(snapshot, request)
+ : request.toRequestFailure(
+ new RuntimeRequestException("Previous modification failed", ReadFailedException.MAPPER.apply(ex)));
+ }
+
+ @Override
+ Response<?, ?> handleReadRequest(final DataTreeSnapshot snapshot, final ReadTransactionRequest request) {
+ final var ex = recordedFailure;
+ return ex == null ? super.handleReadRequest(snapshot, request)
+ : request.toRequestFailure(
+ new RuntimeRequestException("Previous modification failed", ReadFailedException.MAPPER.apply(ex)));
+ }
+
@Override
void forwardToLocal(final LocalProxyTransaction successor, final TransactionRequest<?> request,
final Consumer<Response<?, ?>> callback) {
if (request instanceof CommitLocalTransactionRequest) {
- Verify.verify(successor instanceof LocalReadWriteProxyTransaction);
- ((LocalReadWriteProxyTransaction) successor).sendCommit((CommitLocalTransactionRequest)request, callback);
- LOG.debug("Forwarded request {} to successor {}", request, successor);
+ verifyLocalReadWrite(successor).sendRebased((CommitLocalTransactionRequest)request, callback);
+ } else if (request instanceof ModifyTransactionRequest) {
+ verifyLocalReadWrite(successor).handleForwardedRemoteRequest(request, callback);
} else {
super.forwardToLocal(successor, request, callback);
+ return;
}
+ LOG.debug("Forwarded request {} to successor {}", request, successor);
+ }
+
+ private static LocalReadWriteProxyTransaction verifyLocalReadWrite(final LocalProxyTransaction successor) {
+ verify(successor instanceof LocalReadWriteProxyTransaction, "Unexpected successor %s", successor);
+ return (LocalReadWriteProxyTransaction) successor;
}
@Override
void sendAbort(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback) {
super.sendAbort(request, callback);
- modification = new FailedDataTreeModification(this::abortedException);
+ closedException = this::abortedException;
+ }
+
+ @Override
+ void enqueueAbort(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback,
+ final long enqueuedTicks) {
+ super.enqueueAbort(request, callback, enqueuedTicks);
+ closedException = this::abortedException;
}
- private void sendCommit(final CommitLocalTransactionRequest request, final Consumer<Response<?, ?>> callback) {
+ @SuppressFBWarnings(value = "THROWS_METHOD_THROWS_RUNTIMEEXCEPTION", justification = "Replay of recorded failure")
+ private @NonNull CursorAwareDataTreeModification getModification() {
+ if (closedException != null) {
+ throw closedException.get();
+ }
+ return verifyNotNull(modification, "Transaction %s is DONE", getIdentifier());
+ }
+
+ private void sendRebased(final CommitLocalTransactionRequest request, final Consumer<Response<?, ?>> callback) {
+ sendRequest(rebaseCommit(request), callback);
+ }
+
+ private CommitLocalTransactionRequest rebaseCommit(final CommitLocalTransactionRequest request) {
// Rebase old modification on new data tree.
- try (DataTreeModificationCursor cursor = modification.createCursor(YangInstanceIdentifier.EMPTY)) {
- request.getModification().applyToCursor(cursor);
+ final CursorAwareDataTreeModification mod = getModification();
+
+ if (!(mod instanceof FailedDataTreeModification)) {
+ request.getDelayedFailure().ifPresentOrElse(failure -> {
+ if (recordedFailure == null) {
+ recordedFailure = failure;
+ } else {
+ recordedFailure.addSuppressed(failure);
+ }
+ }, () -> {
+ try (DataTreeModificationCursor cursor = mod.openCursor()) {
+ request.getModification().applyToCursor(cursor);
+ }
+ });
+ }
+
+ if (markSealed()) {
+ sealOnly();
}
- ensureSealed();
- sendRequest(commitRequest(request.isCoordinated()), callback);
+ return commitRequest(request.isCoordinated());
}
}
Code Review / controller.git / blobdiff