/*
* Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
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 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 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.TransactionMerge;
import org.opendaylight.controller.cluster.access.commands.TransactionModification;
import org.opendaylight.controller.cluster.access.commands.TransactionPreCommitRequest;
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.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. This class is NOT thread-safe.
*
*
* It requires a {@link DataTreeSnapshot}, which is used to instantiated a new {@link DataTreeModification}. Operations
* are then performed on this modification and once the transaction is submitted, the modification is sent to the shard
* leader.
*
*
* This class is not thread-safe as usual with transactions. Since it does not interact with the backend until the
* transaction is submitted, at which point this class gets out of the picture, this is not a cause for concern.
*
* @author Robert Varga
*/
final class LocalReadWriteProxyTransaction extends LocalProxyTransaction {
private static final Logger LOG = LoggerFactory.getLogger(LocalReadWriteProxyTransaction.class);
/**
* 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.
*
*
* 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, 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
boolean isSnapshotOnly() {
return false;
}
@Override
CursorAwareDataTreeSnapshot readOnlyView() {
return getModification();
}
@Override
FluentFuture doExists(final YangInstanceIdentifier path) {
final var ex = recordedFailure;
return ex == null ? super.doExists(path)
: FluentFutures.immediateFailedFluentFuture(ReadFailedException.MAPPER.apply(ex));
}
@Override
FluentFuture> 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) {
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
@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
@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() {
return new IllegalStateException("Tracker " + getIdentifier() + " has been aborted");
}
private RuntimeException submittedException() {
return new IllegalStateException("Tracker " + getIdentifier() + " has been submitted");
}
@Override
CommitLocalTransactionRequest commitRequest(final boolean coordinated) {
final CursorAwareDataTreeModification mod = getModification();
final CommitLocalTransactionRequest ret = new CommitLocalTransactionRequest(getIdentifier(), nextSequence(),
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
boolean sealAndSend(final OptionalLong enqueuedTicks) {
sealModification();
return super.sealAndSend(enqueuedTicks);
}
@Override
Optional 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) {
b.addModification(new TransactionWrite(current().node(child), data));
}
@Override
public void merge(final PathArgument child, final NormalizedNode data) {
b.addModification(new TransactionMerge(current().node(child), data));
}
@Override
public void delete(final PathArgument child) {
b.addModification(new TransactionDelete(current().node(child)));
}
});
return Optional.of(b.build());
}
CursorAwareDataTreeSnapshot getSnapshot() {
checkState(sealedModification != null, "Proxy %s is not sealed yet", getIdentifier());
return sealedModification;
}
@Override
void applyForwardedModifyTransactionRequest(final ModifyTransactionRequest request,
final Consumer> callback) {
commonModifyTransactionRequest(request, callback, this::sendRequest);
}
@Override
void replayModifyTransactionRequest(final ModifyTransactionRequest request,
final Consumer> callback, final long enqueuedTicks) {
commonModifyTransactionRequest(request, callback, (req, cb) -> enqueueRequest(req, cb, enqueuedTicks));
}
private void commonModifyTransactionRequest(final ModifyTransactionRequest request,
final @Nullable Consumer> callback,
final BiConsumer, Consumer>> sendMethod) {
for (final TransactionModification mod : request.getModifications()) {
if (mod instanceof TransactionWrite) {
write(mod.getPath(), ((TransactionWrite)mod).getData());
} else if (mod instanceof TransactionMerge) {
merge(mod.getPath(), ((TransactionMerge)mod).getData());
} else if (mod instanceof TransactionDelete) {
delete(mod.getPath());
} else {
throw new IllegalArgumentException("Unsupported modification " + mod);
}
}
final Optional maybeProtocol = request.getPersistenceProtocol();
if (maybeProtocol.isPresent()) {
final var cb = verifyNotNull(callback, "Request %s has null callback", request);
if (markSealed()) {
sealOnly();
}
switch (maybeProtocol.orElseThrow()) {
case ABORT:
sendMethod.accept(new AbortLocalTransactionRequest(getIdentifier(), localActor()), cb);
break;
case READY:
// No-op, as we have already issued a sealOnly() and we are not transmitting anything
break;
case SIMPLE:
sendMethod.accept(commitRequest(false), cb);
break;
case THREE_PHASE:
sendMethod.accept(commitRequest(true), cb);
break;
default:
throw new IllegalArgumentException("Unhandled protocol " + maybeProtocol.orElseThrow());
}
}
}
@Override
void handleReplayedLocalRequest(final AbstractLocalTransactionRequest> request,
final Consumer> 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> 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> callback) {
LOG.debug("Applying forwarded request {}", request);
if (request instanceof TransactionPreCommitRequest) {
sendRequest(new TransactionPreCommitRequest(getIdentifier(), nextSequence(), localActor()), callback);
} else if (request instanceof TransactionDoCommitRequest) {
sendRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), callback);
} else if (request instanceof TransactionAbortRequest) {
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> callback) {
if (request instanceof CommitLocalTransactionRequest) {
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> callback) {
super.sendAbort(request, callback);
closedException = this::abortedException;
}
@Override
void enqueueAbort(final TransactionRequest> request, final Consumer> callback,
final long enqueuedTicks) {
super.enqueueAbort(request, callback, enqueuedTicks);
closedException = this::abortedException;
}
@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> callback) {
sendRequest(rebaseCommit(request), callback);
}
private CommitLocalTransactionRequest rebaseCommit(final CommitLocalTransactionRequest request) {
// Rebase old modification on new data tree.
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();
}
return commitRequest(request.isCoordinated());
}
}