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.Optional;
11 import com.google.common.util.concurrent.CheckedFuture;
12 import com.google.common.util.concurrent.Futures;
13 import com.google.common.util.concurrent.ListenableFuture;
14 import com.google.common.util.concurrent.SettableFuture;
15 import java.util.function.Consumer;
16 import javax.annotation.Nullable;
17 import org.opendaylight.controller.cluster.access.commands.AbortLocalTransactionRequest;
18 import org.opendaylight.controller.cluster.access.commands.AbstractLocalTransactionRequest;
19 import org.opendaylight.controller.cluster.access.commands.AbstractReadTransactionRequest;
20 import org.opendaylight.controller.cluster.access.commands.CommitLocalTransactionRequest;
21 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionRequest;
22 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionSuccess;
23 import org.opendaylight.controller.cluster.access.commands.IncrementTransactionSequenceRequest;
24 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequest;
25 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequestBuilder;
26 import org.opendaylight.controller.cluster.access.commands.PersistenceProtocol;
27 import org.opendaylight.controller.cluster.access.commands.ReadTransactionRequest;
28 import org.opendaylight.controller.cluster.access.commands.ReadTransactionSuccess;
29 import org.opendaylight.controller.cluster.access.commands.TransactionAbortRequest;
30 import org.opendaylight.controller.cluster.access.commands.TransactionDelete;
31 import org.opendaylight.controller.cluster.access.commands.TransactionDoCommitRequest;
32 import org.opendaylight.controller.cluster.access.commands.TransactionMerge;
33 import org.opendaylight.controller.cluster.access.commands.TransactionModification;
34 import org.opendaylight.controller.cluster.access.commands.TransactionPreCommitRequest;
35 import org.opendaylight.controller.cluster.access.commands.TransactionPurgeRequest;
36 import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
37 import org.opendaylight.controller.cluster.access.commands.TransactionSuccess;
38 import org.opendaylight.controller.cluster.access.commands.TransactionWrite;
39 import org.opendaylight.controller.cluster.access.concepts.RequestFailure;
40 import org.opendaylight.controller.cluster.access.concepts.Response;
41 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
42 import org.opendaylight.controller.cluster.datastore.util.AbstractDataTreeModificationCursor;
43 import org.opendaylight.mdsal.common.api.ReadFailedException;
44 import org.opendaylight.yangtools.util.concurrent.MappingCheckedFuture;
45 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
46 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
47 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
48 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
49 import org.slf4j.Logger;
50 import org.slf4j.LoggerFactory;
53 * An {@link AbstractProxyTransaction} for dispatching a transaction towards a shard leader whose location is currently
54 * not known or is known to be not co-located with the client.
57 * It packages operations and sends them via the client actor queue to the shard leader. That queue is responsible for
58 * maintaining any submitted operations until the leader is discovered.
61 * This class is not safe to access from multiple application threads, as is usual for transactions. Its internal state
62 * transitions based on backend responses are thread-safe.
64 * @author Robert Varga
66 final class RemoteProxyTransaction extends AbstractProxyTransaction {
67 private static final Logger LOG = LoggerFactory.getLogger(RemoteProxyTransaction.class);
69 // FIXME: make this tuneable
70 private static final int REQUEST_MAX_MODIFICATIONS = 1000;
72 private final ModifyTransactionRequestBuilder builder;
73 private final boolean sendReadyOnSeal;
74 private final boolean snapshotOnly;
76 private boolean builderBusy;
78 private volatile Exception operationFailure;
80 RemoteProxyTransaction(final ProxyHistory parent, final TransactionIdentifier identifier,
81 final boolean snapshotOnly, final boolean sendReadyOnSeal, final boolean isDone) {
82 super(parent, isDone);
83 this.snapshotOnly = snapshotOnly;
84 this.sendReadyOnSeal = sendReadyOnSeal;
85 builder = new ModifyTransactionRequestBuilder(identifier, localActor());
89 boolean isSnapshotOnly() {
94 public TransactionIdentifier getIdentifier() {
95 return builder.getIdentifier();
99 void doDelete(final YangInstanceIdentifier path) {
100 appendModification(new TransactionDelete(path), Optional.absent());
104 void doMerge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
105 appendModification(new TransactionMerge(path, data), Optional.absent());
109 void doWrite(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
110 appendModification(new TransactionWrite(path, data), Optional.absent());
113 private <T> CheckedFuture<T, ReadFailedException> sendReadRequest(final AbstractReadTransactionRequest<?> request,
114 final Consumer<Response<?, ?>> completer, final ListenableFuture<T> future) {
115 // Check if a previous operation failed. If it has, do not bother sending anything and report a failure
116 final Exception local = operationFailure;
118 return Futures.immediateFailedCheckedFuture(new ReadFailedException("Previous operation failed", local));
121 // Make sure we send any modifications before issuing a read
122 ensureFlushedBuider();
123 sendRequest(request, completer);
124 return MappingCheckedFuture.create(future, ReadFailedException.MAPPER);
128 CheckedFuture<Boolean, ReadFailedException> doExists(final YangInstanceIdentifier path) {
129 final SettableFuture<Boolean> future = SettableFuture.create();
130 return sendReadRequest(new ExistsTransactionRequest(getIdentifier(), nextSequence(), localActor(), path,
131 isSnapshotOnly()), t -> completeExists(future, t), future);
135 CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> doRead(final YangInstanceIdentifier path) {
136 final SettableFuture<Optional<NormalizedNode<?, ?>>> future = SettableFuture.create();
137 return sendReadRequest(new ReadTransactionRequest(getIdentifier(), nextSequence(), localActor(), path,
138 isSnapshotOnly()), t -> completeRead(future, t), future);
141 private void ensureInitializedBuilder() {
143 builder.setSequence(nextSequence());
148 private void ensureFlushedBuider() {
154 private void ensureFlushedBuider(final Optional<Long> enqueuedTicks) {
156 flushBuilder(enqueuedTicks);
160 private void flushBuilder() {
161 flushBuilder(Optional.absent());
164 private void flushBuilder(final Optional<Long> enqueuedTicks) {
165 final ModifyTransactionRequest request = builder.build();
168 sendModification(request, enqueuedTicks);
171 private void sendModification(final TransactionRequest<?> request, final Optional<Long> enqueuedTicks) {
172 if (enqueuedTicks.isPresent()) {
173 enqueueRequest(request, response -> completeModify(request, response), enqueuedTicks.get().longValue());
175 sendRequest(request, response -> completeModify(request, response));
179 private void appendModification(final TransactionModification modification) {
180 appendModification(modification, Optional.absent());
183 private void appendModification(final TransactionModification modification, final Optional<Long> enqueuedTicks) {
184 if (operationFailure == null) {
185 ensureInitializedBuilder();
187 builder.addModification(modification);
188 if (builder.size() >= REQUEST_MAX_MODIFICATIONS) {
189 flushBuilder(enqueuedTicks);
192 LOG.debug("Transaction {} failed, not attempting further transactions", getIdentifier());
196 private void completeModify(final TransactionRequest<?> request, final Response<?, ?> response) {
197 LOG.debug("Modification request {} completed with {}", request, response);
199 if (response instanceof TransactionSuccess) {
201 recordSuccessfulRequest(request);
203 recordFailedResponse(response);
207 private Exception recordFailedResponse(final Response<?, ?> response) {
208 final Exception failure;
209 if (response instanceof RequestFailure) {
210 failure = ((RequestFailure<?, ?>) response).getCause();
212 LOG.warn("Unhandled response {}", response);
213 failure = new IllegalArgumentException("Unhandled response " + response.getClass());
216 if (operationFailure == null) {
217 LOG.debug("Transaction {} failed", getIdentifier(), failure);
218 operationFailure = failure;
223 private void failFuture(final SettableFuture<?> future, final Response<?, ?> response) {
224 future.setException(recordFailedResponse(response));
227 private void completeExists(final SettableFuture<Boolean> future, final Response<?, ?> response) {
228 LOG.debug("Exists request completed with {}", response);
230 if (response instanceof ExistsTransactionSuccess) {
231 future.set(((ExistsTransactionSuccess) response).getExists());
233 failFuture(future, response);
236 recordFinishedRequest(response);
239 private void completeRead(final SettableFuture<Optional<NormalizedNode<?, ?>>> future,
240 final Response<?, ?> response) {
241 LOG.debug("Read request completed with {}", response);
243 if (response instanceof ReadTransactionSuccess) {
244 future.set(((ReadTransactionSuccess) response).getData());
246 failFuture(future, response);
249 recordFinishedRequest(response);
253 ModifyTransactionRequest abortRequest() {
254 ensureInitializedBuilder();
256 final ModifyTransactionRequest ret = builder.build();
262 ModifyTransactionRequest commitRequest(final boolean coordinated) {
263 ensureInitializedBuilder();
264 builder.setCommit(coordinated);
266 final ModifyTransactionRequest ret = builder.build();
273 if (sendReadyOnSeal) {
274 ensureInitializedBuilder();
281 void flushState(final AbstractProxyTransaction successor) {
283 final ModifyTransactionRequest request = builder.build();
285 forwardToSuccessor(successor, request, null);
290 void forwardToRemote(final RemoteProxyTransaction successor, final TransactionRequest<?> request,
291 final Consumer<Response<?, ?>> callback) {
292 successor.handleForwardedRequest(request, callback);
295 private void handleForwardedRequest(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback) {
296 if (request instanceof ModifyTransactionRequest) {
297 final ModifyTransactionRequest req = (ModifyTransactionRequest) request;
299 req.getModifications().forEach(this::appendModification);
301 final java.util.Optional<PersistenceProtocol> maybeProto = req.getPersistenceProtocol();
302 if (maybeProto.isPresent()) {
305 final TransactionRequest<?> tmp;
306 switch (maybeProto.get()) {
308 tmp = abortRequest();
309 sendRequest(tmp, resp -> {
310 completeModify(tmp, resp);
311 callback.accept(resp);
315 tmp = commitRequest(false);
316 sendRequest(tmp, resp -> {
317 completeModify(tmp, resp);
318 callback.accept(resp);
322 tmp = commitRequest(true);
323 sendRequest(tmp, resp -> {
324 recordSuccessfulRequest(tmp);
325 callback.accept(resp);
332 throw new IllegalArgumentException("Unhandled protocol " + maybeProto.get());
335 } else if (request instanceof ReadTransactionRequest) {
336 ensureFlushedBuider();
337 sendRequest(new ReadTransactionRequest(getIdentifier(), nextSequence(), localActor(),
338 ((ReadTransactionRequest) request).getPath(), isSnapshotOnly()), resp -> {
339 recordFinishedRequest(resp);
340 callback.accept(resp);
342 } else if (request instanceof ExistsTransactionRequest) {
343 ensureFlushedBuider();
344 sendRequest(new ExistsTransactionRequest(getIdentifier(), nextSequence(), localActor(),
345 ((ExistsTransactionRequest) request).getPath(), isSnapshotOnly()), resp -> {
346 recordFinishedRequest(resp);
347 callback.accept(resp);
349 } else if (request instanceof TransactionPreCommitRequest) {
350 ensureFlushedBuider();
351 final TransactionRequest<?> tmp = new TransactionPreCommitRequest(getIdentifier(), nextSequence(),
353 sendRequest(tmp, resp -> {
354 recordSuccessfulRequest(tmp);
355 callback.accept(resp);
357 } else if (request instanceof TransactionDoCommitRequest) {
358 ensureFlushedBuider();
359 sendRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), callback);
360 } else if (request instanceof TransactionAbortRequest) {
361 ensureFlushedBuider();
362 sendDoAbort(callback);
363 } else if (request instanceof TransactionPurgeRequest) {
364 enqueuePurge(callback);
366 throw new IllegalArgumentException("Unhandled request {}" + request);
371 void forwardToLocal(final LocalProxyTransaction successor, final TransactionRequest<?> request,
372 final Consumer<Response<?, ?>> callback) {
373 successor.handleForwardedRemoteRequest(request, callback);
377 void handleReplayedLocalRequest(final AbstractLocalTransactionRequest<?> request,
378 final Consumer<Response<?, ?>> callback, final long enqueuedTicks) {
379 if (request instanceof CommitLocalTransactionRequest) {
380 replayLocalCommitRequest((CommitLocalTransactionRequest) request, callback, enqueuedTicks);
381 } else if (request instanceof AbortLocalTransactionRequest) {
382 enqueueRequest(abortRequest(), callback, enqueuedTicks);
384 throw new IllegalStateException("Unhandled request " + request);
388 private void replayLocalCommitRequest(final CommitLocalTransactionRequest request,
389 final Consumer<Response<?, ?>> callback, final long enqueuedTicks) {
390 final DataTreeModification mod = request.getModification();
391 final Optional<Long> optTicks = Optional.of(Long.valueOf(enqueuedTicks));
393 mod.applyToCursor(new AbstractDataTreeModificationCursor() {
395 public void write(final PathArgument child, final NormalizedNode<?, ?> data) {
396 appendModification(new TransactionWrite(current().node(child), data), optTicks);
400 public void merge(final PathArgument child, final NormalizedNode<?, ?> data) {
401 appendModification(new TransactionMerge(current().node(child), data), optTicks);
405 public void delete(final PathArgument child) {
406 appendModification(new TransactionDelete(current().node(child)), optTicks);
410 enqueueRequest(commitRequest(request.isCoordinated()), callback, enqueuedTicks);
414 void handleReplayedRemoteRequest(final TransactionRequest<?> request,
415 final @Nullable Consumer<Response<?, ?>> callback, final long enqueuedTicks) {
416 final Consumer<Response<?, ?>> cb = callback != null ? callback : resp -> { };
417 final Optional<Long> optTicks = Optional.of(Long.valueOf(enqueuedTicks));
419 if (request instanceof ModifyTransactionRequest) {
420 final ModifyTransactionRequest req = (ModifyTransactionRequest) request;
421 for (TransactionModification mod : req.getModifications()) {
422 appendModification(mod, optTicks);
425 final java.util.Optional<PersistenceProtocol> maybeProto = req.getPersistenceProtocol();
426 if (maybeProto.isPresent()) {
429 final TransactionRequest<?> tmp;
430 switch (maybeProto.get()) {
432 tmp = abortRequest();
433 enqueueRequest(tmp, resp -> {
434 completeModify(tmp, resp);
439 tmp = commitRequest(false);
440 enqueueRequest(tmp, resp -> {
441 completeModify(tmp, resp);
446 tmp = commitRequest(true);
447 enqueueRequest(tmp, resp -> {
448 recordSuccessfulRequest(tmp);
456 throw new IllegalArgumentException("Unhandled protocol " + maybeProto.get());
459 } else if (request instanceof ReadTransactionRequest) {
460 ensureFlushedBuider(optTicks);
461 enqueueRequest(new ReadTransactionRequest(getIdentifier(), nextSequence(), localActor(),
462 ((ReadTransactionRequest) request).getPath(), isSnapshotOnly()), resp -> {
463 recordFinishedRequest(resp);
466 } else if (request instanceof ExistsTransactionRequest) {
467 ensureFlushedBuider(optTicks);
468 enqueueRequest(new ExistsTransactionRequest(getIdentifier(), nextSequence(), localActor(),
469 ((ExistsTransactionRequest) request).getPath(), isSnapshotOnly()), resp -> {
470 recordFinishedRequest(resp);
473 } else if (request instanceof TransactionPreCommitRequest) {
474 ensureFlushedBuider(optTicks);
475 final TransactionRequest<?> tmp = new TransactionPreCommitRequest(getIdentifier(), nextSequence(),
477 enqueueRequest(tmp, resp -> {
478 recordSuccessfulRequest(tmp);
481 } else if (request instanceof TransactionDoCommitRequest) {
482 ensureFlushedBuider(optTicks);
483 enqueueRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), callback,
485 } else if (request instanceof TransactionAbortRequest) {
486 ensureFlushedBuider(optTicks);
487 enqueueDoAbort(callback, enqueuedTicks);
488 } else if (request instanceof TransactionPurgeRequest) {
489 enqueuePurge(callback, enqueuedTicks);
490 } else if (request instanceof IncrementTransactionSequenceRequest) {
491 final IncrementTransactionSequenceRequest req = (IncrementTransactionSequenceRequest) request;
492 ensureFlushedBuider(optTicks);
493 enqueueRequest(new IncrementTransactionSequenceRequest(getIdentifier(), nextSequence(), localActor(),
494 snapshotOnly, req.getIncrement()), callback, enqueuedTicks);
495 incrementSequence(req.getIncrement());
497 throw new IllegalArgumentException("Unhandled request {}" + request);