2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.cluster.databroker.actors.dds;
10 import com.google.common.base.Preconditions;
11 import com.google.common.base.Verify;
12 import java.util.function.Consumer;
13 import javax.annotation.Nullable;
14 import javax.annotation.concurrent.NotThreadSafe;
15 import org.opendaylight.controller.cluster.access.commands.CommitLocalTransactionRequest;
16 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequest;
17 import org.opendaylight.controller.cluster.access.commands.PersistenceProtocol;
18 import org.opendaylight.controller.cluster.access.commands.TransactionAbortRequest;
19 import org.opendaylight.controller.cluster.access.commands.TransactionDelete;
20 import org.opendaylight.controller.cluster.access.commands.TransactionDoCommitRequest;
21 import org.opendaylight.controller.cluster.access.commands.TransactionMerge;
22 import org.opendaylight.controller.cluster.access.commands.TransactionModification;
23 import org.opendaylight.controller.cluster.access.commands.TransactionPreCommitRequest;
24 import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
25 import org.opendaylight.controller.cluster.access.commands.TransactionWrite;
26 import org.opendaylight.controller.cluster.access.concepts.Response;
27 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
28 import org.opendaylight.controller.cluster.datastore.util.AbstractDataTreeModificationCursor;
29 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
30 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
31 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
32 import org.opendaylight.yangtools.yang.data.api.schema.tree.CursorAwareDataTreeModification;
33 import org.opendaylight.yangtools.yang.data.api.schema.tree.CursorAwareDataTreeSnapshot;
34 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
35 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModificationCursor;
36 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
37 import org.slf4j.Logger;
38 import org.slf4j.LoggerFactory;
41 * An {@link AbstractProxyTransaction} for dispatching a transaction towards a shard leader which is co-located with
42 * the client instance.
45 * It requires a {@link DataTreeSnapshot}, which is used to instantiated a new {@link DataTreeModification}. Operations
46 * are then performed on this modification and once the transaction is submitted, the modification is sent to the shard
50 * This class is not thread-safe as usual with transactions. Since it does not interact with the backend until the
51 * transaction is submitted, at which point this class gets out of the picture, this is not a cause for concern.
53 * @author Robert Varga
56 final class LocalReadWriteProxyTransaction extends LocalProxyTransaction {
57 private static final Logger LOG = LoggerFactory.getLogger(LocalReadWriteProxyTransaction.class);
59 private CursorAwareDataTreeModification modification;
60 private CursorAwareDataTreeModification sealedModification;
62 LocalReadWriteProxyTransaction(final ProxyHistory parent, final TransactionIdentifier identifier,
63 final DataTreeSnapshot snapshot) {
64 super(parent, identifier);
65 this.modification = (CursorAwareDataTreeModification) snapshot.newModification();
69 boolean isSnapshotOnly() {
74 CursorAwareDataTreeSnapshot readOnlyView() {
79 void doDelete(final YangInstanceIdentifier path) {
80 modification.delete(path);
84 void doMerge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
85 modification.merge(path, data);
89 void doWrite(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
90 modification.write(path, data);
93 private RuntimeException abortedException() {
94 return new IllegalStateException("Tracker " + getIdentifier() + " has been aborted");
97 private RuntimeException submittedException() {
98 return new IllegalStateException("Tracker " + getIdentifier() + " has been submitted");
102 CommitLocalTransactionRequest commitRequest(final boolean coordinated) {
103 final CommitLocalTransactionRequest ret = new CommitLocalTransactionRequest(getIdentifier(), nextSequence(),
104 localActor(), modification, coordinated);
105 modification = new FailedDataTreeModification(this::submittedException);
111 modification.ready();
112 sealedModification = modification;
116 void flushState(final AbstractProxyTransaction successor) {
117 sealedModification.applyToCursor(new AbstractDataTreeModificationCursor() {
119 public void write(final PathArgument child, final NormalizedNode<?, ?> data) {
120 successor.write(current().node(child), data);
124 public void merge(final PathArgument child, final NormalizedNode<?, ?> data) {
125 successor.merge(current().node(child), data);
129 public void delete(final PathArgument child) {
130 successor.delete(current().node(child));
135 DataTreeSnapshot getSnapshot() {
136 Preconditions.checkState(sealedModification != null, "Proxy %s is not sealed yet", getIdentifier());
137 return sealedModification;
141 void applyModifyTransactionRequest(final ModifyTransactionRequest request,
142 final @Nullable Consumer<Response<?, ?>> callback) {
143 for (final TransactionModification mod : request.getModifications()) {
144 if (mod instanceof TransactionWrite) {
145 modification.write(mod.getPath(), ((TransactionWrite)mod).getData());
146 } else if (mod instanceof TransactionMerge) {
147 modification.merge(mod.getPath(), ((TransactionMerge)mod).getData());
148 } else if (mod instanceof TransactionDelete) {
149 modification.delete(mod.getPath());
151 throw new IllegalArgumentException("Unsupported modification " + mod);
155 final java.util.Optional<PersistenceProtocol> maybeProtocol = request.getPersistenceProtocol();
156 if (maybeProtocol.isPresent()) {
157 Verify.verify(callback != null, "Request {} has null callback", request);
160 switch (maybeProtocol.get()) {
165 // No-op, as we have already issued a seal()
168 sendRequest(commitRequest(false), callback);
171 sendRequest(commitRequest(true), callback);
174 throw new IllegalArgumentException("Unhandled protocol " + maybeProtocol.get());
180 void handleForwardedRemoteRequest(final TransactionRequest<?> request,
181 final @Nullable Consumer<Response<?, ?>> callback) {
182 LOG.debug("Applying forwarded request {}", request);
184 if (request instanceof TransactionPreCommitRequest) {
185 sendRequest(new TransactionPreCommitRequest(getIdentifier(), nextSequence(), localActor()), callback);
186 } else if (request instanceof TransactionDoCommitRequest) {
187 sendRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), callback);
188 } else if (request instanceof TransactionAbortRequest) {
191 super.handleForwardedRemoteRequest(request, callback);
196 void forwardToLocal(final LocalProxyTransaction successor, final TransactionRequest<?> request,
197 final Consumer<Response<?, ?>> callback) {
198 if (request instanceof CommitLocalTransactionRequest) {
199 Verify.verify(successor instanceof LocalReadWriteProxyTransaction);
200 ((LocalReadWriteProxyTransaction) successor).sendCommit((CommitLocalTransactionRequest)request, callback);
201 LOG.debug("Forwarded request {} to successor {}", request, successor);
203 super.forwardToLocal(successor, request, callback);
208 void sendAbort(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback) {
209 super.sendAbort(request, callback);
210 modification = new FailedDataTreeModification(this::abortedException);
213 private void sendCommit(final CommitLocalTransactionRequest request, final Consumer<Response<?, ?>> callback) {
214 // Rebase old modification on new data tree.
215 try (DataTreeModificationCursor cursor = modification.createCursor(YangInstanceIdentifier.EMPTY)) {
216 request.getModification().applyToCursor(cursor);
220 sendRequest(commitRequest(request.isCoordinated()), callback);