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.Optional;
13 import java.util.OptionalLong;
14 import java.util.function.BiConsumer;
15 import java.util.function.Consumer;
16 import java.util.function.Supplier;
17 import org.eclipse.jdt.annotation.NonNull;
18 import org.eclipse.jdt.annotation.Nullable;
19 import org.opendaylight.controller.cluster.access.commands.AbortLocalTransactionRequest;
20 import org.opendaylight.controller.cluster.access.commands.AbstractLocalTransactionRequest;
21 import org.opendaylight.controller.cluster.access.commands.CommitLocalTransactionRequest;
22 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequest;
23 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequestBuilder;
24 import org.opendaylight.controller.cluster.access.commands.PersistenceProtocol;
25 import org.opendaylight.controller.cluster.access.commands.TransactionAbortRequest;
26 import org.opendaylight.controller.cluster.access.commands.TransactionDelete;
27 import org.opendaylight.controller.cluster.access.commands.TransactionDoCommitRequest;
28 import org.opendaylight.controller.cluster.access.commands.TransactionMerge;
29 import org.opendaylight.controller.cluster.access.commands.TransactionModification;
30 import org.opendaylight.controller.cluster.access.commands.TransactionPreCommitRequest;
31 import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
32 import org.opendaylight.controller.cluster.access.commands.TransactionWrite;
33 import org.opendaylight.controller.cluster.access.concepts.Response;
34 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
35 import org.opendaylight.controller.cluster.datastore.util.AbstractDataTreeModificationCursor;
36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
38 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
39 import org.opendaylight.yangtools.yang.data.api.schema.tree.CursorAwareDataTreeModification;
40 import org.opendaylight.yangtools.yang.data.api.schema.tree.CursorAwareDataTreeSnapshot;
41 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
42 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModificationCursor;
43 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
44 import org.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
48 * An {@link AbstractProxyTransaction} for dispatching a transaction towards a shard leader which is co-located with
49 * the client instance. This class is NOT thread-safe.
52 * It requires a {@link DataTreeSnapshot}, which is used to instantiated a new {@link DataTreeModification}. Operations
53 * are then performed on this modification and once the transaction is submitted, the modification is sent to the shard
57 * This class is not thread-safe as usual with transactions. Since it does not interact with the backend until the
58 * transaction is submitted, at which point this class gets out of the picture, this is not a cause for concern.
60 * @author Robert Varga
62 final class LocalReadWriteProxyTransaction extends LocalProxyTransaction {
63 private static final Logger LOG = LoggerFactory.getLogger(LocalReadWriteProxyTransaction.class);
66 * This field needs to be accessed via {@link #getModification()}, which performs state checking to ensure
67 * the modification can actually be accessed.
69 private final CursorAwareDataTreeModification modification;
71 private Supplier<? extends RuntimeException> closedException;
73 private CursorAwareDataTreeModification sealedModification;
76 * Recorded failure from previous operations. Normally we would want to propagate the error directly to the
77 * offending call site, but that exposes inconsistency in behavior during initial connection, when we go through
78 * {@link RemoteProxyTransaction}, which detects this sort of issues at canCommit/directCommit time on the backend.
81 * We therefore do not report incurred exceptions directly, but report them once the user attempts to commit
84 private Exception recordedFailure;
86 LocalReadWriteProxyTransaction(final ProxyHistory parent, final TransactionIdentifier identifier,
87 final DataTreeSnapshot snapshot) {
88 super(parent, identifier, false);
89 this.modification = (CursorAwareDataTreeModification) snapshot.newModification();
92 LocalReadWriteProxyTransaction(final ProxyHistory parent, final TransactionIdentifier identifier) {
93 super(parent, identifier, true);
94 // This is DONE transaction, this should never be touched
95 this.modification = null;
99 boolean isSnapshotOnly() {
104 CursorAwareDataTreeSnapshot readOnlyView() {
105 return getModification();
109 @SuppressWarnings("checkstyle:IllegalCatch")
110 void doDelete(final YangInstanceIdentifier path) {
111 final CursorAwareDataTreeModification mod = getModification();
112 if (recordedFailure != null) {
113 LOG.debug("Transaction {} recorded failure, ignoring delete of {}", getIdentifier(), path);
119 } catch (Exception e) {
120 LOG.debug("Transaction {} delete on {} incurred failure, delaying it until commit", getIdentifier(), path,
127 @SuppressWarnings("checkstyle:IllegalCatch")
128 void doMerge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
129 final CursorAwareDataTreeModification mod = getModification();
130 if (recordedFailure != null) {
131 LOG.debug("Transaction {} recorded failure, ignoring merge to {}", getIdentifier(), path);
136 mod.merge(path, data);
137 } catch (Exception e) {
138 LOG.debug("Transaction {} merge to {} incurred failure, delaying it until commit", getIdentifier(), path,
145 @SuppressWarnings("checkstyle:IllegalCatch")
146 void doWrite(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
147 final CursorAwareDataTreeModification mod = getModification();
148 if (recordedFailure != null) {
149 LOG.debug("Transaction {} recorded failure, ignoring write to {}", getIdentifier(), path);
154 mod.write(path, data);
155 } catch (Exception e) {
156 LOG.debug("Transaction {} write to {} incurred failure, delaying it until commit", getIdentifier(), path,
162 private RuntimeException abortedException() {
163 return new IllegalStateException("Tracker " + getIdentifier() + " has been aborted");
166 private RuntimeException submittedException() {
167 return new IllegalStateException("Tracker " + getIdentifier() + " has been submitted");
171 CommitLocalTransactionRequest commitRequest(final boolean coordinated) {
172 final CursorAwareDataTreeModification mod = getModification();
173 final CommitLocalTransactionRequest ret = new CommitLocalTransactionRequest(getIdentifier(), nextSequence(),
174 localActor(), mod, recordedFailure, coordinated);
175 closedException = this::submittedException;
179 private void sealModification() {
180 Preconditions.checkState(sealedModification == null, "Transaction %s is already sealed", this);
181 final CursorAwareDataTreeModification mod = getModification();
183 sealedModification = mod;
189 return super.sealOnly();
193 boolean sealAndSend(final OptionalLong enqueuedTicks) {
195 return super.sealAndSend(enqueuedTicks);
199 Optional<ModifyTransactionRequest> flushState() {
200 final ModifyTransactionRequestBuilder b = new ModifyTransactionRequestBuilder(getIdentifier(), localActor());
203 sealedModification.applyToCursor(new AbstractDataTreeModificationCursor() {
205 public void write(final PathArgument child, final NormalizedNode<?, ?> data) {
206 b.addModification(new TransactionWrite(current().node(child), data));
210 public void merge(final PathArgument child, final NormalizedNode<?, ?> data) {
211 b.addModification(new TransactionMerge(current().node(child), data));
215 public void delete(final PathArgument child) {
216 b.addModification(new TransactionDelete(current().node(child)));
220 return Optional.of(b.build());
223 DataTreeSnapshot getSnapshot() {
224 Preconditions.checkState(sealedModification != null, "Proxy %s is not sealed yet", getIdentifier());
225 return sealedModification;
229 void applyForwardedModifyTransactionRequest(final ModifyTransactionRequest request,
230 final Consumer<Response<?, ?>> callback) {
231 commonModifyTransactionRequest(request, callback, this::sendRequest);
235 void replayModifyTransactionRequest(final ModifyTransactionRequest request,
236 final Consumer<Response<?, ?>> callback, final long enqueuedTicks) {
237 commonModifyTransactionRequest(request, callback, (req, cb) -> enqueueRequest(req, cb, enqueuedTicks));
240 private void commonModifyTransactionRequest(final ModifyTransactionRequest request,
241 final @Nullable Consumer<Response<?, ?>> callback,
242 final BiConsumer<TransactionRequest<?>, Consumer<Response<?, ?>>> sendMethod) {
243 for (final TransactionModification mod : request.getModifications()) {
244 if (mod instanceof TransactionWrite) {
245 write(mod.getPath(), ((TransactionWrite)mod).getData());
246 } else if (mod instanceof TransactionMerge) {
247 merge(mod.getPath(), ((TransactionMerge)mod).getData());
248 } else if (mod instanceof TransactionDelete) {
249 delete(mod.getPath());
251 throw new IllegalArgumentException("Unsupported modification " + mod);
255 final Optional<PersistenceProtocol> maybeProtocol = request.getPersistenceProtocol();
256 if (maybeProtocol.isPresent()) {
257 Verify.verify(callback != null, "Request %s has null callback", request);
262 switch (maybeProtocol.get()) {
264 sendMethod.accept(new AbortLocalTransactionRequest(getIdentifier(), localActor()), callback);
267 // No-op, as we have already issued a sealOnly() and we are not transmitting anything
270 sendMethod.accept(commitRequest(false), callback);
273 sendMethod.accept(commitRequest(true), callback);
276 throw new IllegalArgumentException("Unhandled protocol " + maybeProtocol.get());
282 void handleReplayedLocalRequest(final AbstractLocalTransactionRequest<?> request,
283 final Consumer<Response<?, ?>> callback, final long now) {
284 if (request instanceof CommitLocalTransactionRequest) {
285 enqueueRequest(rebaseCommit((CommitLocalTransactionRequest)request), callback, now);
287 super.handleReplayedLocalRequest(request, callback, now);
292 void handleReplayedRemoteRequest(final TransactionRequest<?> request,
293 final Consumer<Response<?, ?>> callback, final long enqueuedTicks) {
294 LOG.debug("Applying replayed request {}", request);
296 if (request instanceof TransactionPreCommitRequest) {
297 enqueueRequest(new TransactionPreCommitRequest(getIdentifier(), nextSequence(), localActor()), callback,
299 } else if (request instanceof TransactionDoCommitRequest) {
300 enqueueRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), callback,
302 } else if (request instanceof TransactionAbortRequest) {
303 enqueueDoAbort(callback, enqueuedTicks);
305 super.handleReplayedRemoteRequest(request, callback, enqueuedTicks);
310 void handleForwardedRemoteRequest(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback) {
311 LOG.debug("Applying forwarded request {}", request);
313 if (request instanceof TransactionPreCommitRequest) {
314 sendRequest(new TransactionPreCommitRequest(getIdentifier(), nextSequence(), localActor()), callback);
315 } else if (request instanceof TransactionDoCommitRequest) {
316 sendRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), callback);
317 } else if (request instanceof TransactionAbortRequest) {
318 sendDoAbort(callback);
320 super.handleForwardedRemoteRequest(request, callback);
325 void forwardToLocal(final LocalProxyTransaction successor, final TransactionRequest<?> request,
326 final Consumer<Response<?, ?>> callback) {
327 if (request instanceof CommitLocalTransactionRequest) {
328 Verify.verify(successor instanceof LocalReadWriteProxyTransaction);
329 ((LocalReadWriteProxyTransaction) successor).sendRebased((CommitLocalTransactionRequest)request, callback);
330 LOG.debug("Forwarded request {} to successor {}", request, successor);
332 super.forwardToLocal(successor, request, callback);
337 void sendAbort(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback) {
338 super.sendAbort(request, callback);
339 closedException = this::abortedException;
343 void enqueueAbort(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback,
344 final long enqueuedTicks) {
345 super.enqueueAbort(request, callback, enqueuedTicks);
346 closedException = this::abortedException;
349 private @NonNull CursorAwareDataTreeModification getModification() {
350 if (closedException != null) {
351 throw closedException.get();
354 return Preconditions.checkNotNull(modification, "Transaction %s is DONE", getIdentifier());
357 private void sendRebased(final CommitLocalTransactionRequest request, final Consumer<Response<?, ?>> callback) {
358 sendRequest(rebaseCommit(request), callback);
361 private CommitLocalTransactionRequest rebaseCommit(final CommitLocalTransactionRequest request) {
362 // Rebase old modification on new data tree.
363 final CursorAwareDataTreeModification mod = getModification();
365 try (DataTreeModificationCursor cursor = mod.openCursor()) {
366 request.getModification().applyToCursor(cursor);
373 return commitRequest(request.isCoordinated());