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.base.Preconditions;
12 import com.google.common.util.concurrent.CheckedFuture;
13 import com.google.common.util.concurrent.Futures;
14 import com.google.common.util.concurrent.ListenableFuture;
15 import com.google.common.util.concurrent.SettableFuture;
16 import java.util.function.Consumer;
17 import javax.annotation.Nullable;
18 import org.opendaylight.controller.cluster.access.commands.AbortLocalTransactionRequest;
19 import org.opendaylight.controller.cluster.access.commands.AbstractLocalTransactionRequest;
20 import org.opendaylight.controller.cluster.access.commands.AbstractReadTransactionRequest;
21 import org.opendaylight.controller.cluster.access.commands.CommitLocalTransactionRequest;
22 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionRequest;
23 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionSuccess;
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) {
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));
104 void doMerge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
105 appendModification(new TransactionMerge(path, data));
109 void doWrite(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
110 appendModification(new TransactionWrite(path, data));
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);
143 ensureInitializedBuilder();
148 private void ensureInitializedBuilder() {
150 builder.setSequence(nextSequence());
155 private void ensureFlushedBuider() {
161 private void flushBuilder() {
162 final ModifyTransactionRequest request = builder.build();
165 sendModification(request);
168 private void sendModification(final TransactionRequest<?> request) {
169 sendRequest(request, response -> completeModify(request, response));
173 void handleForwardedLocalRequest(final AbstractLocalTransactionRequest<?> request,
174 final Consumer<Response<?, ?>> callback) {
175 if (request instanceof CommitLocalTransactionRequest) {
176 replayLocalCommitRequest((CommitLocalTransactionRequest) request, callback);
177 } else if (request instanceof AbortLocalTransactionRequest) {
178 sendRequest(abortRequest(), callback);
180 throw new IllegalStateException("Unhandled request " + request);
184 private void replayLocalCommitRequest(final CommitLocalTransactionRequest request,
185 final Consumer<Response<?, ?>> callback) {
186 final DataTreeModification mod = request.getModification();
187 mod.applyToCursor(new AbstractDataTreeModificationCursor() {
189 public void write(final PathArgument child, final NormalizedNode<?, ?> data) {
190 doWrite(current().node(child), data);
194 public void merge(final PathArgument child, final NormalizedNode<?, ?> data) {
195 doMerge(current().node(child), data);
199 public void delete(final PathArgument child) {
200 doDelete(current().node(child));
204 sendRequest(commitRequest(request.isCoordinated()), callback);
208 void handleForwardedRemoteRequest(final TransactionRequest<?> request,
209 final @Nullable Consumer<Response<?, ?>> callback) {
212 if (callback == null) {
213 sendModification(request);
218 * FindBugs is utterly stupid, as it does not recognize the fact that we have checked for null
219 * and reports NP_PARAMETER_MUST_BE_NONNULL_BUT_MARKED_AS_NULLABLE in the lambda below.
221 final Consumer<Response<?, ?>> findBugsIsStupid = callback;
223 // FIXME: do not use sendRequest() once we have throttling in place, as we have already waited the
224 // period required to get into the queue.
225 sendRequest(request, response -> {
226 findBugsIsStupid.accept(Preconditions.checkNotNull(response));
227 completeModify(request, response);
231 private void appendModification(final TransactionModification modification) {
232 if (operationFailure == null) {
233 ensureInitializedBuilder();
235 builder.addModification(modification);
236 if (builder.size() >= REQUEST_MAX_MODIFICATIONS) {
240 LOG.debug("Transaction {} failed, not attempting further transactions", getIdentifier());
244 private void completeModify(final TransactionRequest<?> request, final Response<?, ?> response) {
245 LOG.debug("Modification request {} completed with {}", request, response);
247 if (response instanceof TransactionSuccess) {
249 recordSuccessfulRequest(request);
251 recordFailedResponse(response);
255 private Exception recordFailedResponse(final Response<?, ?> response) {
256 final Exception failure;
257 if (response instanceof RequestFailure) {
258 failure = ((RequestFailure<?, ?>) response).getCause();
260 LOG.warn("Unhandled response {}", response);
261 failure = new IllegalArgumentException("Unhandled response " + response.getClass());
264 if (operationFailure == null) {
265 LOG.debug("Transaction {} failed", getIdentifier(), failure);
266 operationFailure = failure;
271 private void failFuture(final SettableFuture<?> future, final Response<?, ?> response) {
272 future.setException(recordFailedResponse(response));
275 private void completeExists(final SettableFuture<Boolean> future, final Response<?, ?> response) {
276 LOG.debug("Exists request completed with {}", response);
278 if (response instanceof ExistsTransactionSuccess) {
279 future.set(((ExistsTransactionSuccess) response).getExists());
281 failFuture(future, response);
284 recordFinishedRequest();
287 private void completeRead(final SettableFuture<Optional<NormalizedNode<?, ?>>> future,
288 final Response<?, ?> response) {
289 LOG.debug("Read request completed with {}", response);
291 if (response instanceof ReadTransactionSuccess) {
292 future.set(((ReadTransactionSuccess) response).getData());
294 failFuture(future, response);
297 recordFinishedRequest();
300 private ModifyTransactionRequest abortRequest() {
301 ensureInitializedBuilder();
303 final ModifyTransactionRequest ret = builder.build();
309 ModifyTransactionRequest commitRequest(final boolean coordinated) {
310 ensureInitializedBuilder();
311 builder.setCommit(coordinated);
313 final ModifyTransactionRequest ret = builder.build();
320 if (sendReadyOnSeal) {
321 ensureInitializedBuilder();
328 void flushState(final AbstractProxyTransaction successor) {
330 final ModifyTransactionRequest request = builder.build();
332 successor.handleForwardedRemoteRequest(request, null);
337 void forwardToRemote(final RemoteProxyTransaction successor, final TransactionRequest<?> request,
338 final Consumer<Response<?, ?>> callback) {
339 successor.handleForwardedRequest(request, callback);
342 private void handleForwardedRequest(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback) {
343 if (request instanceof ModifyTransactionRequest) {
344 final ModifyTransactionRequest req = (ModifyTransactionRequest) request;
346 req.getModifications().forEach(this::appendModification);
348 final java.util.Optional<PersistenceProtocol> maybeProto = req.getPersistenceProtocol();
349 if (maybeProto.isPresent()) {
352 switch (maybeProto.get()) {
354 sendRequest(abortRequest(), callback);
357 sendRequest(commitRequest(false), callback);
360 sendRequest(commitRequest(true), callback);
366 throw new IllegalArgumentException("Unhandled protocol " + maybeProto.get());
369 } else if (request instanceof ReadTransactionRequest) {
370 ensureFlushedBuider();
371 sendRequest(new ReadTransactionRequest(getIdentifier(), nextSequence(), localActor(),
372 ((ReadTransactionRequest) request).getPath(), isSnapshotOnly()), callback);
373 } else if (request instanceof ExistsTransactionRequest) {
374 ensureFlushedBuider();
375 sendRequest(new ExistsTransactionRequest(getIdentifier(), nextSequence(), localActor(),
376 ((ExistsTransactionRequest) request).getPath(), isSnapshotOnly()), callback);
377 } else if (request instanceof TransactionPreCommitRequest) {
378 ensureFlushedBuider();
379 sendRequest(new TransactionPreCommitRequest(getIdentifier(), nextSequence(), localActor()), callback);
380 } else if (request instanceof TransactionDoCommitRequest) {
381 ensureFlushedBuider();
382 sendRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), callback);
383 } else if (request instanceof TransactionAbortRequest) {
384 ensureFlushedBuider();
386 } else if (request instanceof TransactionPurgeRequest) {
389 throw new IllegalArgumentException("Unhandled request {}" + request);
394 void forwardToLocal(final LocalProxyTransaction successor, final TransactionRequest<?> request,
395 final Consumer<Response<?, ?>> callback) {
396 successor.handleForwardedRemoteRequest(request, callback);