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.AbstractReadTransactionRequest;
19 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionRequest;
20 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionSuccess;
21 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequest;
22 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequestBuilder;
23 import org.opendaylight.controller.cluster.access.commands.PersistenceProtocol;
24 import org.opendaylight.controller.cluster.access.commands.ReadTransactionRequest;
25 import org.opendaylight.controller.cluster.access.commands.ReadTransactionSuccess;
26 import org.opendaylight.controller.cluster.access.commands.TransactionAbortRequest;
27 import org.opendaylight.controller.cluster.access.commands.TransactionDelete;
28 import org.opendaylight.controller.cluster.access.commands.TransactionDoCommitRequest;
29 import org.opendaylight.controller.cluster.access.commands.TransactionMerge;
30 import org.opendaylight.controller.cluster.access.commands.TransactionModification;
31 import org.opendaylight.controller.cluster.access.commands.TransactionPreCommitRequest;
32 import org.opendaylight.controller.cluster.access.commands.TransactionPurgeRequest;
33 import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
34 import org.opendaylight.controller.cluster.access.commands.TransactionSuccess;
35 import org.opendaylight.controller.cluster.access.commands.TransactionWrite;
36 import org.opendaylight.controller.cluster.access.concepts.RequestFailure;
37 import org.opendaylight.controller.cluster.access.concepts.Response;
38 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
39 import org.opendaylight.mdsal.common.api.ReadFailedException;
40 import org.opendaylight.yangtools.util.concurrent.MappingCheckedFuture;
41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
42 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
43 import org.slf4j.Logger;
44 import org.slf4j.LoggerFactory;
47 * An {@link AbstractProxyTransaction} for dispatching a transaction towards a shard leader whose location is currently
48 * not known or is known to be not co-located with the client.
51 * It packages operations and sends them via the client actor queue to the shard leader. That queue is responsible for
52 * maintaining any submitted operations until the leader is discovered.
55 * This class is not safe to access from multiple application threads, as is usual for transactions. Its internal state
56 * transitions based on backend responses are thread-safe.
58 * @author Robert Varga
60 final class RemoteProxyTransaction extends AbstractProxyTransaction {
61 private static final Logger LOG = LoggerFactory.getLogger(RemoteProxyTransaction.class);
63 // FIXME: make this tuneable
64 private static final int REQUEST_MAX_MODIFICATIONS = 1000;
66 private final ModifyTransactionRequestBuilder builder;
67 private final boolean sendReadyOnSeal;
68 private final boolean snapshotOnly;
70 private boolean builderBusy;
72 private volatile Exception operationFailure;
74 RemoteProxyTransaction(final ProxyHistory parent, final TransactionIdentifier identifier,
75 final boolean snapshotOnly, final boolean sendReadyOnSeal) {
77 this.snapshotOnly = snapshotOnly;
78 this.sendReadyOnSeal = sendReadyOnSeal;
79 builder = new ModifyTransactionRequestBuilder(identifier, localActor());
83 boolean isSnapshotOnly() {
88 public TransactionIdentifier getIdentifier() {
89 return builder.getIdentifier();
93 void doDelete(final YangInstanceIdentifier path) {
94 appendModification(new TransactionDelete(path));
98 void doMerge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
99 appendModification(new TransactionMerge(path, data));
103 void doWrite(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
104 appendModification(new TransactionWrite(path, data));
107 private <T> CheckedFuture<T, ReadFailedException> sendReadRequest(final AbstractReadTransactionRequest<?> request,
108 final Consumer<Response<?, ?>> completer, final ListenableFuture<T> future) {
109 // Check if a previous operation failed. If it has, do not bother sending anything and report a failure
110 final Exception local = operationFailure;
112 return Futures.immediateFailedCheckedFuture(new ReadFailedException("Previous operation failed", local));
115 // Make sure we send any modifications before issuing a read
116 ensureFlushedBuider();
117 sendRequest(request, completer);
118 return MappingCheckedFuture.create(future, ReadFailedException.MAPPER);
122 CheckedFuture<Boolean, ReadFailedException> doExists(final YangInstanceIdentifier path) {
123 final SettableFuture<Boolean> future = SettableFuture.create();
124 return sendReadRequest(new ExistsTransactionRequest(getIdentifier(), nextSequence(), localActor(), path,
125 isSnapshotOnly()), t -> completeExists(future, t), future);
129 CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> doRead(final YangInstanceIdentifier path) {
130 final SettableFuture<Optional<NormalizedNode<?, ?>>> future = SettableFuture.create();
131 return sendReadRequest(new ReadTransactionRequest(getIdentifier(), nextSequence(), localActor(), path,
132 isSnapshotOnly()), t -> completeRead(future, t), future);
137 ensureInitializedBuilder();
142 private void ensureInitializedBuilder() {
144 builder.setSequence(nextSequence());
149 private void ensureFlushedBuider() {
155 private void flushBuilder() {
156 final ModifyTransactionRequest request = builder.build();
159 sendModification(request);
162 private void sendModification(final TransactionRequest<?> request) {
163 sendRequest(request, response -> completeModify(request, response));
167 void handleForwardedRemoteRequest(final TransactionRequest<?> request,
168 final @Nullable Consumer<Response<?, ?>> callback) {
171 if (callback == null) {
172 sendModification(request);
177 * FindBugs is utterly stupid, as it does not recognize the fact that we have checked for null
178 * and reports NP_PARAMETER_MUST_BE_NONNULL_BUT_MARKED_AS_NULLABLE in the lambda below.
180 final Consumer<Response<?, ?>> findBugsIsStupid = callback;
182 // FIXME: do not use sendRequest() once we have throttling in place, as we have already waited the
183 // period required to get into the queue.
184 sendRequest(request, response -> {
185 findBugsIsStupid.accept(Preconditions.checkNotNull(response));
186 completeModify(request, response);
190 private void appendModification(final TransactionModification modification) {
191 if (operationFailure == null) {
192 ensureInitializedBuilder();
194 builder.addModification(modification);
195 if (builder.size() >= REQUEST_MAX_MODIFICATIONS) {
199 LOG.debug("Transaction {} failed, not attempting further transactions", getIdentifier());
203 private void completeModify(final TransactionRequest<?> request, final Response<?, ?> response) {
204 LOG.debug("Modification request {} completed with {}", request, response);
206 if (response instanceof TransactionSuccess) {
208 recordSuccessfulRequest(request);
210 recordFailedResponse(response);
214 private Exception recordFailedResponse(final Response<?, ?> response) {
215 final Exception failure;
216 if (response instanceof RequestFailure) {
217 failure = ((RequestFailure<?, ?>) response).getCause();
219 LOG.warn("Unhandled response {}", response);
220 failure = new IllegalArgumentException("Unhandled response " + response.getClass());
223 if (operationFailure == null) {
224 LOG.debug("Transaction {} failed", getIdentifier(), failure);
225 operationFailure = failure;
230 private void failFuture(final SettableFuture<?> future, final Response<?, ?> response) {
231 future.setException(recordFailedResponse(response));
234 private void completeExists(final SettableFuture<Boolean> future, final Response<?, ?> response) {
235 LOG.debug("Exists request completed with {}", response);
237 if (response instanceof ExistsTransactionSuccess) {
238 future.set(((ExistsTransactionSuccess) response).getExists());
240 failFuture(future, response);
243 recordFinishedRequest();
246 private void completeRead(final SettableFuture<Optional<NormalizedNode<?, ?>>> future,
247 final Response<?, ?> response) {
248 LOG.debug("Read request completed with {}", response);
250 if (response instanceof ReadTransactionSuccess) {
251 future.set(((ReadTransactionSuccess) response).getData());
253 failFuture(future, response);
256 recordFinishedRequest();
260 ModifyTransactionRequest commitRequest(final boolean coordinated) {
261 ensureInitializedBuilder();
262 builder.setCommit(coordinated);
264 final ModifyTransactionRequest ret = builder.build();
271 if (sendReadyOnSeal) {
272 ensureInitializedBuilder();
279 void flushState(final AbstractProxyTransaction successor) {
281 final ModifyTransactionRequest request = builder.build();
283 successor.handleForwardedRemoteRequest(request, null);
288 void forwardToRemote(final RemoteProxyTransaction successor, final TransactionRequest<?> request,
289 final Consumer<Response<?, ?>> callback) {
290 successor.handleForwardedRequest(request, callback);
293 private void handleForwardedRequest(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback) {
294 if (request instanceof ModifyTransactionRequest) {
295 final ModifyTransactionRequest req = (ModifyTransactionRequest) request;
297 req.getModifications().forEach(this::appendModification);
299 final java.util.Optional<PersistenceProtocol> maybeProto = req.getPersistenceProtocol();
300 if (maybeProto.isPresent()) {
303 switch (maybeProto.get()) {
305 ensureInitializedBuilder();
307 final ModifyTransactionRequest newReq = builder.build();
309 sendRequest(newReq, callback);
312 sendRequest(commitRequest(false), callback);
315 sendRequest(commitRequest(true), callback);
321 throw new IllegalArgumentException("Unhandled protocol " + maybeProto.get());
324 } else if (request instanceof ReadTransactionRequest) {
325 ensureFlushedBuider();
326 sendRequest(new ReadTransactionRequest(getIdentifier(), nextSequence(), localActor(),
327 ((ReadTransactionRequest) request).getPath(), isSnapshotOnly()), callback);
328 } else if (request instanceof ExistsTransactionRequest) {
329 ensureFlushedBuider();
330 sendRequest(new ExistsTransactionRequest(getIdentifier(), nextSequence(), localActor(),
331 ((ExistsTransactionRequest) request).getPath(), isSnapshotOnly()), callback);
332 } else if (request instanceof TransactionPreCommitRequest) {
333 ensureFlushedBuider();
334 sendRequest(new TransactionPreCommitRequest(getIdentifier(), nextSequence(), localActor()), callback);
335 } else if (request instanceof TransactionDoCommitRequest) {
336 ensureFlushedBuider();
337 sendRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), callback);
338 } else if (request instanceof TransactionAbortRequest) {
339 ensureFlushedBuider();
341 } else if (request instanceof TransactionPurgeRequest) {
344 throw new IllegalArgumentException("Unhandled request {}" + request);
349 void forwardToLocal(final LocalProxyTransaction successor, final TransactionRequest<?> request,
350 final Consumer<Response<?, ?>> callback) {
351 successor.handleForwardedRemoteRequest(request, callback);