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 / LocalReadWriteProxyTransaction.java
index 720ada3191e7fd5d06892e0583dcabd55097ffa6..c44e70eb304f4458aeb2d9782b9f9581abcbfa81 100644 (file)
@@ -9,8 +9,11 @@ package org.opendaylight.controller.cluster.databroker.actors.dds;
 
 import com.google.common.base.Preconditions;
 import com.google.common.base.Verify;
+import java.util.Optional;
+import java.util.function.BiConsumer;
 import java.util.function.Consumer;
 import java.util.function.Supplier;
+import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import javax.annotation.concurrent.NotThreadSafe;
 import org.opendaylight.controller.cluster.access.commands.AbortLocalTransactionRequest;
@@ -82,10 +85,16 @@ final class LocalReadWriteProxyTransaction extends LocalProxyTransaction {
 
     LocalReadWriteProxyTransaction(final ProxyHistory parent, final TransactionIdentifier identifier,
         final DataTreeSnapshot snapshot) {
-        super(parent, identifier);
+        super(parent, identifier, false);
         this.modification = (CursorAwareDataTreeModification) snapshot.newModification();
     }
 
+    LocalReadWriteProxyTransaction(final ProxyHistory parent, final TransactionIdentifier identifier) {
+        super(parent, identifier, true);
+        // This is DONE transaction, this should never be touched
+        this.modification = null;
+    }
+
     @Override
     boolean isSnapshotOnly() {
         return false;
@@ -167,14 +176,25 @@ final class LocalReadWriteProxyTransaction extends LocalProxyTransaction {
         return ret;
     }
 
-    @Override
-    void doSeal() {
-        Preconditions.checkState(sealedModification == null, "Transaction %s is already sealed", getIdentifier());
+    private void sealModification() {
+        Preconditions.checkState(sealedModification == null, "Transaction %s is already sealed", this);
         final CursorAwareDataTreeModification mod = getModification();
         mod.ready();
         sealedModification = mod;
     }
 
+    @Override
+    void sealOnly() {
+        sealModification();
+        super.sealOnly();
+    }
+
+    @Override
+    boolean sealAndSend(final com.google.common.base.Optional<Long> enqueuedTicks) {
+        sealModification();
+        return super.sealAndSend(enqueuedTicks);
+    }
+
     @Override
     void flushState(final AbstractProxyTransaction successor) {
         sealedModification.applyToCursor(new AbstractDataTreeModificationCursor() {
@@ -201,8 +221,20 @@ final class LocalReadWriteProxyTransaction extends LocalProxyTransaction {
     }
 
     @Override
-    void applyModifyTransactionRequest(final ModifyTransactionRequest request,
+    void applyForwardedModifyTransactionRequest(final ModifyTransactionRequest request,
             final @Nullable Consumer<Response<?, ?>> callback) {
+        commonModifyTransactionRequest(request, callback, this::sendRequest);
+    }
+
+    @Override
+    void replayModifyTransactionRequest(final ModifyTransactionRequest request,
+            final @Nullable Consumer<Response<?, ?>> callback, final long enqueuedTicks) {
+        commonModifyTransactionRequest(request, callback, (req, cb) -> enqueueRequest(req, cb, enqueuedTicks));
+    }
+
+    private void commonModifyTransactionRequest(final ModifyTransactionRequest request,
+            final @Nullable Consumer<Response<?, ?>> callback,
+            final BiConsumer<TransactionRequest<?>, Consumer<Response<?, ?>>> sendMethod) {
         for (final TransactionModification mod : request.getModifications()) {
             if (mod instanceof TransactionWrite) {
                 write(mod.getPath(), ((TransactionWrite)mod).getData());
@@ -215,23 +247,25 @@ final class LocalReadWriteProxyTransaction extends LocalProxyTransaction {
             }
         }
 
-        final java.util.Optional<PersistenceProtocol> maybeProtocol = request.getPersistenceProtocol();
+        final Optional<PersistenceProtocol> maybeProtocol = request.getPersistenceProtocol();
         if (maybeProtocol.isPresent()) {
             Verify.verify(callback != null, "Request {} has null callback", request);
-            ensureSealed();
+            if (markSealed()) {
+                sealOnly();
+            }
 
             switch (maybeProtocol.get()) {
                 case ABORT:
-                    sendRequest(new AbortLocalTransactionRequest(getIdentifier(), localActor()), callback);
+                    sendMethod.accept(new AbortLocalTransactionRequest(getIdentifier(), localActor()), callback);
                     break;
                 case READY:
-                    // No-op, as we have already issued a seal()
+                    // No-op, as we have already issued a sealOnly() and we are not transmitting anything
                     break;
                 case SIMPLE:
-                    sendRequest(commitRequest(false), callback);
+                    sendMethod.accept(commitRequest(false), callback);
                     break;
                 case THREE_PHASE:
-                    sendRequest(commitRequest(true), callback);
+                    sendMethod.accept(commitRequest(true), callback);
                     break;
                 default:
                     throw new IllegalArgumentException("Unhandled protocol " + maybeProtocol.get());
@@ -240,18 +274,35 @@ final class LocalReadWriteProxyTransaction extends LocalProxyTransaction {
     }
 
     @Override
-    void handleForwardedLocalRequest(final AbstractLocalTransactionRequest<?> request,
-            final Consumer<Response<?, ?>> callback) {
+    void handleReplayedLocalRequest(final AbstractLocalTransactionRequest<?> request,
+            final Consumer<Response<?, ?>> callback, final long now) {
         if (request instanceof CommitLocalTransactionRequest) {
-            sendCommit((CommitLocalTransactionRequest) request, callback);
+            enqueueRequest(rebaseCommit((CommitLocalTransactionRequest)request), callback, now);
         } else {
-            super.handleForwardedLocalRequest(request, callback);
+            super.handleReplayedLocalRequest(request, callback, now);
         }
     }
 
     @Override
-    void handleForwardedRemoteRequest(final TransactionRequest<?> request,
-            final @Nullable Consumer<Response<?, ?>> callback) {
+    void handleReplayedRemoteRequest(final TransactionRequest<?> request,
+            final @Nullable Consumer<Response<?, ?>> callback, final long enqueuedTicks) {
+        LOG.debug("Applying replayed request {}", request);
+
+        if (request instanceof TransactionPreCommitRequest) {
+            enqueueRequest(new TransactionPreCommitRequest(getIdentifier(), nextSequence(), localActor()), callback,
+                enqueuedTicks);
+        } else if (request instanceof TransactionDoCommitRequest) {
+            enqueueRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), callback,
+                enqueuedTicks);
+        } else if (request instanceof TransactionAbortRequest) {
+            enqueueDoAbort(callback, enqueuedTicks);
+        } else {
+            super.handleReplayedRemoteRequest(request, callback, enqueuedTicks);
+        }
+    }
+
+    @Override
+    void handleForwardedRemoteRequest(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback) {
         LOG.debug("Applying forwarded request {}", request);
 
         if (request instanceof TransactionPreCommitRequest) {
@@ -259,7 +310,7 @@ final class LocalReadWriteProxyTransaction extends LocalProxyTransaction {
         } else if (request instanceof TransactionDoCommitRequest) {
             sendRequest(new TransactionDoCommitRequest(getIdentifier(), nextSequence(), localActor()), callback);
         } else if (request instanceof TransactionAbortRequest) {
-            sendAbort(callback);
+            sendDoAbort(callback);
         } else {
             super.handleForwardedRemoteRequest(request, callback);
         }
@@ -270,7 +321,7 @@ final class LocalReadWriteProxyTransaction extends LocalProxyTransaction {
             final Consumer<Response<?, ?>> callback) {
         if (request instanceof CommitLocalTransactionRequest) {
             Verify.verify(successor instanceof LocalReadWriteProxyTransaction);
-            ((LocalReadWriteProxyTransaction) successor).sendCommit((CommitLocalTransactionRequest)request, callback);
+            ((LocalReadWriteProxyTransaction) successor).sendRebased((CommitLocalTransactionRequest)request, callback);
             LOG.debug("Forwarded request {} to successor {}", request, successor);
         } else {
             super.forwardToLocal(successor, request, callback);
@@ -283,15 +334,26 @@ final class LocalReadWriteProxyTransaction extends LocalProxyTransaction {
         closedException = this::abortedException;
     }
 
-    private CursorAwareDataTreeModification getModification() {
+    @Override
+    void enqueueAbort(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback,
+            final long enqueuedTicks) {
+        super.enqueueAbort(request, callback, enqueuedTicks);
+        closedException = this::abortedException;
+    }
+
+    private @Nonnull CursorAwareDataTreeModification getModification() {
         if (closedException != null) {
             throw closedException.get();
         }
 
-        return modification;
+        return Preconditions.checkNotNull(modification, "Transaction %s is DONE", getIdentifier());
     }
 
-    private void sendCommit(final CommitLocalTransactionRequest request, final Consumer<Response<?, ?>> callback) {
+    private void sendRebased(final CommitLocalTransactionRequest request, final Consumer<Response<?, ?>> callback) {
+        sendRequest(rebaseCommit(request), callback);
+    }
+
+    private CommitLocalTransactionRequest rebaseCommit(final CommitLocalTransactionRequest request) {
         // Rebase old modification on new data tree.
         final CursorAwareDataTreeModification mod = getModification();
 
@@ -299,7 +361,10 @@ final class LocalReadWriteProxyTransaction extends LocalProxyTransaction {
             request.getModification().applyToCursor(cursor);
         }
 
-        ensureSealed();
-        sendRequest(commitRequest(request.isCoordinated()), callback);
+        if (markSealed()) {
+            sealOnly();
+        }
+
+        return commitRequest(request.isCoordinated());
     }
 }