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.Function;
  11 import com.google.common.util.concurrent.FluentFuture;
  12 import com.google.common.util.concurrent.ListenableFuture;
  13 import com.google.common.util.concurrent.SettableFuture;
  14 import java.util.Optional;
  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.FluentFutures;
  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;
  51
  52 /**
  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.
  55  *
  56  * <p>
  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.
  59  *
  60  * <p>
  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.
  63  *
  64  * @author Robert Varga
  65  */
  66 final class RemoteProxyTransaction extends AbstractProxyTransaction {
  67     private static final Logger LOG = LoggerFactory.getLogger(RemoteProxyTransaction.class);
  68
  69     private static final Function<Exception, Exception> NOOP_EXCEPTION_MAPPER = ex -> ex;
  70
  71     // FIXME: make this tuneable
  72     private static final int REQUEST_MAX_MODIFICATIONS = 1000;
  73
  74     private final ModifyTransactionRequestBuilder builder;
  75     private final boolean sendReadyOnSeal;
  76     private final boolean snapshotOnly;
  77
  78     private boolean builderBusy;
  79
  80     private volatile Exception operationFailure;
  81
  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     }
  89
  90     @Override
  91     boolean isSnapshotOnly() {
  92         return snapshotOnly;
  93     }
  94
  95     @Override
  96     public TransactionIdentifier getIdentifier() {
  97         return builder.getIdentifier();
  98     }
  99
 100     @Override
 101     void doDelete(final YangInstanceIdentifier path) {
 102         appendModification(new TransactionDelete(path), Optional.empty());
 103     }
 104
 105     @Override
 106     void doMerge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
 107         appendModification(new TransactionMerge(path, data), Optional.empty());
 108     }
 109
 110     @Override
 111     void doWrite(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
 112         appendModification(new TransactionWrite(path, data), Optional.empty());
 113     }
 114
 115     private <T> FluentFuture<T> sendReadRequest(final AbstractReadTransactionRequest<?> request,
 116             final Consumer<Response<?, ?>> completer, final ListenableFuture<T> future) {
 117         // Check if a previous operation failed. If it has, do not bother sending anything and report a failure
 118         final Exception local = operationFailure;
 119         if (local != null) {
 120             return FluentFutures.immediateFailedFluentFuture(
 121                     new ReadFailedException("Previous operation failed", local));
 122         }
 123
 124         // Make sure we send any modifications before issuing a read
 125         ensureFlushedBuider();
 126         sendRequest(request, completer);
 127         return FluentFuture.from(future);
 128     }
 129
 130     @Override
 131     FluentFuture<Boolean> doExists(final YangInstanceIdentifier path) {
 132         final SettableFuture<Boolean> future = SettableFuture.create();
 133         return sendReadRequest(new ExistsTransactionRequest(getIdentifier(), nextSequence(), localActor(), path,
 134             isSnapshotOnly()), t -> completeExists(future, t), future);
 135     }
 136
 137     @Override
 138     FluentFuture<Optional<NormalizedNode<?, ?>>> doRead(final YangInstanceIdentifier path) {
 139         final SettableFuture<Optional<NormalizedNode<?, ?>>> future = SettableFuture.create();
 140         return sendReadRequest(new ReadTransactionRequest(getIdentifier(), nextSequence(), localActor(), path,
 141             isSnapshotOnly()), t -> completeRead(future, t), future);
 142     }
 143
 144     private void ensureInitializedBuilder() {
 145         if (!builderBusy) {
 146             builder.setSequence(nextSequence());
 147             builderBusy = true;
 148         }
 149     }
 150
 151     private void ensureFlushedBuider() {
 152         ensureFlushedBuider(Optional.empty());
 153     }
 154
 155     private void ensureFlushedBuider(final Optional<Long> enqueuedTicks) {
 156         if (builderBusy) {
 157             flushBuilder(enqueuedTicks);
 158         }
 159     }
 160
 161     private void flushBuilder(final Optional<Long> enqueuedTicks) {
 162         final ModifyTransactionRequest request = builder.build();
 163         builderBusy = false;
 164
 165         sendModification(request, enqueuedTicks);
 166     }
 167
 168     private void sendModification(final TransactionRequest<?> request, final Optional<Long> enqueuedTicks) {
 169         if (enqueuedTicks.isPresent()) {
 170             enqueueRequest(request, response -> completeModify(request, response), enqueuedTicks.get().longValue());
 171         } else {
 172             sendRequest(request, response -> completeModify(request, response));
 173         }
 174     }
 175
 176     private void appendModification(final TransactionModification modification) {
 177         appendModification(modification, Optional.empty());
 178     }
 179
 180     private void appendModification(final TransactionModification modification, final Optional<Long> enqueuedTicks) {
 181         if (operationFailure == null) {
 182             ensureInitializedBuilder();
 183
 184             builder.addModification(modification);
 185             if (builder.size() >= REQUEST_MAX_MODIFICATIONS) {
 186                 flushBuilder(enqueuedTicks);
 187             }
 188         } else {
 189             LOG.debug("Transaction {} failed, not attempting further transactions", getIdentifier());
 190         }
 191     }
 192
 193     private void completeModify(final TransactionRequest<?> request, final Response<?, ?> response) {
 194         LOG.debug("Modification request {} completed with {}", request, response);
 195
 196         if (response instanceof TransactionSuccess) {
 197             // Happy path
 198             recordSuccessfulRequest(request);
 199         } else {
 200             recordFailedResponse(response, NOOP_EXCEPTION_MAPPER);
 201         }
 202     }
 203
 204     private <X extends Exception> X recordFailedResponse(final Response<?, ?> response,
 205             final Function<Exception, X> exMapper) {
 206         final Exception failure;
 207         if (response instanceof RequestFailure) {
 208             failure = ((RequestFailure<?, ?>) response).getCause();
 209         } else {
 210             LOG.warn("Unhandled response {}", response);
 211             failure = new IllegalArgumentException("Unhandled response " + response.getClass());
 212         }
 213
 214         if (operationFailure == null) {
 215             LOG.debug("Transaction {} failed", getIdentifier(), failure);
 216             operationFailure = failure;
 217         }
 218         return exMapper.apply(failure);
 219     }
 220
 221     private void failReadFuture(final SettableFuture<?> future, final Response<?, ?> response) {
 222         future.setException(recordFailedResponse(response, ReadFailedException.MAPPER));
 223     }
 224
 225     private void completeExists(final SettableFuture<Boolean> future, final Response<?, ?> response) {
 226         LOG.debug("Exists request completed with {}", response);
 227
 228         if (response instanceof ExistsTransactionSuccess) {
 229             future.set(((ExistsTransactionSuccess) response).getExists());
 230         } else {
 231             failReadFuture(future, response);
 232         }
 233
 234         recordFinishedRequest(response);
 235     }
 236
 237     private void completeRead(final SettableFuture<Optional<NormalizedNode<?, ?>>> future,
 238             final Response<?, ?> response) {
 239         LOG.debug("Read request completed with {}", response);
 240
 241         if (response instanceof ReadTransactionSuccess) {
 242             future.set(((ReadTransactionSuccess) response).getData());
 243         } else {
 244             failReadFuture(future, response);
 245         }
 246
 247         recordFinishedRequest(response);
 248     }
 249
 250     @Override
 251     ModifyTransactionRequest abortRequest() {
 252         ensureInitializedBuilder();
 253         builder.setAbort();
 254         builderBusy = false;
 255         return builder.build();
 256     }
 257
 258     @Override
 259     ModifyTransactionRequest commitRequest(final boolean coordinated) {
 260         ensureInitializedBuilder();
 261         builder.setCommit(coordinated);
 262         builderBusy = false;
 263         return builder.build();
 264     }
 265
 266     private ModifyTransactionRequest readyRequest() {
 267         ensureInitializedBuilder();
 268         builder.setReady();
 269         builderBusy = false;
 270         return builder.build();
 271     }
 272
 273     @Override
 274     boolean sealAndSend(final Optional<Long> enqueuedTicks) {
 275         if (sendReadyOnSeal) {
 276             ensureInitializedBuilder();
 277             builder.setReady();
 278             flushBuilder(enqueuedTicks);
 279         }
 280         return super.sealAndSend(enqueuedTicks);
 281     }
 282
 283     @Override
 284     java.util.Optional<ModifyTransactionRequest> flushState() {
 285         if (!builderBusy) {
 286             return java.util.Optional.empty();
 287         }
 288
 289         final ModifyTransactionRequest request = builder.build();
 290         builderBusy = false;
 291         return java.util.Optional.of(request);
 292     }
 293
 294     @Override
 295     void forwardToRemote(final RemoteProxyTransaction successor, final TransactionRequest<?> request,
 296             final Consumer<Response<?, ?>> callback) {
 297         successor.handleForwardedRequest(request, callback);
 298     }
 299
 300     void handleForwardedRequest(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback) {
 301         if (request instanceof ModifyTransactionRequest) {
 302             handleForwardedModifyTransactionRequest(callback, (ModifyTransactionRequest) request);
 303         } else if (request instanceof ReadTransactionRequest) {
 304             ensureFlushedBuider();
 305             sendRequest(new ReadTransactionRequest(getIdentifier(), nextSequence(), localActor(),
 306                 ((ReadTransactionRequest) request).getPath(), isSnapshotOnly()), resp -> {
 307                     recordFinishedRequest(resp);
 308                     callback.accept(resp);
 309                 });
 310         } else if (request instanceof ExistsTransactionRequest) {
 311             ensureFlushedBuider();
 312             sendRequest(new ExistsTransactionRequest(getIdentifier(), nextSequence(), localActor(),
 313                 ((ExistsTransactionRequest) request).getPath(), isSnapshotOnly()), resp -> {
 314                     recordFinishedRequest(resp);
 315                     callback.accept(resp);
 316                 });
 317         } else if (request instanceof TransactionPreCommitRequest) {
 318             ensureFlushedBuider();
 319             final TransactionRequest<?> tmp = new TransactionPreCommitRequest(getIdentifier(), nextSequence(),
 320                 localActor());
 321             sendRequest(tmp, resp -> {
 322                 recordSuccessfulRequest(tmp);
 323                 callback.accept(resp);
 324             });
 325         } else if (request instanceof TransactionDoCommitRequest) {
 326             ensureFlushedBuider();
 327             sendRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), callback);
 328         } else if (request instanceof TransactionAbortRequest) {
 329             ensureFlushedBuider();
 330             sendDoAbort(callback);
 331         } else if (request instanceof TransactionPurgeRequest) {
 332             enqueuePurge(callback);
 333         } else {
 334             throw new IllegalArgumentException("Unhandled request {}" + request);
 335         }
 336     }
 337
 338     private void handleForwardedModifyTransactionRequest(final Consumer<Response<?, ?>> callback,
 339             final ModifyTransactionRequest req) {
 340         req.getModifications().forEach(this::appendModification);
 341
 342         final java.util.Optional<PersistenceProtocol> maybeProto = req.getPersistenceProtocol();
 343         if (maybeProto.isPresent()) {
 344             // Persistence protocol implies we are sealed, propagate the marker, but hold off doing other actions
 345             // until we know what we are going to do.
 346             if (markSealed()) {
 347                 sealOnly();
 348             }
 349
 350             final TransactionRequest<?> tmp;
 351             switch (maybeProto.get()) {
 352                 case ABORT:
 353                     tmp = abortRequest();
 354                     sendRequest(tmp, resp -> {
 355                         completeModify(tmp, resp);
 356                         callback.accept(resp);
 357                     });
 358                     break;
 359                 case SIMPLE:
 360                     tmp = commitRequest(false);
 361                     sendRequest(tmp, resp -> {
 362                         completeModify(tmp, resp);
 363                         callback.accept(resp);
 364                     });
 365                     break;
 366                 case THREE_PHASE:
 367                     tmp = commitRequest(true);
 368                     sendRequest(tmp, resp -> {
 369                         recordSuccessfulRequest(tmp);
 370                         callback.accept(resp);
 371                     });
 372                     break;
 373                 case READY:
 374                     tmp = readyRequest();
 375                     sendRequest(tmp, resp -> {
 376                         recordSuccessfulRequest(tmp);
 377                         callback.accept(resp);
 378                     });
 379                     break;
 380                 default:
 381                     throw new IllegalArgumentException("Unhandled protocol " + maybeProto.get());
 382             }
 383         }
 384     }
 385
 386     @Override
 387     void forwardToLocal(final LocalProxyTransaction successor, final TransactionRequest<?> request,
 388             final Consumer<Response<?, ?>> callback) {
 389         successor.handleForwardedRemoteRequest(request, callback);
 390     }
 391
 392     @Override
 393     void handleReplayedLocalRequest(final AbstractLocalTransactionRequest<?> request,
 394             final Consumer<Response<?, ?>> callback, final long enqueuedTicks) {
 395         if (request instanceof CommitLocalTransactionRequest) {
 396             replayLocalCommitRequest((CommitLocalTransactionRequest) request, callback, enqueuedTicks);
 397         } else if (request instanceof AbortLocalTransactionRequest) {
 398             enqueueRequest(abortRequest(), callback, enqueuedTicks);
 399         } else {
 400             throw new IllegalStateException("Unhandled request " + request);
 401         }
 402     }
 403
 404     private void replayLocalCommitRequest(final CommitLocalTransactionRequest request,
 405             final Consumer<Response<?, ?>> callback, final long enqueuedTicks) {
 406         final DataTreeModification mod = request.getModification();
 407         final Optional<Long> optTicks = Optional.of(Long.valueOf(enqueuedTicks));
 408
 409         mod.applyToCursor(new AbstractDataTreeModificationCursor() {
 410             @Override
 411             public void write(final PathArgument child, final NormalizedNode<?, ?> data) {
 412                 appendModification(new TransactionWrite(current().node(child), data), optTicks);
 413             }
 414
 415             @Override
 416             public void merge(final PathArgument child, final NormalizedNode<?, ?> data) {
 417                 appendModification(new TransactionMerge(current().node(child), data), optTicks);
 418             }
 419
 420             @Override
 421             public void delete(final PathArgument child) {
 422                 appendModification(new TransactionDelete(current().node(child)), optTicks);
 423             }
 424         });
 425
 426         enqueueRequest(commitRequest(request.isCoordinated()), callback, enqueuedTicks);
 427     }
 428
 429     @Override
 430     void handleReplayedRemoteRequest(final TransactionRequest<?> request,
 431             @Nullable final Consumer<Response<?, ?>> callback, final long enqueuedTicks) {
 432         final Consumer<Response<?, ?>> cb = callback != null ? callback : resp -> { /* NOOP */ };
 433         final Optional<Long> optTicks = Optional.of(Long.valueOf(enqueuedTicks));
 434
 435         if (request instanceof ModifyTransactionRequest) {
 436             handleReplayedModifyTransactionRequest(enqueuedTicks, cb, (ModifyTransactionRequest) request);
 437         } else if (request instanceof ReadTransactionRequest) {
 438             ensureFlushedBuider(optTicks);
 439             enqueueRequest(new ReadTransactionRequest(getIdentifier(), nextSequence(), localActor(),
 440                 ((ReadTransactionRequest) request).getPath(), isSnapshotOnly()), resp -> {
 441                     recordFinishedRequest(resp);
 442                     cb.accept(resp);
 443                 }, enqueuedTicks);
 444         } else if (request instanceof ExistsTransactionRequest) {
 445             ensureFlushedBuider(optTicks);
 446             enqueueRequest(new ExistsTransactionRequest(getIdentifier(), nextSequence(), localActor(),
 447                 ((ExistsTransactionRequest) request).getPath(), isSnapshotOnly()), resp -> {
 448                     recordFinishedRequest(resp);
 449                     cb.accept(resp);
 450                 }, enqueuedTicks);
 451         } else if (request instanceof TransactionPreCommitRequest) {
 452             ensureFlushedBuider(optTicks);
 453             final TransactionRequest<?> tmp = new TransactionPreCommitRequest(getIdentifier(), nextSequence(),
 454                 localActor());
 455             enqueueRequest(tmp, resp -> {
 456                 recordSuccessfulRequest(tmp);
 457                 cb.accept(resp);
 458             }, enqueuedTicks);
 459         } else if (request instanceof TransactionDoCommitRequest) {
 460             ensureFlushedBuider(optTicks);
 461             enqueueRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), callback,
 462                 enqueuedTicks);
 463         } else if (request instanceof TransactionAbortRequest) {
 464             ensureFlushedBuider(optTicks);
 465             enqueueDoAbort(callback, enqueuedTicks);
 466         } else if (request instanceof TransactionPurgeRequest) {
 467             enqueuePurge(callback, enqueuedTicks);
 468         } else if (request instanceof IncrementTransactionSequenceRequest) {
 469             final IncrementTransactionSequenceRequest req = (IncrementTransactionSequenceRequest) request;
 470             ensureFlushedBuider(optTicks);
 471             enqueueRequest(new IncrementTransactionSequenceRequest(getIdentifier(), nextSequence(), localActor(),
 472                 snapshotOnly, req.getIncrement()), callback, enqueuedTicks);
 473             incrementSequence(req.getIncrement());
 474         } else {
 475             throw new IllegalArgumentException("Unhandled request {}" + request);
 476         }
 477     }
 478
 479     private void handleReplayedModifyTransactionRequest(final long enqueuedTicks, final Consumer<Response<?, ?>> cb,
 480             final ModifyTransactionRequest req) {
 481         req.getModifications().forEach(this::appendModification);
 482
 483         final java.util.Optional<PersistenceProtocol> maybeProto = req.getPersistenceProtocol();
 484         if (maybeProto.isPresent()) {
 485             // Persistence protocol implies we are sealed, propagate the marker, but hold off doing other actions
 486             // until we know what we are going to do.
 487             if (markSealed()) {
 488                 sealOnly();
 489             }
 490
 491             final TransactionRequest<?> tmp;
 492             switch (maybeProto.get()) {
 493                 case ABORT:
 494                     tmp = abortRequest();
 495                     enqueueRequest(tmp, resp -> {
 496                         completeModify(tmp, resp);
 497                         cb.accept(resp);
 498                     }, enqueuedTicks);
 499                     break;
 500                 case SIMPLE:
 501                     tmp = commitRequest(false);
 502                     enqueueRequest(tmp, resp -> {
 503                         completeModify(tmp, resp);
 504                         cb.accept(resp);
 505                     }, enqueuedTicks);
 506                     break;
 507                 case THREE_PHASE:
 508                     tmp = commitRequest(true);
 509                     enqueueRequest(tmp, resp -> {
 510                         recordSuccessfulRequest(tmp);
 511                         cb.accept(resp);
 512                     }, enqueuedTicks);
 513                     break;
 514                 case READY:
 515                     tmp = readyRequest();
 516                     enqueueRequest(tmp, resp -> {
 517                         recordSuccessfulRequest(tmp);
 518                         cb.accept(resp);
 519                     }, enqueuedTicks);
 520                     break;
 521                 default:
 522                     throw new IllegalArgumentException("Unhandled protocol " + maybeProto.get());
 523             }
 524         }
 525     }
 526 }