/*
* 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 com.google.common.base.Optional;
import com.google.common.base.Preconditions;
import com.google.common.base.Verify;
import com.google.common.util.concurrent.CheckedFuture;
import com.google.common.util.concurrent.Futures;
import java.util.function.Consumer;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;
import org.opendaylight.controller.cluster.access.commands.AbortLocalTransactionRequest;
import org.opendaylight.controller.cluster.access.commands.CommitLocalTransactionRequest;
import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequest;
import org.opendaylight.controller.cluster.access.commands.PersistenceProtocol;
import org.opendaylight.controller.cluster.access.commands.TransactionDelete;
import org.opendaylight.controller.cluster.access.commands.TransactionMerge;
import org.opendaylight.controller.cluster.access.commands.TransactionModification;
import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
import org.opendaylight.controller.cluster.access.commands.TransactionWrite;
import org.opendaylight.controller.cluster.access.concepts.RequestException;
import org.opendaylight.controller.cluster.access.concepts.Response;
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.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.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.
*
*
* 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
*/
@NotThreadSafe
final class LocalProxyTransaction extends AbstractProxyTransaction {
private static final Logger LOG = LoggerFactory.getLogger(LocalProxyTransaction.class);
private final TransactionIdentifier identifier;
private CursorAwareDataTreeModification modification;
private CursorAwareDataTreeSnapshot sealedModification;
LocalProxyTransaction(final ProxyHistory parent, final TransactionIdentifier identifier,
final CursorAwareDataTreeModification modification) {
super(parent);
this.identifier = Preconditions.checkNotNull(identifier);
this.modification = Preconditions.checkNotNull(modification);
}
@Override
public TransactionIdentifier getIdentifier() {
return identifier;
}
@Override
void doDelete(final YangInstanceIdentifier path) {
modification.delete(path);
}
@Override
void doMerge(final YangInstanceIdentifier path, final NormalizedNode, ?> data) {
modification.merge(path, data);
}
@Override
void doWrite(final YangInstanceIdentifier path, final NormalizedNode, ?> data) {
modification.write(path, data);
}
@Override
CheckedFuture doExists(final YangInstanceIdentifier path) {
return Futures.immediateCheckedFuture(modification.readNode(path).isPresent());
}
@Override
CheckedFuture>, ReadFailedException> doRead(final YangInstanceIdentifier path) {
return Futures.immediateCheckedFuture(modification.readNode(path));
}
private RuntimeException abortedException() {
return new IllegalStateException("Tracker " + identifier + " has been aborted");
}
private RuntimeException submittedException() {
return new IllegalStateException("Tracker " + identifier + " has been submitted");
}
@Override
void doAbort() {
sendAbort(new AbortLocalTransactionRequest(identifier, localActor()), response -> {
LOG.debug("Transaction {} abort completed with {}", identifier, response);
});
}
@Override
CommitLocalTransactionRequest commitRequest(final boolean coordinated) {
final CommitLocalTransactionRequest ret = new CommitLocalTransactionRequest(identifier, localActor(),
modification, coordinated);
modification = new FailedDataTreeModification(this::submittedException);
return ret;
}
@Override
void doSeal() {
modification.ready();
sealedModification = modification;
}
DataTreeSnapshot getSnapshot() {
Preconditions.checkState(sealedModification != null, "Proxy %s is not sealed yet", identifier);
return sealedModification;
}
private void applyModifyTransactionRequest(final ModifyTransactionRequest request,
final @Nullable Consumer> callback) {
for (TransactionModification mod : request.getModifications()) {
if (mod instanceof TransactionWrite) {
modification.write(mod.getPath(), ((TransactionWrite)mod).getData());
} else if (mod instanceof TransactionMerge) {
modification.merge(mod.getPath(), ((TransactionMerge)mod).getData());
} else if (mod instanceof TransactionDelete) {
modification.delete(mod.getPath());
} else {
throw new IllegalArgumentException("Unsupported modification " + mod);
}
}
final java.util.Optional maybeProtocol = request.getPersistenceProtocol();
if (maybeProtocol.isPresent()) {
seal();
Verify.verify(callback != null, "Request {} has null callback", request);
switch (maybeProtocol.get()) {
case ABORT:
sendAbort(callback);
break;
case SIMPLE:
sendRequest(commitRequest(false), callback);
break;
case THREE_PHASE:
sendRequest(commitRequest(true), callback);
break;
default:
throw new IllegalArgumentException("Unhandled protocol " + maybeProtocol.get());
}
}
}
@Override
void handleForwardedRemoteRequest(final TransactionRequest> request,
final @Nullable Consumer> callback) {
LOG.debug("Applying forwaded request {}", request);
if (request instanceof ModifyTransactionRequest) {
applyModifyTransactionRequest((ModifyTransactionRequest) request, callback);
} else {
throw new IllegalArgumentException("Unhandled request " + request);
}
}
@Override
void forwardToRemote(final RemoteProxyTransaction successor, final TransactionRequest> request,
final Consumer> callback) throws RequestException {
if (request instanceof CommitLocalTransactionRequest) {
final CommitLocalTransactionRequest req = (CommitLocalTransactionRequest) request;
final DataTreeModification mod = req.getModification();
LOG.debug("Applying modification {} to successor {}", mod, successor);
mod.applyToCursor(new AbstractDataTreeModificationCursor() {
@Override
public void write(final PathArgument child, final NormalizedNode, ?> data) {
successor.write(current().node(child), data);
}
@Override
public void merge(final PathArgument child, final NormalizedNode, ?> data) {
successor.merge(current().node(child), data);
}
@Override
public void delete(final PathArgument child) {
successor.delete(current().node(child));
}
});
successor.seal();
final ModifyTransactionRequest successorReq = successor.commitRequest(req.isCoordinated());
successor.sendRequest(successorReq, callback);
} else if (request instanceof AbortLocalTransactionRequest) {
LOG.debug("Forwarding abort {} to successor {}", request, successor);
successor.abort();
} else {
throw new IllegalArgumentException("Unhandled request" + request);
}
}
@Override
void forwardToLocal(final LocalProxyTransaction successor, final TransactionRequest> request,
final Consumer> callback) throws RequestException {
if (request instanceof AbortLocalTransactionRequest) {
successor.sendAbort(request, callback);
} else if (request instanceof CommitLocalTransactionRequest) {
successor.sendCommit((CommitLocalTransactionRequest)request, callback);
} else {
throw new IllegalArgumentException("Unhandled request" + request);
}
LOG.debug("Forwarded request {} to successor {}", request, successor);
}
private void sendAbort(final TransactionRequest> request, final Consumer> callback) {
sendRequest(request, callback);
modification = new FailedDataTreeModification(this::abortedException);
}
private void sendCommit(final CommitLocalTransactionRequest request, final Consumer> callback) {
// Rebase old modification on new data tree.
try (DataTreeModificationCursor cursor = modification.createCursor(YangInstanceIdentifier.EMPTY)) {
request.getModification().applyToCursor(cursor);
}
seal();
sendRequest(commitRequest(request.isCoordinated()), callback);
}
}