BUG-8704: rework seal mechanics to not wait during replay
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / databroker / actors / dds / RemoteProxyTransaction.java
index b8afb0e90d0f6934bff0f1d31980bad5b627256b..1ba96426df75feb7e38e4db0f217c8c4f98708b8 100644 (file)
@@ -8,16 +8,19 @@
 package org.opendaylight.controller.cluster.databroker.actors.dds;
 
 import com.google.common.base.Optional;
-import com.google.common.base.Preconditions;
 import com.google.common.util.concurrent.CheckedFuture;
 import com.google.common.util.concurrent.Futures;
 import com.google.common.util.concurrent.ListenableFuture;
 import com.google.common.util.concurrent.SettableFuture;
 import java.util.function.Consumer;
 import javax.annotation.Nullable;
+import org.opendaylight.controller.cluster.access.commands.AbortLocalTransactionRequest;
+import org.opendaylight.controller.cluster.access.commands.AbstractLocalTransactionRequest;
 import org.opendaylight.controller.cluster.access.commands.AbstractReadTransactionRequest;
+import org.opendaylight.controller.cluster.access.commands.CommitLocalTransactionRequest;
 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionRequest;
 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionSuccess;
+import org.opendaylight.controller.cluster.access.commands.IncrementTransactionSequenceRequest;
 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequest;
 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequestBuilder;
 import org.opendaylight.controller.cluster.access.commands.PersistenceProtocol;
@@ -36,10 +39,13 @@ import org.opendaylight.controller.cluster.access.commands.TransactionWrite;
 import org.opendaylight.controller.cluster.access.concepts.RequestFailure;
 import org.opendaylight.controller.cluster.access.concepts.Response;
 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
