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 static com.google.common.base.Verify.verify;
12 import com.google.common.util.concurrent.FluentFuture;
13 import com.google.common.util.concurrent.ListenableFuture;
14 import com.google.common.util.concurrent.SettableFuture;
15 import java.util.Optional;
16 import java.util.OptionalLong;
17 import java.util.function.Consumer;
18 import org.opendaylight.controller.cluster.access.client.RequestTimeoutException;
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.AbstractReadTransactionRequest;
22 import org.opendaylight.controller.cluster.access.commands.CommitLocalTransactionRequest;
23 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionRequest;
24 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionSuccess;
25 import org.opendaylight.controller.cluster.access.commands.IncrementTransactionSequenceRequest;
26 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequest;
27 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequestBuilder;
28 import org.opendaylight.controller.cluster.access.commands.PersistenceProtocol;
29 import org.opendaylight.controller.cluster.access.commands.ReadTransactionRequest;
30 import org.opendaylight.controller.cluster.access.commands.ReadTransactionSuccess;
31 import org.opendaylight.controller.cluster.access.commands.TransactionAbortRequest;
32 import org.opendaylight.controller.cluster.access.commands.TransactionDelete;
33 import org.opendaylight.controller.cluster.access.commands.TransactionDoCommitRequest;
34 import org.opendaylight.controller.cluster.access.commands.TransactionMerge;
35 import org.opendaylight.controller.cluster.access.commands.TransactionModification;
36 import org.opendaylight.controller.cluster.access.commands.TransactionPreCommitRequest;
37 import org.opendaylight.controller.cluster.access.commands.TransactionPurgeRequest;
38 import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
39 import org.opendaylight.controller.cluster.access.commands.TransactionSuccess;
40 import org.opendaylight.controller.cluster.access.commands.TransactionWrite;
41 import org.opendaylight.controller.cluster.access.concepts.RequestException;
42 import org.opendaylight.controller.cluster.access.concepts.RequestFailure;
43 import org.opendaylight.controller.cluster.access.concepts.Response;
44 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
45 import org.opendaylight.controller.cluster.datastore.util.AbstractDataTreeModificationCursor;
46 import org.opendaylight.mdsal.common.api.DataStoreUnavailableException;
47 import org.opendaylight.mdsal.common.api.ReadFailedException;
48 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
49 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
50 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
51 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
52 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeModification;
53 import org.slf4j.Logger;
54 import org.slf4j.LoggerFactory;
57 * An {@link AbstractProxyTransaction} for dispatching a transaction towards a shard leader whose location is currently
58 * not known or is known to be not co-located with the client.
61 * It packages operations and sends them via the client actor queue to the shard leader. That queue is responsible for
62 * maintaining any submitted operations until the leader is discovered.
65 * This class is not safe to access from multiple application threads, as is usual for transactions. Its internal state
66 * transitions based on backend responses are thread-safe.
68 * @author Robert Varga
70 final class RemoteProxyTransaction extends AbstractProxyTransaction {
71 private static final Logger LOG = LoggerFactory.getLogger(RemoteProxyTransaction.class);
73 private final ModifyTransactionRequestBuilder builder;
74 private final boolean sendReadyOnSeal;
75 private final boolean snapshotOnly;
76 private final int maxModifications;
78 private boolean builderBusy;
80 private volatile Exception operationFailure;
82 RemoteProxyTransaction(final ProxyHistory parent, final TransactionIdentifier identifier,
83 final boolean snapshotOnly, final boolean sendReadyOnSeal, final boolean isDone) {
84 super(parent, isDone);
85 this.snapshotOnly = snapshotOnly;
86 this.sendReadyOnSeal = sendReadyOnSeal;
87 builder = new ModifyTransactionRequestBuilder(identifier, localActor());
88 maxModifications = parent.parent().actorUtils().getDatastoreContext().getShardBatchedModificationCount();
92 boolean isSnapshotOnly() {
97 public TransactionIdentifier getIdentifier() {
98 return builder.getIdentifier();
102 void doDelete(final YangInstanceIdentifier path) {
103 appendModification(new TransactionDelete(path), OptionalLong.empty());
107 void doMerge(final YangInstanceIdentifier path, final NormalizedNode data) {
108 appendModification(new TransactionMerge(path, data), OptionalLong.empty());
112 void doWrite(final YangInstanceIdentifier path, final NormalizedNode data) {
113 appendModification(new TransactionWrite(path, data), OptionalLong.empty());
116 private <T> FluentFuture<T> sendReadRequest(final AbstractReadTransactionRequest<?> request,
117 final Consumer<Response<?, ?>> completer, final ListenableFuture<T> future) {
118 // Check if a previous operation failed. If it has, do not bother sending anything and report a failure
119 final Exception local = operationFailure;
121 return FluentFutures.immediateFailedFluentFuture(
122 new ReadFailedException("Previous operation failed", local));
125 // Make sure we send any modifications before issuing a read
126 ensureFlushedBuider();
127 sendRequest(request, completer);
128 return FluentFuture.from(future);
132 FluentFuture<Boolean> doExists(final YangInstanceIdentifier path) {
133 final SettableFuture<Boolean> future = SettableFuture.create();
134 return sendReadRequest(new ExistsTransactionRequest(getIdentifier(), nextSequence(), localActor(), path,
135 isSnapshotOnly()), t -> completeExists(path, future, t), future);
139 FluentFuture<Optional<NormalizedNode>> doRead(final YangInstanceIdentifier path) {
140 final SettableFuture<Optional<NormalizedNode>> future = SettableFuture.create();
141 return sendReadRequest(new ReadTransactionRequest(getIdentifier(), nextSequence(), localActor(), path,
142 isSnapshotOnly()), t -> completeRead(path, future, t), future);
145 private void ensureInitializedBuilder() {
147 builder.setSequence(nextSequence());
152 private void ensureFlushedBuider() {
153 ensureFlushedBuider(OptionalLong.empty());
156 private void ensureFlushedBuider(final OptionalLong enqueuedTicks) {
158 flushBuilder(enqueuedTicks);
162 private void flushBuilder(final OptionalLong enqueuedTicks) {
163 final ModifyTransactionRequest request = builder.build();
166 sendModification(request, enqueuedTicks);
169 private void sendModification(final TransactionRequest<?> request, final OptionalLong enqueuedTicks) {
170 if (enqueuedTicks.isPresent()) {
171 enqueueRequest(request, response -> completeModify(request, response), enqueuedTicks.orElseThrow());
173 sendRequest(request, response -> completeModify(request, response));
177 private void appendModification(final TransactionModification modification) {
178 appendModification(modification, OptionalLong.empty());
181 private void appendModification(final TransactionModification modification, final OptionalLong enqueuedTicks) {
182 if (operationFailure == null) {
183 ensureInitializedBuilder();
185 builder.addModification(modification);
186 if (builder.size() >= maxModifications) {
187 flushBuilder(enqueuedTicks);
190 LOG.debug("Transaction {} failed, not attempting further transactions", getIdentifier());
194 private void completeModify(final TransactionRequest<?> request, final Response<?, ?> response) {
195 LOG.debug("Modification request {} completed with {}", request, response);
197 if (response instanceof TransactionSuccess) {
199 recordSuccessfulRequest(request);
201 recordFailedResponse(response);
205 private Exception recordFailedResponse(final Response<?, ?> response) {
206 final Exception failure;
207 if (response instanceof RequestFailure<?, ?> requestFailure) {
208 final RequestException cause = requestFailure.getCause();
209 failure = cause instanceof RequestTimeoutException
210 ? new DataStoreUnavailableException(cause.getMessage(), cause) : cause;
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 failReadFuture(final SettableFuture<?> future, final String message,
224 final Response<?, ?> response) {
225 future.setException(new ReadFailedException(message, recordFailedResponse(response)));
228 private void completeExists(final YangInstanceIdentifier path, final SettableFuture<Boolean> future,
229 final Response<?, ?> response) {
230 LOG.debug("Exists request for {} completed with {}", path, response);
232 if (response instanceof ExistsTransactionSuccess success) {
233 future.set(success.getExists());
235 failReadFuture(future, "Error executing exists request for path " + path, response);
238 recordFinishedRequest(response);
241 private void completeRead(final YangInstanceIdentifier path, final SettableFuture<Optional<NormalizedNode>> future,
242 final Response<?, ?> response) {
243 LOG.debug("Read request for {} completed with {}", path, response);
245 if (response instanceof ReadTransactionSuccess success) {
246 future.set(success.getData());
248 failReadFuture(future, "Error reading data for path " + path, response);
251 recordFinishedRequest(response);
255 ModifyTransactionRequest abortRequest() {
256 ensureInitializedBuilder();
259 return builder.build();
263 ModifyTransactionRequest commitRequest(final boolean coordinated) {
264 ensureInitializedBuilder();
265 builder.setCommit(coordinated);
267 return builder.build();
270 private ModifyTransactionRequest readyRequest() {
271 ensureInitializedBuilder();
274 return builder.build();
278 boolean sealAndSend(final OptionalLong enqueuedTicks) {
279 if (sendReadyOnSeal) {
280 ensureInitializedBuilder();
282 flushBuilder(enqueuedTicks);
284 return super.sealAndSend(enqueuedTicks);
288 Optional<ModifyTransactionRequest> flushState() {
290 return Optional.empty();
293 final ModifyTransactionRequest request = builder.build();
295 return Optional.of(request);
299 void forwardToRemote(final RemoteProxyTransaction successor, final TransactionRequest<?> request,
300 final Consumer<Response<?, ?>> callback) {
301 successor.handleForwardedRequest(request, callback);
304 void handleForwardedRequest(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback) {
305 if (request instanceof ModifyTransactionRequest modifyRequest) {
306 handleForwardedModifyTransactionRequest(callback, modifyRequest);
307 } else if (request instanceof ReadTransactionRequest readRequest) {
308 ensureFlushedBuider();
309 sendRequest(new ReadTransactionRequest(getIdentifier(), nextSequence(), localActor(),
310 readRequest.getPath(), isSnapshotOnly()), resp -> {
311 recordFinishedRequest(resp);
312 callback.accept(resp);
314 } else if (request instanceof ExistsTransactionRequest existsRequest) {
315 ensureFlushedBuider();
316 sendRequest(new ExistsTransactionRequest(getIdentifier(), nextSequence(), localActor(),
317 existsRequest.getPath(), isSnapshotOnly()), resp -> {
318 recordFinishedRequest(resp);
319 callback.accept(resp);
321 } else if (request instanceof TransactionPreCommitRequest) {
322 ensureFlushedBuider();
323 final TransactionRequest<?> tmp = new TransactionPreCommitRequest(getIdentifier(), nextSequence(),
325 sendRequest(tmp, resp -> {
326 recordSuccessfulRequest(tmp);
327 callback.accept(resp);
329 } else if (request instanceof TransactionDoCommitRequest) {
330 ensureFlushedBuider();
331 sendRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), callback);
332 } else if (request instanceof TransactionAbortRequest) {
333 ensureFlushedBuider();
334 sendDoAbort(callback);
335 } else if (request instanceof TransactionPurgeRequest) {
336 enqueuePurge(callback);
338 throw unhandledRequest(request);
342 private void handleForwardedModifyTransactionRequest(final Consumer<Response<?, ?>> callback,
343 final ModifyTransactionRequest req) {
344 req.getModifications().forEach(this::appendModification);
346 final Optional<PersistenceProtocol> maybeProto = req.getPersistenceProtocol();
347 if (maybeProto.isPresent()) {
348 // Persistence protocol implies we are sealed, propagate the marker, but hold off doing other actions
349 // until we know what we are going to do.
352 LOG.debug("Proxy {} has a successor, which should receive seal through a separate request", this);
356 final TransactionRequest<?> tmp;
357 switch (maybeProto.orElseThrow()) {
359 tmp = abortRequest();
360 sendRequest(tmp, resp -> {
361 completeModify(tmp, resp);
362 callback.accept(resp);
366 tmp = commitRequest(false);
367 sendRequest(tmp, resp -> {
368 completeModify(tmp, resp);
369 callback.accept(resp);
373 tmp = commitRequest(true);
374 sendRequest(tmp, resp -> {
375 recordSuccessfulRequest(tmp);
376 callback.accept(resp);
380 tmp = readyRequest();
381 sendRequest(tmp, resp -> {
382 recordSuccessfulRequest(tmp);
383 callback.accept(resp);
387 throw new IllegalArgumentException("Unhandled protocol " + maybeProto.orElseThrow());
393 void forwardToLocal(final LocalProxyTransaction successor, final TransactionRequest<?> request,
394 final Consumer<Response<?, ?>> callback) {
395 successor.handleForwardedRemoteRequest(request, callback);
399 void handleReplayedLocalRequest(final AbstractLocalTransactionRequest<?> request,
400 final Consumer<Response<?, ?>> callback, final long enqueuedTicks) {
401 if (request instanceof CommitLocalTransactionRequest commitRequest) {
402 replayLocalCommitRequest(commitRequest, callback, enqueuedTicks);
403 } else if (request instanceof AbortLocalTransactionRequest) {
404 enqueueRequest(abortRequest(), callback, enqueuedTicks);
406 throw unhandledRequest(request);
410 private void replayLocalCommitRequest(final CommitLocalTransactionRequest request,
411 final Consumer<Response<?, ?>> callback, final long enqueuedTicks) {
412 final DataTreeModification mod = request.getModification();
413 final OptionalLong optTicks = OptionalLong.of(enqueuedTicks);
415 mod.applyToCursor(new AbstractDataTreeModificationCursor() {
417 public void write(final PathArgument child, final NormalizedNode data) {
418 appendModification(new TransactionWrite(current().node(child), data), optTicks);
422 public void merge(final PathArgument child, final NormalizedNode data) {
423 appendModification(new TransactionMerge(current().node(child), data), optTicks);
427 public void delete(final PathArgument child) {
428 appendModification(new TransactionDelete(current().node(child)), optTicks);
432 enqueueRequest(commitRequest(request.isCoordinated()), callback, enqueuedTicks);
436 void handleReplayedRemoteRequest(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback,
437 final long enqueuedTicks) {
438 final Consumer<Response<?, ?>> cb = callback != null ? callback : resp -> { /* NOOP */ };
439 final OptionalLong optTicks = OptionalLong.of(enqueuedTicks);
441 if (request instanceof ModifyTransactionRequest modifyRequest) {
442 handleReplayedModifyTransactionRequest(enqueuedTicks, cb, modifyRequest);
443 } else if (request instanceof ReadTransactionRequest readRequest) {
444 ensureFlushedBuider(optTicks);
445 enqueueRequest(new ReadTransactionRequest(getIdentifier(), nextSequence(), localActor(),
446 readRequest.getPath(), isSnapshotOnly()), resp -> {
447 recordFinishedRequest(resp);
450 } else if (request instanceof ExistsTransactionRequest existsRequest) {
451 ensureFlushedBuider(optTicks);
452 enqueueRequest(new ExistsTransactionRequest(getIdentifier(), nextSequence(), localActor(),
453 existsRequest.getPath(), isSnapshotOnly()), resp -> {
454 recordFinishedRequest(resp);
457 } else if (request instanceof TransactionPreCommitRequest) {
458 ensureFlushedBuider(optTicks);
459 final TransactionRequest<?> tmp = new TransactionPreCommitRequest(getIdentifier(), nextSequence(),
461 enqueueRequest(tmp, resp -> {
462 recordSuccessfulRequest(tmp);
465 } else if (request instanceof TransactionDoCommitRequest) {
466 ensureFlushedBuider(optTicks);
467 enqueueRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), callback,
469 } else if (request instanceof TransactionAbortRequest) {
470 ensureFlushedBuider(optTicks);
471 enqueueDoAbort(callback, enqueuedTicks);
472 } else if (request instanceof TransactionPurgeRequest) {
473 enqueuePurge(callback, enqueuedTicks);
474 } else if (request instanceof IncrementTransactionSequenceRequest req) {
475 ensureFlushedBuider(optTicks);
476 enqueueRequest(new IncrementTransactionSequenceRequest(getIdentifier(), nextSequence(), localActor(),
477 snapshotOnly, req.getIncrement()), callback, enqueuedTicks);
478 incrementSequence(req.getIncrement());
480 throw unhandledRequest(request);
484 private void handleReplayedModifyTransactionRequest(final long enqueuedTicks, final Consumer<Response<?, ?>> cb,
485 final ModifyTransactionRequest req) {
486 req.getModifications().forEach(this::appendModification);
488 final Optional<PersistenceProtocol> maybeProto = req.getPersistenceProtocol();
489 if (maybeProto.isPresent()) {
490 // Persistence protocol implies we are sealed, propagate the marker, but hold off doing other actions
491 // until we know what we are going to do.
493 verify(sealOnly(), "Attempted to replay seal on %s", this);
496 final TransactionRequest<?> tmp;
497 switch (maybeProto.orElseThrow()) {
499 tmp = abortRequest();
500 enqueueRequest(tmp, resp -> {
501 completeModify(tmp, resp);
506 tmp = commitRequest(false);
507 enqueueRequest(tmp, resp -> {
508 completeModify(tmp, resp);
513 tmp = commitRequest(true);
514 enqueueRequest(tmp, resp -> {
515 recordSuccessfulRequest(tmp);
520 tmp = readyRequest();
521 enqueueRequest(tmp, resp -> {
522 recordSuccessfulRequest(tmp);
527 throw new IllegalArgumentException("Unhandled protocol " + maybeProto.orElseThrow());