opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/databroker/actors/dds/RemoteProxyTransaction.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.controller.cluster.databroker.actors.dds;
   9
  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 org.opendaylight.controller.cluster.access.commands.AbstractReadTransactionRequest;
  17 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionRequest;
  18 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionSuccess;
  19 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequest;
  20 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequestBuilder;
  21 import org.opendaylight.controller.cluster.access.commands.ReadTransactionRequest;
  22 import org.opendaylight.controller.cluster.access.commands.ReadTransactionSuccess;
  23 import org.opendaylight.controller.cluster.access.commands.TransactionDelete;
  24 import org.opendaylight.controller.cluster.access.commands.TransactionMerge;
  25 import org.opendaylight.controller.cluster.access.commands.TransactionModification;
  26 import org.opendaylight.controller.cluster.access.commands.TransactionSuccess;
  27 import org.opendaylight.controller.cluster.access.commands.TransactionWrite;
  28 import org.opendaylight.controller.cluster.access.concepts.RequestFailure;
  29 import org.opendaylight.controller.cluster.access.concepts.Response;
  30 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  31 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  32 import org.opendaylight.yangtools.util.concurrent.MappingCheckedFuture;
  33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  34 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37
  38 /**
  39  * An {@link AbstractProxyTransaction} for dispatching a transaction towards a shard leader whose location is currently
  40  * not known or is known to be not co-located with the client.
  41  *
  42  * <p>
  43  * It packages operations and sends them via the client actor queue to the shard leader. That queue is responsible for
  44  * maintaining any submitted operations until the leader is discovered.
  45  *
  46  * <p>
  47  * This class is not safe to access from multiple application threads, as is usual for transactions. Its internal state
  48  * transitions based on backend responses are thread-safe.
  49  *
  50  * @author Robert Varga
  51  */
  52 final class RemoteProxyTransaction extends AbstractProxyTransaction {
  53     private static final Logger LOG = LoggerFactory.getLogger(RemoteProxyTransaction.class);
  54
  55     // FIXME: make this tuneable
  56     private static final int REQUEST_MAX_MODIFICATIONS = 1000;
  57
  58     private final ModifyTransactionRequestBuilder builder;
  59
  60     private boolean builderBusy;
  61
  62     private volatile Exception operationFailure;
  63
  64     RemoteProxyTransaction(final DistributedDataStoreClientBehavior client,
  65         final TransactionIdentifier identifier) {
  66         super(client);
  67         builder = new ModifyTransactionRequestBuilder(identifier, localActor());
  68     }
  69
  70     @Override
  71     public TransactionIdentifier getIdentifier() {
  72         return builder.getIdentifier();
  73     }
  74
  75     @Override
  76     void doDelete(final YangInstanceIdentifier path) {
  77         appendModification(new TransactionDelete(path));
  78     }
  79
  80     @Override
  81     void doMerge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
  82         appendModification(new TransactionMerge(path, data));
  83     }
  84
  85     @Override
  86     void doWrite(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
  87         appendModification(new TransactionWrite(path, data));
  88     }
  89
  90     private <T> CheckedFuture<T, ReadFailedException> sendReadRequest(final AbstractReadTransactionRequest<?> request,
  91             final Consumer<Response<?, ?>> completer, final ListenableFuture<T> future) {
  92         // Check if a previous operation failed. If it has, do not bother sending anything and report a failure
  93         final Exception local = operationFailure;
  94         if (local != null) {
  95             return Futures.immediateFailedCheckedFuture(new ReadFailedException("Previous operation failed", local));
  96         }
  97
  98         // Make sure we send any modifications before issuing a read
  99         ensureFlushedBuider();
 100         sendRequest(request, completer);
 101         return MappingCheckedFuture.create(future, ReadFailedException.MAPPER);
 102     }
 103
 104     @Override
 105     CheckedFuture<Boolean, ReadFailedException> doExists(final YangInstanceIdentifier path) {
 106         final SettableFuture<Boolean> future = SettableFuture.create();
 107         return sendReadRequest(new ExistsTransactionRequest(getIdentifier(), nextSequence(), localActor(), path),
 108             t -> completeExists(future, t), future);
 109     }
 110
 111     @Override
 112     CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> doRead(final YangInstanceIdentifier path) {
 113         final SettableFuture<Optional<NormalizedNode<?, ?>>> future = SettableFuture.create();
 114         return sendReadRequest(new ReadTransactionRequest(getIdentifier(), nextSequence(), localActor(), path),
 115             t -> completeRead(future, t), future);
 116     }
 117
 118     @Override
 119     void doAbort() {
 120         ensureInitializedBuider();
 121         builder.setAbort();
 122         flushBuilder();
 123     }
 124
 125     private void ensureInitializedBuider() {
 126         if (!builderBusy) {
 127             builder.setSequence(nextSequence());
 128             builderBusy = true;
 129         }
 130     }
 131
 132     private void ensureFlushedBuider() {
 133         if (builderBusy) {
 134             flushBuilder();
 135         }
 136     }
 137
 138     private void flushBuilder() {
 139         final ModifyTransactionRequest message = builder.build();
 140         builderBusy = false;
 141
 142         sendRequest(message, this::completeModify);
 143     }
 144
 145     private void appendModification(final TransactionModification modification) {
 146         if (operationFailure == null) {
 147             ensureInitializedBuider();
 148
 149             builder.addModification(modification);
 150             if (builder.size() >= REQUEST_MAX_MODIFICATIONS) {
 151                 flushBuilder();
 152             }
 153         } else {
 154             LOG.debug("Transaction {} failed, not attempting further transactions", getIdentifier());
 155         }
 156     }
 157
 158     private void completeModify(final Response<?, ?> response) {
 159         LOG.debug("Modification request completed with {}", response);
 160
 161         if (response instanceof TransactionSuccess) {
 162             // Happy path no-op
 163         } else {
 164             recordFailedResponse(response);
 165         }
 166     }
 167
 168     private Exception recordFailedResponse(final Response<?, ?> response) {
 169         final Exception failure;
 170         if (response instanceof RequestFailure) {
 171             failure = ((RequestFailure<?, ?>) response).getCause();
 172         } else {
 173             LOG.warn("Unhandled response {}", response);
 174             failure = new IllegalArgumentException("Unhandled response " + response.getClass());
 175         }
 176
 177         if (operationFailure == null) {
 178             LOG.debug("Transaction {} failed", getIdentifier(), failure);
 179             operationFailure = failure;
 180         }
 181         return failure;
 182     }
 183
 184     private void failFuture(final SettableFuture<?> future, final Response<?, ?> response) {
 185         future.setException(recordFailedResponse(response));
 186     }
 187
 188     private void completeExists(final SettableFuture<Boolean> future, final Response<?, ?> response) {
 189         LOG.debug("Exists request completed with {}", response);
 190
 191         if (response instanceof ExistsTransactionSuccess) {
 192             future.set(((ExistsTransactionSuccess) response).getExists());
 193         } else {
 194             failFuture(future, response);
 195         }
 196     }
 197
 198     private void completeRead(final SettableFuture<Optional<NormalizedNode<?, ?>>> future,
 199             final Response<?, ?> response) {
 200         LOG.debug("Read request completed with {}", response);
 201
 202         if (response instanceof ReadTransactionSuccess) {
 203             future.set(((ReadTransactionSuccess) response).getData());
 204         } else {
 205             failFuture(future, response);
 206         }
 207     }
 208
 209     @Override
 210     ModifyTransactionRequest doCommit(final boolean coordinated) {
 211         ensureInitializedBuider();
 212         builder.setCommit(coordinated);
 213
 214         final ModifyTransactionRequest ret = builder.build();
 215         builderBusy = false;
 216         return ret;
 217     }
 218
 219     @Override
 220     void doSeal() {
 221         // No-op
 222     }
 223 }