+import org.opendaylight.controller.cluster.datastore.util.AbstractDataTreeModificationCursor;
 import org.opendaylight.mdsal.common.api.ReadFailedException;
 import org.opendaylight.yangtools.util.concurrent.MappingCheckedFuture;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -71,10 +77,9 @@ final class RemoteProxyTransaction extends AbstractProxyTransaction {
 
     private volatile Exception operationFailure;
 
-
     RemoteProxyTransaction(final ProxyHistory parent, final TransactionIdentifier identifier,
-            final boolean snapshotOnly, final boolean sendReadyOnSeal) {
-        super(parent);
+            final boolean snapshotOnly, final boolean sendReadyOnSeal, final boolean isDone) {
+        super(parent, isDone);
         this.snapshotOnly = snapshotOnly;
         this.sendReadyOnSeal = sendReadyOnSeal;
         builder = new ModifyTransactionRequestBuilder(identifier, localActor());
@@ -92,17 +97,17 @@ final class RemoteProxyTransaction extends AbstractProxyTransaction {
 
     @Override
     void doDelete(final YangInstanceIdentifier path) {
-        appendModification(new TransactionDelete(path));
+        appendModification(new TransactionDelete(path), Optional.absent());
     }
 
     @Override
     void doMerge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
-        appendModification(new TransactionMerge(path, data));
+        appendModification(new TransactionMerge(path, data), Optional.absent());
     }
 
     @Override
     void doWrite(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
-        appendModification(new TransactionWrite(path, data));
+        appendModification(new TransactionWrite(path, data), Optional.absent());
     }
 
     private <T> CheckedFuture<T, ReadFailedException> sendReadRequest(final AbstractReadTransactionRequest<?> request,
@@ -133,13 +138,6 @@ final class RemoteProxyTransaction extends AbstractProxyTransaction {
             isSnapshotOnly()), t -> completeRead(future, t), future);
     }
 
-    @Override
-    void doAbort() {
-        ensureInitializedBuilder();
-        builder.setAbort();
-        flushBuilder();
-    }
-
     private void ensureInitializedBuilder() {
         if (!builderBusy) {
             builder.setSequence(nextSequence());
@@ -148,53 +146,41 @@ final class RemoteProxyTransaction extends AbstractProxyTransaction {
     }
 
     private void ensureFlushedBuider() {
+        ensureFlushedBuider(Optional.absent());
+    }
+
+    private void ensureFlushedBuider(final Optional<Long> enqueuedTicks) {
         if (builderBusy) {
-            flushBuilder();
+            flushBuilder(enqueuedTicks);
         }
     }
 
-    private void flushBuilder() {
+    private void flushBuilder(final Optional<Long> enqueuedTicks) {
         final ModifyTransactionRequest request = builder.build();
         builderBusy = false;
 
-        sendModification(request);
-    }
-
-    private void sendModification(final TransactionRequest<?> request) {
-        sendRequest(request, response -> completeModify(request, response));
+        sendModification(request, enqueuedTicks);
     }
 
-    @Override
-    void handleForwardedRemoteRequest(final TransactionRequest<?> request,
-            final @Nullable Consumer<Response<?, ?>> callback) {
-        nextSequence();
-
-        if (callback == null) {
-            sendModification(request);
-            return;
+    private void sendModification(final TransactionRequest<?> request, final Optional<Long> enqueuedTicks) {
+        if (enqueuedTicks.isPresent()) {
+            enqueueRequest(request, response -> completeModify(request, response), enqueuedTicks.get().longValue());
+        } else {
+            sendRequest(request, response -> completeModify(request, response));
         }
-
-        /*
-         * FindBugs is utterly stupid, as it does not recognize the fact that we have checked for null
-         * and reports NP_PARAMETER_MUST_BE_NONNULL_BUT_MARKED_AS_NULLABLE in the lambda below.
-         */
-        final Consumer<Response<?, ?>> findBugsIsStupid = callback;
-
-        // FIXME: do not use sendRequest() once we have throttling in place, as we have already waited the
-        //        period required to get into the queue.
-        sendRequest(request, response -> {
-            findBugsIsStupid.accept(Preconditions.checkNotNull(response));
-            completeModify(request, response);
-        });
     }
 
     private void appendModification(final TransactionModification modification) {
+        appendModification(modification, Optional.absent());
+    }
+
+    private void appendModification(final TransactionModification modification, final Optional<Long> enqueuedTicks) {
         if (operationFailure == null) {
             ensureInitializedBuilder();
 
             builder.addModification(modification);
             if (builder.size() >= REQUEST_MAX_MODIFICATIONS) {
-                flushBuilder();
+                flushBuilder(enqueuedTicks);
             }
         } else {
             LOG.debug("Transaction {} failed, not attempting further transactions", getIdentifier());
@@ -241,7 +227,7 @@ final class RemoteProxyTransaction extends AbstractProxyTransaction {
             failFuture(future, response);
         }
 
-        recordFinishedRequest();
+        recordFinishedRequest(response);
     }
 
     private void completeRead(final SettableFuture<Optional<NormalizedNode<?, ?>>> future,
@@ -254,26 +240,40 @@ final class RemoteProxyTransaction extends AbstractProxyTransaction {
             failFuture(future, response);
         }
 
-        recordFinishedRequest();
+        recordFinishedRequest(response);
+    }
+
+    @Override
+    ModifyTransactionRequest abortRequest() {
+        ensureInitializedBuilder();
+        builder.setAbort();
+        builderBusy = false;
+        return builder.build();
     }
 
     @Override
     ModifyTransactionRequest commitRequest(final boolean coordinated) {
         ensureInitializedBuilder();
         builder.setCommit(coordinated);
+        builderBusy = false;
+        return builder.build();
+    }
 
-        final ModifyTransactionRequest ret = builder.build();
+    private ModifyTransactionRequest readyRequest() {
+        ensureInitializedBuilder();
+        builder.setReady();
         builderBusy = false;
-        return ret;
+        return builder.build();
     }
 
     @Override
-    void doSeal() {
+    boolean sealAndSend(final Optional<Long> enqueuedTicks) {
         if (sendReadyOnSeal) {
             ensureInitializedBuilder();
             builder.setReady();
-            flushBuilder();
+            flushBuilder(enqueuedTicks);
         }
+        return super.sealAndSend(enqueuedTicks);
     }
 
     @Override
@@ -281,7 +281,7 @@ final class RemoteProxyTransaction extends AbstractProxyTransaction {
         if (builderBusy) {
             final ModifyTransactionRequest request = builder.build();
             builderBusy = false;
-            successor.handleForwardedRemoteRequest(request, null);
+            forwardToSuccessor(successor, request, null);
         }
     }
 
@@ -299,17 +299,41 @@ final class RemoteProxyTransaction extends AbstractProxyTransaction {
 
             final java.util.Optional<PersistenceProtocol> maybeProto = req.getPersistenceProtocol();
             if (maybeProto.isPresent()) {
-                ensureSealed();
+                // Persistence protocol implies we are sealed, propagate the marker, but hold off doing other actions
+                // until we know what we are going to do.
+                if (markSealed()) {
+                    sealOnly();
+                }
 
+                final TransactionRequest<?> tmp;
                 switch (maybeProto.get()) {
                     case ABORT:
-                        sendAbort(callback);
+                        tmp = abortRequest();
+                        sendRequest(tmp, resp -> {
+                            completeModify(tmp, resp);
+                            callback.accept(resp);
+                        });
                         break;
                     case SIMPLE:
-                        sendRequest(commitRequest(false), callback);
+                        tmp = commitRequest(false);
+                        sendRequest(tmp, resp -> {
+                            completeModify(tmp, resp);
+                            callback.accept(resp);
+                        });
                         break;
                     case THREE_PHASE:
-                        sendRequest(commitRequest(true), callback);
+                        tmp = commitRequest(true);
+                        sendRequest(tmp, resp -> {
+                            recordSuccessfulRequest(tmp);
+                            callback.accept(resp);
+                        });
+                        break;
+                    case READY:
+                        tmp = readyRequest();
+                        sendRequest(tmp, resp -> {
+                            recordSuccessfulRequest(tmp);
+                            callback.accept(resp);
+                        });
                         break;
                     default:
                         throw new IllegalArgumentException("Unhandled protocol " + maybeProto.get());
@@ -318,22 +342,33 @@ final class RemoteProxyTransaction extends AbstractProxyTransaction {
         } else if (request instanceof ReadTransactionRequest) {
             ensureFlushedBuider();
             sendRequest(new ReadTransactionRequest(getIdentifier(), nextSequence(), localActor(),
-                ((ReadTransactionRequest) request).getPath(), isSnapshotOnly()), callback);
+                ((ReadTransactionRequest) request).getPath(), isSnapshotOnly()), resp -> {
+                    recordFinishedRequest(resp);
+                    callback.accept(resp);
+                });
         } else if (request instanceof ExistsTransactionRequest) {
             ensureFlushedBuider();
             sendRequest(new ExistsTransactionRequest(getIdentifier(), nextSequence(), localActor(),
-                ((ExistsTransactionRequest) request).getPath(), isSnapshotOnly()), callback);
+                ((ExistsTransactionRequest) request).getPath(), isSnapshotOnly()), resp -> {
+                    recordFinishedRequest(resp);
+                    callback.accept(resp);
+                });
         } else if (request instanceof TransactionPreCommitRequest) {
             ensureFlushedBuider();
-            sendRequest(new TransactionPreCommitRequest(getIdentifier(), nextSequence(), localActor()), callback);
+            final TransactionRequest<?> tmp = new TransactionPreCommitRequest(getIdentifier(), nextSequence(),
+                localActor());
+            sendRequest(tmp, resp -> {
+                recordSuccessfulRequest(tmp);
+                callback.accept(resp);
+            });
         } else if (request instanceof TransactionDoCommitRequest) {
             ensureFlushedBuider();
             sendRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), callback);
         } else if (request instanceof TransactionAbortRequest) {
             ensureFlushedBuider();
-            sendAbort(callback);
+            sendDoAbort(callback);
         } else if (request instanceof TransactionPurgeRequest) {
-            purge();
+            enqueuePurge(callback);
         } else {
             throw new IllegalArgumentException("Unhandled request {}" + request);
         }
@@ -344,4 +379,137 @@ final class RemoteProxyTransaction extends AbstractProxyTransaction {
             final Consumer<Response<?, ?>> callback) {
         successor.handleForwardedRemoteRequest(request, callback);
     }
+
+    @Override
+    void handleReplayedLocalRequest(final AbstractLocalTransactionRequest<?> request,
+            final Consumer<Response<?, ?>> callback, final long enqueuedTicks) {
+        if (request instanceof CommitLocalTransactionRequest) {
+            replayLocalCommitRequest((CommitLocalTransactionRequest) request, callback, enqueuedTicks);
+        } else if (request instanceof AbortLocalTransactionRequest) {
+            enqueueRequest(abortRequest(), callback, enqueuedTicks);
+        } else {
+            throw new IllegalStateException("Unhandled request " + request);
+        }
+    }
+
+    private void replayLocalCommitRequest(final CommitLocalTransactionRequest request,
+            final Consumer<Response<?, ?>> callback, final long enqueuedTicks) {
+        final DataTreeModification mod = request.getModification();
+        final Optional<Long> optTicks = Optional.of(Long.valueOf(enqueuedTicks));
+
+        mod.applyToCursor(new AbstractDataTreeModificationCursor() {
+            @Override
+            public void write(final PathArgument child, final NormalizedNode<?, ?> data) {
+                appendModification(new TransactionWrite(current().node(child), data), optTicks);
+            }
+
+            @Override
+            public void merge(final PathArgument child, final NormalizedNode<?, ?> data) {
+                appendModification(new TransactionMerge(current().node(child), data), optTicks);
+            }
+
+            @Override
+            public void delete(final PathArgument child) {
+                appendModification(new TransactionDelete(current().node(child)), optTicks);
+            }
+        });
+
+        enqueueRequest(commitRequest(request.isCoordinated()), callback, enqueuedTicks);
+    }
+
+    @Override
+    void handleReplayedRemoteRequest(final TransactionRequest<?> request,
+            final @Nullable Consumer<Response<?, ?>> callback, final long enqueuedTicks) {
+        final Consumer<Response<?, ?>> cb = callback != null ? callback : resp -> { };
+        final Optional<Long> optTicks = Optional.of(Long.valueOf(enqueuedTicks));
+
+        if (request instanceof ModifyTransactionRequest) {
+            final ModifyTransactionRequest req = (ModifyTransactionRequest) request;
+            for (TransactionModification mod : req.getModifications()) {
+                appendModification(mod, optTicks);
+            }
+
+            final java.util.Optional<PersistenceProtocol> maybeProto = req.getPersistenceProtocol();
+            if (maybeProto.isPresent()) {
+                // Persistence protocol implies we are sealed, propagate the marker, but hold off doing other actions
+                // until we know what we are going to do.
+                if (markSealed()) {
+                    sealOnly();
+                }
+
+                final TransactionRequest<?> tmp;
+                switch (maybeProto.get()) {
+                    case ABORT:
+                        tmp = abortRequest();
+                        enqueueRequest(tmp, resp -> {
+                            completeModify(tmp, resp);
+                            cb.accept(resp);
+                        }, enqueuedTicks);
+                        break;
+                    case SIMPLE:
+                        tmp = commitRequest(false);
+                        enqueueRequest(tmp, resp -> {
+                            completeModify(tmp, resp);
+                            cb.accept(resp);
+                        }, enqueuedTicks);
+                        break;
+                    case THREE_PHASE:
+                        tmp = commitRequest(true);
+                        enqueueRequest(tmp, resp -> {
+                            recordSuccessfulRequest(tmp);
+                            cb.accept(resp);
+                        }, enqueuedTicks);
+                        break;
+                    case READY:
+                        tmp = readyRequest();
+                        enqueueRequest(tmp, resp -> {
+                            recordSuccessfulRequest(tmp);
+                            cb.accept(resp);
+                        }, enqueuedTicks);
+                        break;
+                    default:
+                        throw new IllegalArgumentException("Unhandled protocol " + maybeProto.get());
+                }
+            }
+        } else if (request instanceof ReadTransactionRequest) {
+            ensureFlushedBuider(optTicks);
+            enqueueRequest(new ReadTransactionRequest(getIdentifier(), nextSequence(), localActor(),
+                ((ReadTransactionRequest) request).getPath(), isSnapshotOnly()), resp -> {
+                    recordFinishedRequest(resp);
+                    cb.accept(resp);
+                }, enqueuedTicks);
+        } else if (request instanceof ExistsTransactionRequest) {
+            ensureFlushedBuider(optTicks);
+            enqueueRequest(new ExistsTransactionRequest(getIdentifier(), nextSequence(), localActor(),
+                ((ExistsTransactionRequest) request).getPath(), isSnapshotOnly()), resp -> {
+                    recordFinishedRequest(resp);
+                    cb.accept(resp);
+                }, enqueuedTicks);
+        } else if (request instanceof TransactionPreCommitRequest) {
+            ensureFlushedBuider(optTicks);
+            final TransactionRequest<?> tmp = new TransactionPreCommitRequest(getIdentifier(), nextSequence(),
+                localActor());
+            enqueueRequest(tmp, resp -> {
+                recordSuccessfulRequest(tmp);
+                cb.accept(resp);
+            }, enqueuedTicks);
+        } else if (request instanceof TransactionDoCommitRequest) {
+            ensureFlushedBuider(optTicks);
+            enqueueRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), callback,
+                enqueuedTicks);
+        } else if (request instanceof TransactionAbortRequest) {
+            ensureFlushedBuider(optTicks);
+            enqueueDoAbort(callback, enqueuedTicks);
+        } else if (request instanceof TransactionPurgeRequest) {
+            enqueuePurge(callback, enqueuedTicks);
+        } else if (request instanceof IncrementTransactionSequenceRequest) {
+            final IncrementTransactionSequenceRequest req = (IncrementTransactionSequenceRequest) request;
+            ensureFlushedBuider(optTicks);
+            enqueueRequest(new IncrementTransactionSequenceRequest(getIdentifier(), nextSequence(), localActor(),
+                snapshotOnly, req.getIncrement()), callback, enqueuedTicks);
+            incrementSequence(req.getIncrement());
+        } else {
+            throw new IllegalArgumentException("Unhandled request {}" + request);
+        }
+    }
 }