opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardDataTree.java

   1 /*
   2  * Copyright (c) 2015 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.datastore;
   9
  10 import static akka.actor.ActorRef.noSender;
  11 import static com.google.common.base.Preconditions.checkState;
  12 import static com.google.common.base.Verify.verify;
  13 import static com.google.common.base.Verify.verifyNotNull;
  14 import static java.util.Objects.requireNonNull;
  15 import static java.util.Objects.requireNonNullElse;
  16
  17 import akka.actor.ActorRef;
  18 import akka.util.Timeout;
  19 import com.google.common.annotations.VisibleForTesting;
  20 import com.google.common.base.Stopwatch;
  21 import com.google.common.collect.ImmutableList;
  22 import com.google.common.collect.ImmutableMap;
  23 import com.google.common.collect.ImmutableMap.Builder;
  24 import com.google.common.collect.Iterables;
  25 import com.google.common.primitives.UnsignedLong;
  26 import com.google.common.util.concurrent.FutureCallback;
  27 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  28 import java.io.File;
  29 import java.io.IOException;
  30 import java.util.ArrayDeque;
  31 import java.util.ArrayList;
  32 import java.util.Collection;
  33 import java.util.Collections;
  34 import java.util.Deque;
  35 import java.util.HashMap;
  36 import java.util.Iterator;
  37 import java.util.Map;
  38 import java.util.Optional;
  39 import java.util.OptionalLong;
  40 import java.util.Queue;
  41 import java.util.SortedSet;
  42 import java.util.concurrent.TimeUnit;
  43 import java.util.concurrent.TimeoutException;
  44 import java.util.function.Consumer;
  45 import java.util.function.Function;
  46 import java.util.function.UnaryOperator;
  47 import org.eclipse.jdt.annotation.NonNull;
  48 import org.eclipse.jdt.annotation.Nullable;
  49 import org.opendaylight.controller.cluster.access.concepts.LocalHistoryIdentifier;
  50 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  51 import org.opendaylight.controller.cluster.datastore.DataTreeCohortActorRegistry.CohortRegistryCommand;
  52 import org.opendaylight.controller.cluster.datastore.ShardDataTreeCohort.State;
  53 import org.opendaylight.controller.cluster.datastore.node.utils.transformer.ReusableNormalizedNodePruner;
  54 import org.opendaylight.controller.cluster.datastore.persisted.AbortTransactionPayload;
  55 import org.opendaylight.controller.cluster.datastore.persisted.AbstractIdentifiablePayload;
  56 import org.opendaylight.controller.cluster.datastore.persisted.CloseLocalHistoryPayload;
  57 import org.opendaylight.controller.cluster.datastore.persisted.CommitTransactionPayload;
  58 import org.opendaylight.controller.cluster.datastore.persisted.CreateLocalHistoryPayload;
  59 import org.opendaylight.controller.cluster.datastore.persisted.MetadataShardDataTreeSnapshot;
  60 import org.opendaylight.controller.cluster.datastore.persisted.PayloadVersion;
  61 import org.opendaylight.controller.cluster.datastore.persisted.PurgeLocalHistoryPayload;
  62 import org.opendaylight.controller.cluster.datastore.persisted.PurgeTransactionPayload;
  63 import org.opendaylight.controller.cluster.datastore.persisted.ShardDataTreeSnapshot;
  64 import org.opendaylight.controller.cluster.datastore.persisted.ShardDataTreeSnapshotMetadata;
  65 import org.opendaylight.controller.cluster.datastore.persisted.ShardSnapshotState;
  66 import org.opendaylight.controller.cluster.datastore.persisted.SkipTransactionsPayload;
  67 import org.opendaylight.controller.cluster.datastore.utils.DataTreeModificationOutput;
  68 import org.opendaylight.controller.cluster.datastore.utils.ImmutableUnsignedLongSet;
  69 import org.opendaylight.controller.cluster.datastore.utils.PruningDataTreeModification;
  70 import org.opendaylight.controller.cluster.raft.base.messages.InitiateCaptureSnapshot;
  71 import org.opendaylight.controller.cluster.raft.messages.Payload;
  72 import org.opendaylight.mdsal.common.api.OptimisticLockFailedException;
  73 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
  74 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeListener;
  75 import org.opendaylight.yangtools.concepts.Identifier;
  76 import org.opendaylight.yangtools.concepts.Registration;
  77 import org.opendaylight.yangtools.yang.common.Empty;
  78 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  79 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  80 import org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeStreamVersion;
  81 import org.opendaylight.yangtools.yang.data.tree.api.ConflictingModificationAppliedException;
  82 import org.opendaylight.yangtools.yang.data.tree.api.DataTree;
  83 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidate;
  84 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeCandidateTip;
  85 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeConfiguration;
  86 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeModification;
  87 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeSnapshot;
  88 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeTip;
  89 import org.opendaylight.yangtools.yang.data.tree.api.DataValidationFailedException;
  90 import org.opendaylight.yangtools.yang.data.tree.api.ModificationType;
  91 import org.opendaylight.yangtools.yang.data.tree.api.TreeType;
  92 import org.opendaylight.yangtools.yang.data.tree.impl.di.InMemoryDataTreeFactory;
  93 import org.opendaylight.yangtools.yang.data.tree.spi.DataTreeCandidates;
  94 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
  95 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  96 import org.slf4j.Logger;
  97 import org.slf4j.LoggerFactory;
  98 import scala.concurrent.duration.FiniteDuration;
  99
 100 /**
 101  * Internal shard state, similar to a DOMStore, but optimized for use in the actor system, e.g. it does not expose
 102  * public interfaces and assumes it is only ever called from a single thread.
 103  *
 104  * <p>
 105  * This class is not part of the API contract and is subject to change at any time. It is NOT thread-safe.
 106  */
 107 @VisibleForTesting
 108 // non-final for mocking
 109 public class ShardDataTree extends ShardDataTreeTransactionParent {
 110     private static final class CommitEntry {
 111         final SimpleShardDataTreeCohort cohort;
 112         long lastAccess;
 113
 114         CommitEntry(final SimpleShardDataTreeCohort cohort, final long now) {
 115             this.cohort = requireNonNull(cohort);
 116             lastAccess = now;
 117         }
 118
 119         @Override
 120         public String toString() {
 121             return "CommitEntry [tx=" + cohort.transactionId() + ", state=" + cohort.getState() + "]";
 122         }
 123     }
 124
 125     private static final Timeout COMMIT_STEP_TIMEOUT = new Timeout(FiniteDuration.create(5, TimeUnit.SECONDS));
 126     private static final Logger LOG = LoggerFactory.getLogger(ShardDataTree.class);
 127
 128     /**
 129      * Process this many transactions in a single batched run. If we exceed this limit, we need to schedule later
 130      * execution to finish up the batch. This is necessary in case of a long list of transactions which progress
 131      * immediately through their preCommit phase -- if that happens, their completion eats up stack frames and could
 132      * result in StackOverflowError.
 133      */
 134     private static final int MAX_TRANSACTION_BATCH = 100;
 135
 136     private final Map<LocalHistoryIdentifier, ShardDataTreeTransactionChain> transactionChains = new HashMap<>();
 137     private final DataTreeCohortActorRegistry cohortRegistry = new DataTreeCohortActorRegistry();
 138     private final Deque<CommitEntry> pendingTransactions = new ArrayDeque<>();
 139     private final Queue<CommitEntry> pendingCommits = new ArrayDeque<>();
 140     private final Queue<CommitEntry> pendingFinishCommits = new ArrayDeque<>();
 141
 142     /**
 143      * Callbacks that need to be invoked once a payload is replicated.
 144      */
 145     private final Map<Payload, Runnable> replicationCallbacks = new HashMap<>();
 146
 147     private final ShardDataTreeChangeListenerPublisher treeChangeListenerPublisher;
 148     private final Collection<ShardDataTreeMetadata<?>> metadata;
 149     private final DataTree dataTree;
 150     private final String logContext;
 151     private final Shard shard;
 152     private Runnable runOnPendingTransactionsComplete;
 153
 154     /**
 155      * Optimistic {@link DataTreeCandidate} preparation. Since our DataTree implementation is a
 156      * {@link DataTree}, each {@link DataTreeCandidate} is also a {@link DataTreeTip}, e.g. another
 157      * candidate can be prepared on top of it. They still need to be committed in sequence. Here we track the current
 158      * tip of the data tree, which is the last DataTreeCandidate we have in flight, or the DataTree itself.
 159      */
 160     private DataTreeTip tip;
 161
 162     private EffectiveModelContext schemaContext;
 163     private DataSchemaContextTree dataSchemaContext;
 164
 165     private int currentTransactionBatch;
 166
 167     ShardDataTree(final Shard shard, final EffectiveModelContext schemaContext, final DataTree dataTree,
 168             final ShardDataTreeChangeListenerPublisher treeChangeListenerPublisher,
 169             final String logContext,
 170             final ShardDataTreeMetadata<?>... metadata) {
 171         this.dataTree = requireNonNull(dataTree);
 172         updateSchemaContext(schemaContext);
 173
 174         this.shard = requireNonNull(shard);
 175         this.treeChangeListenerPublisher = requireNonNull(treeChangeListenerPublisher);
 176         this.logContext = requireNonNull(logContext);
 177         this.metadata = ImmutableList.copyOf(metadata);
 178         tip = dataTree;
 179     }
 180
 181     ShardDataTree(final Shard shard, final EffectiveModelContext schemaContext, final TreeType treeType,
 182             final YangInstanceIdentifier root,
 183             final ShardDataTreeChangeListenerPublisher treeChangeListenerPublisher,
 184             final String logContext,
 185             final ShardDataTreeMetadata<?>... metadata) {
 186         this(shard, schemaContext, createDataTree(treeType, root), treeChangeListenerPublisher, logContext, metadata);
 187     }
 188
 189     private static DataTree createDataTree(final TreeType treeType, final YangInstanceIdentifier root) {
 190         final DataTreeConfiguration baseConfig = DataTreeConfiguration.getDefault(treeType);
 191         return new InMemoryDataTreeFactory().create(new DataTreeConfiguration.Builder(baseConfig.getTreeType())
 192                 .setMandatoryNodesValidation(baseConfig.isMandatoryNodesValidationEnabled())
 193                 .setUniqueIndexes(baseConfig.isUniqueIndexEnabled())
 194                 .setRootPath(root)
 195                 .build());
 196     }
 197
 198     @VisibleForTesting
 199     public ShardDataTree(final Shard shard, final EffectiveModelContext schemaContext, final TreeType treeType) {
 200         this(shard, schemaContext, treeType, YangInstanceIdentifier.of(),
 201                 new DefaultShardDataTreeChangeListenerPublisher(""), "");
 202     }
 203
 204     final String logContext() {
 205         return logContext;
 206     }
 207
 208     final long readTime() {
 209         return shard.ticker().read();
 210     }
 211
 212     final DataTree getDataTree() {
 213         return dataTree;
 214     }
 215
 216     @VisibleForTesting
 217     final EffectiveModelContext getSchemaContext() {
 218         return schemaContext;
 219     }
 220
 221     final void updateSchemaContext(final @NonNull EffectiveModelContext newSchemaContext) {
 222         dataTree.setEffectiveModelContext(newSchemaContext);
 223         schemaContext = newSchemaContext;
 224         dataSchemaContext = DataSchemaContextTree.from(newSchemaContext);
 225     }
 226
 227     final void resetTransactionBatch() {
 228         currentTransactionBatch = 0;
 229     }
 230
 231     /**
 232      * Take a snapshot of current state for later recovery.
 233      *
 234      * @return A state snapshot
 235      */
 236     @NonNull ShardDataTreeSnapshot takeStateSnapshot() {
 237         final NormalizedNode rootNode = takeSnapshot().readNode(YangInstanceIdentifier.of()).orElseThrow();
 238         final Builder<Class<? extends ShardDataTreeSnapshotMetadata<?>>, ShardDataTreeSnapshotMetadata<?>> metaBuilder =
 239                 ImmutableMap.builder();
 240
 241         for (ShardDataTreeMetadata<?> m : metadata) {
 242             final ShardDataTreeSnapshotMetadata<?> meta = m.toSnapshot();
 243             if (meta != null) {
 244                 metaBuilder.put(meta.getType(), meta);
 245             }
 246         }
 247
 248         return new MetadataShardDataTreeSnapshot(rootNode, metaBuilder.build());
 249     }
 250
 251     private boolean anyPendingTransactions() {
 252         return !pendingTransactions.isEmpty() || !pendingCommits.isEmpty() || !pendingFinishCommits.isEmpty();
 253     }
 254
 255     private void applySnapshot(final @NonNull ShardDataTreeSnapshot snapshot,
 256             final UnaryOperator<DataTreeModification> wrapper) throws DataValidationFailedException {
 257         final Stopwatch elapsed = Stopwatch.createStarted();
 258
 259         if (anyPendingTransactions()) {
 260             LOG.warn("{}: applying state snapshot with pending transactions", logContext);
 261         }
 262
 263         final Map<Class<? extends ShardDataTreeSnapshotMetadata<?>>, ShardDataTreeSnapshotMetadata<?>> snapshotMeta;
 264         if (snapshot instanceof MetadataShardDataTreeSnapshot metaSnapshot) {
 265             snapshotMeta = metaSnapshot.getMetadata();
 266         } else {
 267             snapshotMeta = ImmutableMap.of();
 268         }
 269
 270         for (var m : metadata) {
 271             final var s = snapshotMeta.get(m.getSupportedType());
 272             if (s != null) {
 273                 m.applySnapshot(s);
 274             } else {
 275                 m.reset();
 276             }
 277         }
 278
 279         final DataTreeModification unwrapped = newModification();
 280         final DataTreeModification mod = wrapper.apply(unwrapped);
 281         // delete everything first
 282         mod.delete(YangInstanceIdentifier.of());
 283
 284         snapshot.getRootNode().ifPresent(rootNode -> {
 285             // Add everything from the remote node back
 286             mod.write(YangInstanceIdentifier.of(), rootNode);
 287         });
 288
 289         mod.ready();
 290
 291         dataTree.validate(unwrapped);
 292         DataTreeCandidateTip candidate = dataTree.prepare(unwrapped);
 293         dataTree.commit(candidate);
 294         notifyListeners(candidate);
 295
 296         LOG.debug("{}: state snapshot applied in {}", logContext, elapsed);
 297     }
 298
 299     /**
 300      * Apply a snapshot coming from the leader. This method assumes the leader and follower SchemaContexts match and
 301      * does not perform any pruning.
 302      *
 303      * @param snapshot Snapshot that needs to be applied
 304      * @throws DataValidationFailedException when the snapshot fails to apply
 305      */
 306     final void applySnapshot(final @NonNull ShardDataTreeSnapshot snapshot) throws DataValidationFailedException {
 307         // TODO: we should be taking ShardSnapshotState here and performing forward-compatibility translation
 308         applySnapshot(snapshot, UnaryOperator.identity());
 309     }
 310
 311     /**
 312      * Apply a snapshot coming from recovery. This method does not assume the SchemaContexts match and performs data
 313      * pruning in an attempt to adjust the state to our current SchemaContext.
 314      *
 315      * @param snapshot Snapshot that needs to be applied
 316      * @throws DataValidationFailedException when the snapshot fails to apply
 317      */
 318     final void applyRecoverySnapshot(final @NonNull ShardSnapshotState snapshot) throws DataValidationFailedException {
 319         // TODO: we should be able to reuse the pruner, provided we are not reentrant
 320         final ReusableNormalizedNodePruner pruner = ReusableNormalizedNodePruner.forDataSchemaContext(
 321             dataSchemaContext);
 322         if (snapshot.needsMigration()) {
 323             final ReusableNormalizedNodePruner uintPruner = pruner.withUintAdaption();
 324             applySnapshot(snapshot.getSnapshot(),
 325                 delegate -> new PruningDataTreeModification.Proactive(delegate, dataTree, uintPruner));
 326         } else {
 327             applySnapshot(snapshot.getSnapshot(),
 328                 delegate -> new PruningDataTreeModification.Reactive(delegate, dataTree, pruner));
 329         }
 330     }
 331
 332     @SuppressWarnings("checkstyle:IllegalCatch")
 333     private void applyRecoveryCandidate(final CommitTransactionPayload payload) throws IOException {
 334         final var entry = payload.acquireCandidate();
 335         final var unwrapped = newModification();
 336         final var pruningMod = createPruningModification(unwrapped,
 337             NormalizedNodeStreamVersion.MAGNESIUM.compareTo(entry.streamVersion()) > 0);
 338
 339         DataTreeCandidates.applyToModification(pruningMod, entry.candidate());
 340         pruningMod.ready();
 341         LOG.trace("{}: Applying recovery modification {}", logContext, unwrapped);
 342
 343         try {
 344             dataTree.validate(unwrapped);
 345             dataTree.commit(dataTree.prepare(unwrapped));
 346         } catch (Exception e) {
 347             final var file = new File(System.getProperty("karaf.data", "."),
 348                     "failed-recovery-payload-" + logContext + ".out");
 349             DataTreeModificationOutput.toFile(file, unwrapped);
 350             throw new IllegalStateException(
 351                 "%s: Failed to apply recovery payload. Modification data was written to file %s".formatted(
 352                     logContext, file),
 353                 e);
 354         }
 355
 356         allMetadataCommittedTransaction(entry.transactionId());
 357     }
 358
 359     private PruningDataTreeModification createPruningModification(final DataTreeModification unwrapped,
 360             final boolean uintAdapting) {
 361         // TODO: we should be able to reuse the pruner, provided we are not reentrant
 362         final var pruner = ReusableNormalizedNodePruner.forDataSchemaContext(dataSchemaContext);
 363         return uintAdapting ? new PruningDataTreeModification.Proactive(unwrapped, dataTree, pruner.withUintAdaption())
 364                 : new PruningDataTreeModification.Reactive(unwrapped, dataTree, pruner);
 365     }
 366
 367     /**
 368      * Apply a payload coming from recovery. This method does not assume the SchemaContexts match and performs data
 369      * pruning in an attempt to adjust the state to our current SchemaContext.
 370      *
 371      * @param payload Payload
 372      * @throws IOException when the snapshot fails to deserialize
 373      * @throws DataValidationFailedException when the snapshot fails to apply
 374      */
 375     final void applyRecoveryPayload(final @NonNull Payload payload) throws IOException {
 376         if (payload instanceof CommitTransactionPayload commit) {
 377             applyRecoveryCandidate(commit);
 378         } else if (payload instanceof AbortTransactionPayload abort) {
 379             allMetadataAbortedTransaction(abort.getIdentifier());
 380         } else if (payload instanceof PurgeTransactionPayload purge) {
 381             allMetadataPurgedTransaction(purge.getIdentifier());
 382         } else if (payload instanceof CreateLocalHistoryPayload create) {
 383             allMetadataCreatedLocalHistory(create.getIdentifier());
 384         } else if (payload instanceof CloseLocalHistoryPayload close) {
 385             allMetadataClosedLocalHistory(close.getIdentifier());
 386         } else if (payload instanceof PurgeLocalHistoryPayload purge) {
 387             allMetadataPurgedLocalHistory(purge.getIdentifier());
 388         } else if (payload instanceof SkipTransactionsPayload skip) {
 389             allMetadataSkipTransactions(skip);
 390         } else {
 391             LOG.debug("{}: ignoring unhandled payload {}", logContext, payload);
 392         }
 393     }
 394
 395     private void applyReplicatedCandidate(final CommitTransactionPayload payload)
 396             throws DataValidationFailedException, IOException {
 397         final var payloadCandidate = payload.acquireCandidate();
 398         final var transactionId = payloadCandidate.transactionId();
 399         LOG.debug("{}: Applying foreign transaction {}", logContext, transactionId);
 400
 401         final var mod = newModification();
 402         // TODO: check version here, which will enable us to perform forward-compatibility transformations
 403         DataTreeCandidates.applyToModification(mod, payloadCandidate.candidate());
 404         mod.ready();
 405
 406         LOG.trace("{}: Applying foreign modification {}", logContext, mod);
 407         dataTree.validate(mod);
 408         final var candidate = dataTree.prepare(mod);
 409         dataTree.commit(candidate);
 410
 411         allMetadataCommittedTransaction(transactionId);
 412         notifyListeners(candidate);
 413     }
 414
 415     /**
 416      * Apply a payload coming from the leader, which could actually be us. This method assumes the leader and follower
 417      * SchemaContexts match and does not perform any pruning.
 418      *
 419      * @param identifier Payload identifier as returned from RaftActor
 420      * @param payload Payload
 421      * @throws IOException when the snapshot fails to deserialize
 422      * @throws DataValidationFailedException when the snapshot fails to apply
 423      */
 424     final void applyReplicatedPayload(final Identifier identifier, final Payload payload) throws IOException,
 425             DataValidationFailedException {
 426         /*
 427          * This is a bit more involved than it needs to be due to to the fact we do not want to be touching the payload
 428          * if we are the leader and it has originated with us.
 429          *
 430          * The identifier will only ever be non-null when we were the leader which achieved consensus. Unfortunately,
 431          * though, this may not be the case anymore, as we are being called some time afterwards and we may not be
 432          * acting in that capacity anymore.
 433          *
 434          * In any case, we know that this is an entry coming from replication, hence we can be sure we will not observe
 435          * pre-Boron state -- which limits the number of options here.
 436          */
 437         if (payload instanceof CommitTransactionPayload commit) {
 438             if (identifier == null) {
 439                 applyReplicatedCandidate(commit);
 440             } else {
 441                 verify(identifier instanceof TransactionIdentifier);
 442                 // if we did not track this transaction before, it means that it came from another leader and we are in
 443                 // the process of commiting it while in PreLeader state. That means that it hasnt yet been committed to
 444                 // the local DataTree and would be lost if it was only applied via payloadReplicationComplete().
 445                 if (!payloadReplicationComplete((TransactionIdentifier) identifier)) {
 446                     applyReplicatedCandidate(commit);
 447                 }
 448             }
 449
 450             // make sure acquireCandidate() is the last call touching the payload data as we want it to be GC-ed.
 451             checkRootOverwrite(commit.acquireCandidate().candidate());
 452         } else if (payload instanceof AbortTransactionPayload abort) {
 453             if (identifier != null) {
 454                 payloadReplicationComplete(abort);
 455             }
 456             allMetadataAbortedTransaction(abort.getIdentifier());
 457         } else if (payload instanceof PurgeTransactionPayload purge) {
 458             if (identifier != null) {
 459                 payloadReplicationComplete(purge);
 460             }
 461             allMetadataPurgedTransaction(purge.getIdentifier());
 462         } else if (payload instanceof CloseLocalHistoryPayload close) {
 463             if (identifier != null) {
 464                 payloadReplicationComplete(close);
 465             }
 466             allMetadataClosedLocalHistory(close.getIdentifier());
 467         } else if (payload instanceof CreateLocalHistoryPayload create) {
 468             if (identifier != null) {
 469                 payloadReplicationComplete(create);
 470             }
 471             allMetadataCreatedLocalHistory(create.getIdentifier());
 472         } else if (payload instanceof PurgeLocalHistoryPayload purge) {
 473             if (identifier != null) {
 474                 payloadReplicationComplete(purge);
 475             }
 476             allMetadataPurgedLocalHistory(purge.getIdentifier());
 477         } else if (payload instanceof SkipTransactionsPayload skip) {
 478             if (identifier != null) {
 479                 payloadReplicationComplete(skip);
 480             }
 481             allMetadataSkipTransactions(skip);
 482         } else {
 483             LOG.warn("{}: ignoring unhandled identifier {} payload {}", logContext, identifier, payload);
 484         }
 485     }
 486
 487     private void checkRootOverwrite(final DataTreeCandidate candidate) {
 488         final DatastoreContext datastoreContext = shard.getDatastoreContext();
 489         if (!datastoreContext.isSnapshotOnRootOverwrite()) {
 490             return;
 491         }
 492
 493         if (!datastoreContext.isPersistent()) {
 494             // FIXME: why don't we want a snapshot in non-persistent state?
 495             return;
 496         }
 497
 498         // top level container ie "/"
 499         if (candidate.getRootPath().isEmpty() && candidate.getRootNode().modificationType() == ModificationType.WRITE) {
 500             LOG.debug("{}: shard root overwritten, enqueuing snapshot", logContext);
 501             shard.self().tell(new InitiateCaptureSnapshot(), noSender());
 502         }
 503     }
 504
 505     private void replicatePayload(final Identifier id, final Payload payload, final @Nullable Runnable callback) {
 506         if (callback != null) {
 507             replicationCallbacks.put(payload, callback);
 508         }
 509         shard.persistPayload(id, payload, true);
 510     }
 511
 512     private void payloadReplicationComplete(final AbstractIdentifiablePayload<?> payload) {
 513         final Runnable callback = replicationCallbacks.remove(payload);
 514         if (callback != null) {
 515             LOG.debug("{}: replication of {} completed, invoking {}", logContext, payload.getIdentifier(), callback);
 516             callback.run();
 517         } else {
 518             LOG.debug("{}: replication of {} has no callback", logContext, payload.getIdentifier());
 519         }
 520     }
 521
 522     private boolean payloadReplicationComplete(final TransactionIdentifier txId) {
 523         final var current = pendingFinishCommits.peek();
 524         if (current == null) {
 525             LOG.warn("{}: No outstanding transactions, ignoring consensus on transaction {}", logContext, txId);
 526             allMetadataCommittedTransaction(txId);
 527             return false;
 528         }
 529
 530         final var cohortTxId = current.cohort.transactionId();
 531         if (!cohortTxId.equals(txId)) {
 532             LOG.debug("{}: Head of pendingFinishCommits queue is {}, ignoring consensus on transaction {}", logContext,
 533                 cohortTxId, txId);
 534             allMetadataCommittedTransaction(txId);
 535             return false;
 536         }
 537
 538         finishCommit(current.cohort);
 539         return true;
 540     }
 541
 542     private void allMetadataAbortedTransaction(final TransactionIdentifier txId) {
 543         for (ShardDataTreeMetadata<?> m : metadata) {
 544             m.onTransactionAborted(txId);
 545         }
 546     }
 547
 548     private void allMetadataCommittedTransaction(final TransactionIdentifier txId) {
 549         for (ShardDataTreeMetadata<?> m : metadata) {
 550             m.onTransactionCommitted(txId);
 551         }
 552     }
 553
 554     private void allMetadataPurgedTransaction(final TransactionIdentifier txId) {
 555         for (ShardDataTreeMetadata<?> m : metadata) {
 556             m.onTransactionPurged(txId);
 557         }
 558     }
 559
 560     private void allMetadataCreatedLocalHistory(final LocalHistoryIdentifier historyId) {
 561         for (ShardDataTreeMetadata<?> m : metadata) {
 562             m.onHistoryCreated(historyId);
 563         }
 564     }
 565
 566     private void allMetadataClosedLocalHistory(final LocalHistoryIdentifier historyId) {
 567         for (ShardDataTreeMetadata<?> m : metadata) {
 568             m.onHistoryClosed(historyId);
 569         }
 570     }
 571
 572     private void allMetadataPurgedLocalHistory(final LocalHistoryIdentifier historyId) {
 573         for (ShardDataTreeMetadata<?> m : metadata) {
 574             m.onHistoryPurged(historyId);
 575         }
 576     }
 577
 578     private void allMetadataSkipTransactions(final SkipTransactionsPayload payload) {
 579         final var historyId = payload.getIdentifier();
 580         final var txIds = payload.getTransactionIds();
 581         for (ShardDataTreeMetadata<?> m : metadata) {
 582             m.onTransactionsSkipped(historyId, txIds);
 583         }
 584     }
 585
 586     /**
 587      * Create a transaction chain for specified history. Unlike {@link #ensureTransactionChain(LocalHistoryIdentifier)},
 588      * this method is used for re-establishing state when we are taking over
 589      *
 590      * @param historyId Local history identifier
 591      * @param closed True if the chain should be created in closed state (i.e. pending purge)
 592      * @return Transaction chain handle
 593      */
 594     final ShardDataTreeTransactionChain recreateTransactionChain(final LocalHistoryIdentifier historyId,
 595             final boolean closed) {
 596         final ShardDataTreeTransactionChain ret = new ShardDataTreeTransactionChain(historyId, this);
 597         final ShardDataTreeTransactionChain existing = transactionChains.putIfAbsent(historyId, ret);
 598         checkState(existing == null, "Attempted to recreate chain %s, but %s already exists", historyId, existing);
 599         return ret;
 600     }
 601
 602     final ShardDataTreeTransactionChain ensureTransactionChain(final LocalHistoryIdentifier historyId,
 603             final @Nullable Runnable callback) {
 604         ShardDataTreeTransactionChain chain = transactionChains.get(historyId);
 605         if (chain == null) {
 606             chain = new ShardDataTreeTransactionChain(historyId, this);
 607             transactionChains.put(historyId, chain);
 608             replicatePayload(historyId, CreateLocalHistoryPayload.create(
 609                     historyId, shard.getDatastoreContext().getInitialPayloadSerializedBufferCapacity()), callback);
 610         } else if (callback != null) {
 611             callback.run();
 612         }
 613
 614         return chain;
 615     }
 616
 617     final @NonNull ReadOnlyShardDataTreeTransaction newReadOnlyTransaction(final TransactionIdentifier txId) {
 618         shard.getShardMBean().incrementReadOnlyTransactionCount();
 619
 620         final var historyId = txId.getHistoryId();
 621         return historyId.getHistoryId() == 0 ? newStandaloneReadOnlyTransaction(txId)
 622             : ensureTransactionChain(historyId, null).newReadOnlyTransaction(txId);
 623     }
 624
 625     final @NonNull ReadOnlyShardDataTreeTransaction newStandaloneReadOnlyTransaction(final TransactionIdentifier txId) {
 626         return new ReadOnlyShardDataTreeTransaction(this, txId, takeSnapshot());
 627     }
 628
 629     final @NonNull ReadWriteShardDataTreeTransaction newReadWriteTransaction(final TransactionIdentifier txId) {
 630         shard.getShardMBean().incrementReadWriteTransactionCount();
 631
 632         final var historyId = txId.getHistoryId();
 633         return historyId.getHistoryId() == 0 ? newStandaloneReadWriteTransaction(txId)
 634             : ensureTransactionChain(historyId, null).newReadWriteTransaction(txId);
 635     }
 636
 637     final @NonNull ReadWriteShardDataTreeTransaction newStandaloneReadWriteTransaction(
 638             final TransactionIdentifier txId) {
 639         return new ReadWriteShardDataTreeTransaction(this, txId, newModification());
 640     }
 641
 642     @VisibleForTesting
 643     final void notifyListeners(final DataTreeCandidate candidate) {
 644         treeChangeListenerPublisher.publishChanges(candidate);
 645     }
 646
 647     /**
 648      * Immediately purge all state relevant to leader. This includes all transaction chains and any scheduled
 649      * replication callbacks.
 650      */
 651     final void purgeLeaderState() {
 652         for (ShardDataTreeTransactionChain chain : transactionChains.values()) {
 653             chain.close();
 654         }
 655
 656         transactionChains.clear();
 657         replicationCallbacks.clear();
 658     }
 659
 660     /**
 661      * Close a single transaction chain.
 662      *
 663      * @param id History identifier
 664      * @param callback Callback to invoke upon completion, may be null
 665      */
 666     final void closeTransactionChain(final LocalHistoryIdentifier id, final @Nullable Runnable callback) {
 667         if (commonCloseTransactionChain(id, callback)) {
 668             replicatePayload(id, CloseLocalHistoryPayload.create(id,
 669                 shard.getDatastoreContext().getInitialPayloadSerializedBufferCapacity()), callback);
 670         }
 671     }
 672
 673     /**
 674      * Close a single transaction chain which is received through ask-based protocol. It does not keep a commit record.
 675      *
 676      * @param id History identifier
 677      */
 678     final void closeTransactionChain(final LocalHistoryIdentifier id) {
 679         commonCloseTransactionChain(id, null);
 680     }
 681
 682     private boolean commonCloseTransactionChain(final LocalHistoryIdentifier id, final @Nullable Runnable callback) {
 683         final ShardDataTreeTransactionChain chain = transactionChains.get(id);
 684         if (chain == null) {
 685             LOG.debug("{}: Closing non-existent transaction chain {}", logContext, id);
 686             if (callback != null) {
 687                 callback.run();
 688             }
 689             return false;
 690         }
 691
 692         chain.close();
 693         return true;
 694     }
 695
 696     /**
 697      * Purge a single transaction chain.
 698      *
 699      * @param id History identifier
 700      * @param callback Callback to invoke upon completion, may be null
 701      */
 702     final void purgeTransactionChain(final LocalHistoryIdentifier id, final @Nullable Runnable callback) {
 703         final ShardDataTreeTransactionChain chain = transactionChains.remove(id);
 704         if (chain == null) {
 705             LOG.debug("{}: Purging non-existent transaction chain {}", logContext, id);
 706             if (callback != null) {
 707                 callback.run();
 708             }
 709             return;
 710         }
 711
 712         replicatePayload(id, PurgeLocalHistoryPayload.create(
 713                 id, shard.getDatastoreContext().getInitialPayloadSerializedBufferCapacity()), callback);
 714     }
 715
 716     final void skipTransactions(final LocalHistoryIdentifier id, final ImmutableUnsignedLongSet transactionIds,
 717             final Runnable callback) {
 718         final ShardDataTreeTransactionChain chain = transactionChains.get(id);
 719         if (chain == null) {
 720             LOG.debug("{}: Skipping on non-existent transaction chain {}", logContext, id);
 721             if (callback != null) {
 722                 callback.run();
 723             }
 724             return;
 725         }
 726
 727         replicatePayload(id, SkipTransactionsPayload.create(id, transactionIds,
 728             shard.getDatastoreContext().getInitialPayloadSerializedBufferCapacity()), callback);
 729     }
 730
 731     final Optional<DataTreeCandidate> readCurrentData() {
 732         return readNode(YangInstanceIdentifier.of())
 733             .map(state -> DataTreeCandidates.fromNormalizedNode(YangInstanceIdentifier.of(), state));
 734     }
 735
 736     final void registerTreeChangeListener(final YangInstanceIdentifier path, final DOMDataTreeChangeListener listener,
 737             final Optional<DataTreeCandidate> initialState, final Consumer<Registration> onRegistration) {
 738         treeChangeListenerPublisher.registerTreeChangeListener(path, listener, initialState, onRegistration);
 739     }
 740
 741     final int getQueueSize() {
 742         return pendingTransactions.size() + pendingCommits.size() + pendingFinishCommits.size();
 743     }
 744
 745     @Override
 746     final void abortTransaction(final AbstractShardDataTreeTransaction<?> transaction, final Runnable callback) {
 747         final TransactionIdentifier id = transaction.getIdentifier();
 748         LOG.debug("{}: aborting transaction {}", logContext, id);
 749         replicatePayload(id, AbortTransactionPayload.create(
 750                 id, shard.getDatastoreContext().getInitialPayloadSerializedBufferCapacity()), callback);
 751     }
 752
 753     @Override
 754     final void abortFromTransactionActor(final AbstractShardDataTreeTransaction<?> transaction) {
 755         // No-op for free-standing transactions
 756     }
 757
 758     @Override
 759     final ShardDataTreeCohort finishTransaction(final ReadWriteShardDataTreeTransaction transaction,
 760             final Optional<SortedSet<String>> participatingShardNames) {
 761         final DataTreeModification snapshot = transaction.getSnapshot();
 762         final TransactionIdentifier id = transaction.getIdentifier();
 763         LOG.debug("{}: readying transaction {}", logContext, id);
 764         snapshot.ready();
 765         LOG.debug("{}: transaction {} ready", logContext, id);
 766
 767         return createReadyCohort(transaction.getIdentifier(), snapshot, participatingShardNames);
 768     }
 769
 770     final void purgeTransaction(final TransactionIdentifier id, final Runnable callback) {
 771         LOG.debug("{}: purging transaction {}", logContext, id);
 772         replicatePayload(id, PurgeTransactionPayload.create(
 773                 id, shard.getDatastoreContext().getInitialPayloadSerializedBufferCapacity()), callback);
 774     }
 775
 776     @VisibleForTesting
 777     public final Optional<NormalizedNode> readNode(final YangInstanceIdentifier path) {
 778         return takeSnapshot().readNode(path);
 779     }
 780
 781     final DataTreeSnapshot takeSnapshot() {
 782         return dataTree.takeSnapshot();
 783     }
 784
 785     @VisibleForTesting
 786     final DataTreeModification newModification() {
 787         return takeSnapshot().newModification();
 788     }
 789
 790     final Collection<ShardDataTreeCohort> getAndClearPendingTransactions() {
 791         Collection<ShardDataTreeCohort> ret = new ArrayList<>(getQueueSize());
 792
 793         for (CommitEntry entry: pendingFinishCommits) {
 794             ret.add(entry.cohort);
 795         }
 796
 797         for (CommitEntry entry: pendingCommits) {
 798             ret.add(entry.cohort);
 799         }
 800
 801         for (CommitEntry entry: pendingTransactions) {
 802             ret.add(entry.cohort);
 803         }
 804
 805         pendingFinishCommits.clear();
 806         pendingCommits.clear();
 807         pendingTransactions.clear();
 808         tip = dataTree;
 809         return ret;
 810     }
 811
 812     /**
 813      * Called some time after {@link #processNextPendingTransaction()} decides to stop processing.
 814      */
 815     final void resumeNextPendingTransaction() {
 816         LOG.debug("{}: attempting to resume transaction processing", logContext);
 817         processNextPending();
 818     }
 819
 820     @SuppressWarnings("checkstyle:IllegalCatch")
 821     private void processNextPendingTransaction() {
 822         ++currentTransactionBatch;
 823         if (currentTransactionBatch > MAX_TRANSACTION_BATCH) {
 824             LOG.debug("{}: Already processed {}, scheduling continuation", logContext, currentTransactionBatch);
 825             shard.scheduleNextPendingTransaction();
 826             return;
 827         }
 828
 829         processNextPending(pendingTransactions, State.CAN_COMMIT_PENDING, entry -> {
 830             final SimpleShardDataTreeCohort cohort = entry.cohort;
 831             final DataTreeModification modification = cohort.getDataTreeModification();
 832
 833             LOG.debug("{}: Validating transaction {}", logContext, cohort.transactionId());
 834             Exception cause;
 835             try {
 836                 tip.validate(modification);
 837                 LOG.debug("{}: Transaction {} validated", logContext, cohort.transactionId());
 838                 cohort.successfulCanCommit();
 839                 entry.lastAccess = readTime();
 840                 return;
 841             } catch (ConflictingModificationAppliedException e) {
 842                 LOG.warn("{}: Store Tx {}: Conflicting modification for path {}.", logContext, cohort.transactionId(),
 843                     e.getPath());
 844                 cause = new OptimisticLockFailedException("Optimistic lock failed for path " + e.getPath(), e);
 845             } catch (DataValidationFailedException e) {
 846                 LOG.warn("{}: Store Tx {}: Data validation failed for path {}.", logContext, cohort.transactionId(),
 847                     e.getPath(), e);
 848
 849                 // For debugging purposes, allow dumping of the modification. Coupled with the above
 850                 // precondition log, it should allow us to understand what went on.
 851                 LOG.debug("{}: Store Tx {}: modifications: {}", logContext, cohort.transactionId(), modification);
 852                 LOG.trace("{}: Current tree: {}", logContext, dataTree);
 853                 cause = new TransactionCommitFailedException("Data did not pass validation for path " + e.getPath(), e);
 854             } catch (Exception e) {
 855                 LOG.warn("{}: Unexpected failure in validation phase", logContext, e);
 856                 cause = e;
 857             }
 858
 859             // Failure path: propagate the failure, remove the transaction from the queue and loop to the next one
 860             pendingTransactions.poll().cohort.failedCanCommit(cause);
 861         });
 862     }
 863
 864     private void processNextPending() {
 865         processNextPendingCommit();
 866         processNextPendingTransaction();
 867     }
 868
 869     private void processNextPending(final Queue<CommitEntry> queue, final State allowedState,
 870             final Consumer<CommitEntry> processor) {
 871         while (!queue.isEmpty()) {
 872             final CommitEntry entry = queue.peek();
 873             final SimpleShardDataTreeCohort cohort = entry.cohort;
 874
 875             if (cohort.isFailed()) {
 876                 LOG.debug("{}: Removing failed transaction {}", logContext, cohort.transactionId());
 877                 queue.remove();
 878                 continue;
 879             }
 880
 881             if (cohort.getState() == allowedState) {
 882                 processor.accept(entry);
 883             }
 884
 885             break;
 886         }
 887
 888         maybeRunOperationOnPendingTransactionsComplete();
 889     }
 890
 891     private void processNextPendingCommit() {
 892         processNextPending(pendingCommits, State.COMMIT_PENDING,
 893             entry -> startCommit(entry.cohort, entry.cohort.getCandidate()));
 894     }
 895
 896     private boolean peekNextPendingCommit() {
 897         final CommitEntry first = pendingCommits.peek();
 898         return first != null && first.cohort.getState() == State.COMMIT_PENDING;
 899     }
 900
 901     // non-final for mocking
 902     void startCanCommit(final SimpleShardDataTreeCohort cohort) {
 903         final CommitEntry head = pendingTransactions.peek();
 904         if (head == null) {
 905             LOG.warn("{}: No transactions enqueued while attempting to start canCommit on {}", logContext, cohort);
 906             return;
 907         }
 908         if (!cohort.equals(head.cohort)) {
 909             // The tx isn't at the head of the queue so we can't start canCommit at this point. Here we check if this
 910             // tx should be moved ahead of other tx's in the READY state in the pendingTransactions queue. If this tx
 911             // has other participating shards, it could deadlock with other tx's accessing the same shards
 912             // depending on the order the tx's are readied on each shard
 913             // (see https://jira.opendaylight.org/browse/CONTROLLER-1836). Therefore, if the preceding participating
 914             // shard names for a preceding pending tx, call it A, in the queue matches that of this tx, then this tx
 915             // is allowed to be moved ahead of tx A in the queue so it is processed first to avoid potential deadlock
 916             // if tx A is behind this tx in the pendingTransactions queue for a preceding shard. In other words, since
 917             // canCommmit for this tx was requested before tx A, honor that request. If this tx is moved to the head of
 918             // the queue as a result, then proceed with canCommit.
 919
 920             Collection<String> precedingShardNames = extractPrecedingShardNames(cohort.getParticipatingShardNames());
 921             if (precedingShardNames.isEmpty()) {
 922                 LOG.debug("{}: Tx {} is scheduled for canCommit step", logContext, cohort.transactionId());
 923                 return;
 924             }
 925
 926             LOG.debug("{}: Evaluating tx {} for canCommit -  preceding participating shard names {}",
 927                     logContext, cohort.transactionId(), precedingShardNames);
 928             final Iterator<CommitEntry> iter = pendingTransactions.iterator();
 929             int index = -1;
 930             int moveToIndex = -1;
 931             while (iter.hasNext()) {
 932                 final CommitEntry entry = iter.next();
 933                 ++index;
 934
 935                 if (cohort.equals(entry.cohort)) {
 936                     if (moveToIndex < 0) {
 937                         LOG.debug("{}: Not moving tx {} - cannot proceed with canCommit",
 938                                 logContext, cohort.transactionId());
 939                         return;
 940                     }
 941
 942                     LOG.debug("{}: Moving {} to index {} in the pendingTransactions queue",
 943                             logContext, cohort.transactionId(), moveToIndex);
 944                     iter.remove();
 945                     insertEntry(pendingTransactions, entry, moveToIndex);
 946
 947                     if (!cohort.equals(pendingTransactions.peek().cohort)) {
 948                         LOG.debug("{}: Tx {} is not at the head of the queue - cannot proceed with canCommit",
 949                                 logContext, cohort.transactionId());
 950                         return;
 951                     }
 952
 953                     LOG.debug("{}: Tx {} is now at the head of the queue - proceeding with canCommit",
 954                             logContext, cohort.transactionId());
 955                     break;
 956                 }
 957
 958                 if (entry.cohort.getState() != State.READY) {
 959                     LOG.debug("{}: Skipping pending transaction {} in state {}",
 960                             logContext, entry.cohort.transactionId(), entry.cohort.getState());
 961                     continue;
 962                 }
 963
 964                 final Collection<String> pendingPrecedingShardNames = extractPrecedingShardNames(
 965                         entry.cohort.getParticipatingShardNames());
 966
 967                 if (precedingShardNames.equals(pendingPrecedingShardNames)) {
 968                     if (moveToIndex < 0) {
 969                         LOG.debug("{}: Preceding shard names {} for pending tx {} match - saving moveToIndex {}",
 970                                 logContext, pendingPrecedingShardNames, entry.cohort.transactionId(), index);
 971                         moveToIndex = index;
 972                     } else {
 973                         LOG.debug(
 974                             "{}: Preceding shard names {} for pending tx {} match but moveToIndex already set to {}",
 975                             logContext, pendingPrecedingShardNames, entry.cohort.transactionId(), moveToIndex);
 976                     }
 977                 } else {
 978                     LOG.debug("{}: Preceding shard names {} for pending tx {} differ - skipping",
 979                         logContext, pendingPrecedingShardNames, entry.cohort.transactionId());
 980                 }
 981             }
 982         }
 983
 984         processNextPendingTransaction();
 985     }
 986
 987     private static void insertEntry(final Deque<CommitEntry> queue, final CommitEntry entry, final int atIndex) {
 988         if (atIndex == 0) {
 989             queue.addFirst(entry);
 990             return;
 991         }
 992
 993         LOG.trace("Inserting into Deque at index {}", atIndex);
 994
 995         Deque<CommitEntry> tempStack = new ArrayDeque<>(atIndex);
 996         for (int i = 0; i < atIndex; i++) {
 997             tempStack.push(queue.poll());
 998         }
 999
1000         queue.addFirst(entry);
1001
1002         tempStack.forEach(queue::addFirst);
1003     }
1004
1005     private Collection<String> extractPrecedingShardNames(final Optional<SortedSet<String>> participatingShardNames) {
1006         return participatingShardNames.map((Function<SortedSet<String>, Collection<String>>)
1007             set -> set.headSet(shard.getShardName())).orElse(Collections.<String>emptyList());
1008     }
1009
1010     private void failPreCommit(final Throwable cause) {
1011         shard.getShardMBean().incrementFailedTransactionsCount();
1012         pendingTransactions.poll().cohort.failedPreCommit(cause);
1013         processNextPendingTransaction();
1014     }
1015
1016     // non-final for mocking
1017     @SuppressWarnings("checkstyle:IllegalCatch")
1018     void startPreCommit(final SimpleShardDataTreeCohort cohort) {
1019         final CommitEntry entry = pendingTransactions.peek();
1020         checkState(entry != null, "Attempted to pre-commit of %s when no transactions pending", cohort);
1021
1022         final SimpleShardDataTreeCohort current = entry.cohort;
1023         verify(cohort.equals(current), "Attempted to pre-commit %s while %s is pending", cohort, current);
1024
1025         final TransactionIdentifier currentId = current.transactionId();
1026         LOG.debug("{}: Preparing transaction {}", logContext, currentId);
1027
1028         final DataTreeCandidateTip candidate;
1029         try {
1030             candidate = tip.prepare(cohort.getDataTreeModification());
1031             LOG.debug("{}: Transaction {} candidate ready", logContext, currentId);
1032         } catch (DataValidationFailedException | RuntimeException e) {
1033             failPreCommit(e);
1034             return;
1035         }
1036
1037         cohort.userPreCommit(candidate, new FutureCallback<>() {
1038             @Override
1039             public void onSuccess(final Empty result) {
1040                 // Set the tip of the data tree.
1041                 tip = verifyNotNull(candidate);
1042
1043                 entry.lastAccess = readTime();
1044
1045                 pendingTransactions.remove();
1046                 pendingCommits.add(entry);
1047
1048                 LOG.debug("{}: Transaction {} prepared", logContext, currentId);
1049
1050                 cohort.successfulPreCommit(candidate);
1051
1052                 processNextPendingTransaction();
1053             }
1054
1055             @Override
1056             public void onFailure(final Throwable failure) {
1057                 failPreCommit(failure);
1058             }
1059         });
1060     }
1061
1062     private void failCommit(final Exception cause) {
1063         shard.getShardMBean().incrementFailedTransactionsCount();
1064         pendingFinishCommits.poll().cohort.failedCommit(cause);
1065         processNextPending();
1066     }
1067
1068     @SuppressWarnings("checkstyle:IllegalCatch")
1069     private void finishCommit(final SimpleShardDataTreeCohort cohort) {
1070         final TransactionIdentifier txId = cohort.transactionId();
1071         final DataTreeCandidate candidate = cohort.getCandidate();
1072
1073         LOG.debug("{}: Resuming commit of transaction {}", logContext, txId);
1074
1075         if (tip == candidate) {
1076             // All pending candidates have been committed, reset the tip to the data tree.
1077             tip = dataTree;
1078         }
1079
1080         try {
1081             dataTree.commit(candidate);
1082         } catch (Exception e) {
1083             LOG.error("{}: Failed to commit transaction {}", logContext, txId, e);
1084             failCommit(e);
1085             return;
1086         }
1087
1088         allMetadataCommittedTransaction(txId);
1089         shard.getShardMBean().incrementCommittedTransactionCount();
1090         shard.getShardMBean().setLastCommittedTransactionTime(System.currentTimeMillis());
1091
1092         // FIXME: propagate journal index
1093         pendingFinishCommits.poll().cohort.successfulCommit(UnsignedLong.ZERO, () -> {
1094             LOG.trace("{}: Transaction {} committed, proceeding to notify", logContext, txId);
1095             notifyListeners(candidate);
1096
1097             processNextPending();
1098         });
1099     }
1100
1101     // non-final for mocking
1102     void startCommit(final SimpleShardDataTreeCohort cohort, final DataTreeCandidate candidate) {
1103         final CommitEntry entry = pendingCommits.peek();
1104         checkState(entry != null, "Attempted to start commit of %s when no transactions pending", cohort);
1105
1106         final SimpleShardDataTreeCohort current = entry.cohort;
1107         if (!cohort.equals(current)) {
1108             LOG.debug("{}: Transaction {} scheduled for commit step", logContext, cohort.transactionId());
1109             return;
1110         }
1111
1112         LOG.debug("{}: Starting commit for transaction {}", logContext, current.transactionId());
1113
1114         final TransactionIdentifier txId = cohort.transactionId();
1115         final Payload payload;
1116         try {
1117             payload = CommitTransactionPayload.create(txId, candidate, PayloadVersion.current(),
1118                     shard.getDatastoreContext().getInitialPayloadSerializedBufferCapacity());
1119         } catch (IOException e) {
1120             LOG.error("{}: Failed to encode transaction {} candidate {}", logContext, txId, candidate, e);
1121             pendingCommits.poll().cohort.failedCommit(e);
1122             processNextPending();
1123             return;
1124         }
1125
1126         // We process next transactions pending canCommit before we call persistPayload to possibly progress subsequent
1127         // transactions to the COMMIT_PENDING state so the payloads can be batched for replication. This is done for
1128         // single-shard transactions that immediately transition from canCommit to preCommit to commit. Note that
1129         // if the next pending transaction is progressed to COMMIT_PENDING and this method (startCommit) is called,
1130         // the next transaction will not attempt to replicate b/c the current transaction is still at the head of the
1131         // pendingCommits queue.
1132         processNextPendingTransaction();
1133
1134         // After processing next pending transactions, we can now remove the current transaction from pendingCommits.
1135         // Note this must be done before the call to peekNextPendingCommit below so we check the next transaction
1136         // in order to properly determine the batchHint flag for the call to persistPayload.
1137         pendingCommits.remove();
1138         pendingFinishCommits.add(entry);
1139
1140         // See if the next transaction is pending commit (ie in the COMMIT_PENDING state) so it can be batched with
1141         // this transaction for replication.
1142         boolean replicationBatchHint = peekNextPendingCommit();
1143
1144         // Once completed, we will continue via payloadReplicationComplete
1145         shard.persistPayload(txId, payload, replicationBatchHint);
1146
1147         entry.lastAccess = shard.ticker().read();
1148
1149         LOG.debug("{}: Transaction {} submitted to persistence", logContext, txId);
1150
1151         // Process the next transaction pending commit, if any. If there is one it will be batched with this
1152         // transaction for replication.
1153         processNextPendingCommit();
1154     }
1155
1156     final Collection<ActorRef> getCohortActors() {
1157         return cohortRegistry.getCohortActors();
1158     }
1159
1160     final void processCohortRegistryCommand(final ActorRef sender, final CohortRegistryCommand message) {
1161         cohortRegistry.process(sender, message);
1162     }
1163
1164     @Override
1165     final ShardDataTreeCohort createFailedCohort(final TransactionIdentifier txId, final DataTreeModification mod,
1166             final Exception failure) {
1167         final SimpleShardDataTreeCohort cohort = new SimpleShardDataTreeCohort(this, mod, txId, failure);
1168         pendingTransactions.add(new CommitEntry(cohort, readTime()));
1169         return cohort;
1170     }
1171
1172     @Override
1173     final ShardDataTreeCohort createReadyCohort(final TransactionIdentifier txId, final DataTreeModification mod,
1174             final Optional<SortedSet<String>> participatingShardNames) {
1175         SimpleShardDataTreeCohort cohort = new SimpleShardDataTreeCohort(this, mod, txId,
1176                 cohortRegistry.createCohort(schemaContext, txId, shard::executeInSelf,
1177                         COMMIT_STEP_TIMEOUT), participatingShardNames);
1178         pendingTransactions.add(new CommitEntry(cohort, readTime()));
1179         return cohort;
1180     }
1181
1182     // Exposed for ShardCommitCoordinator so it does not have deal with local histories (it does not care), this mimics
1183     // the newReadWriteTransaction()
1184     final ShardDataTreeCohort newReadyCohort(final TransactionIdentifier txId, final DataTreeModification mod,
1185             final Optional<SortedSet<String>> participatingShardNames) {
1186         final var historyId = txId.getHistoryId();
1187         if (historyId.getHistoryId() == 0) {
1188             return createReadyCohort(txId, mod, participatingShardNames);
1189         }
1190         return ensureTransactionChain(historyId, null).createReadyCohort(txId, mod, participatingShardNames);
1191     }
1192
1193     @SuppressFBWarnings(value = "DB_DUPLICATE_SWITCH_CLAUSES", justification = "See inline comments below.")
1194     final void checkForExpiredTransactions(final long transactionCommitTimeoutMillis,
1195             final Function<SimpleShardDataTreeCohort, OptionalLong> accessTimeUpdater) {
1196         final long timeout = TimeUnit.MILLISECONDS.toNanos(transactionCommitTimeoutMillis);
1197         final long now = readTime();
1198
1199         final Queue<CommitEntry> currentQueue = !pendingFinishCommits.isEmpty() ? pendingFinishCommits :
1200             !pendingCommits.isEmpty() ? pendingCommits : pendingTransactions;
1201         final CommitEntry currentTx = currentQueue.peek();
1202         if (currentTx == null) {
1203             // Empty queue, no-op
1204             return;
1205         }
1206
1207         long delta = now - currentTx.lastAccess;
1208         if (delta < timeout) {
1209             // Not expired yet, bail
1210             return;
1211         }
1212
1213         final OptionalLong updateOpt = accessTimeUpdater.apply(currentTx.cohort);
1214         if (updateOpt.isPresent()) {
1215             final long newAccess =  updateOpt.orElseThrow();
1216             final long newDelta = now - newAccess;
1217             if (newDelta < delta) {
1218                 LOG.debug("{}: Updated current transaction {} access time", logContext,
1219                     currentTx.cohort.transactionId());
1220                 currentTx.lastAccess = newAccess;
1221                 delta = newDelta;
1222             }
1223
1224             if (delta < timeout) {
1225                 // Not expired yet, bail
1226                 return;
1227             }
1228         }
1229
1230         final long deltaMillis = TimeUnit.NANOSECONDS.toMillis(delta);
1231         final State state = currentTx.cohort.getState();
1232
1233         LOG.warn("{}: Current transaction {} has timed out after {} ms in state {}", logContext,
1234             currentTx.cohort.transactionId(), deltaMillis, state);
1235         boolean processNext = true;
1236         final TimeoutException cohortFailure = new TimeoutException("Backend timeout in state " + state + " after "
1237                 + deltaMillis + "ms");
1238
1239         switch (state) {
1240             case CAN_COMMIT_PENDING:
1241                 currentQueue.remove().cohort.failedCanCommit(cohortFailure);
1242                 break;
1243             case CAN_COMMIT_COMPLETE:
1244                 // The suppression of the FindBugs "DB_DUPLICATE_SWITCH_CLAUSES" warning pertains to this clause
1245                 // whose code is duplicated with PRE_COMMIT_COMPLETE. The clauses aren't combined in case the code
1246                 // in PRE_COMMIT_COMPLETE is changed.
1247                 currentQueue.remove().cohort.reportFailure(cohortFailure);
1248                 break;
1249             case PRE_COMMIT_PENDING:
1250                 currentQueue.remove().cohort.failedPreCommit(cohortFailure);
1251                 break;
1252             case PRE_COMMIT_COMPLETE:
1253                 // FIXME: this is a legacy behavior problem. Three-phase commit protocol specifies that after we
1254                 //        are ready we should commit the transaction, not abort it. Our current software stack does
1255                 //        not allow us to do that consistently, because we persist at the time of commit, hence
1256                 //        we can end up in a state where we have pre-committed a transaction, then a leader failover
1257                 //        occurred ... the new leader does not see the pre-committed transaction and does not have
1258                 //        a running timer. To fix this we really need two persistence events.
1259                 //
1260                 //        The first one, done at pre-commit time will hold the transaction payload. When consensus
1261                 //        is reached, we exit the pre-commit phase and start the pre-commit timer. Followers do not
1262                 //        apply the state in this event.
1263                 //
1264                 //        The second one, done at commit (or abort) time holds only the transaction identifier and
1265                 //        signals to followers that the state should (or should not) be applied.
1266                 //
1267                 //        In order to make the pre-commit timer working across failovers, though, we need
1268                 //        a per-shard cluster-wide monotonic time, so a follower becoming the leader can accurately
1269                 //        restart the timer.
1270                 currentQueue.remove().cohort.reportFailure(cohortFailure);
1271                 break;
1272             case COMMIT_PENDING:
1273                 LOG.warn("{}: Transaction {} is still committing, cannot abort", logContext,
1274                     currentTx.cohort.transactionId());
1275                 currentTx.lastAccess = now;
1276                 processNext = false;
1277                 return;
1278             case READY:
1279                 currentQueue.remove().cohort.reportFailure(cohortFailure);
1280                 break;
1281             case ABORTED:
1282             case COMMITTED:
1283             case FAILED:
1284             default:
1285                 currentQueue.remove();
1286         }
1287
1288         if (processNext) {
1289             processNextPending();
1290         }
1291     }
1292
1293     // non-final for mocking
1294     boolean startAbort(final SimpleShardDataTreeCohort cohort) {
1295         final Iterator<CommitEntry> it = Iterables.concat(pendingFinishCommits, pendingCommits,
1296                 pendingTransactions).iterator();
1297         if (!it.hasNext()) {
1298             LOG.debug("{}: no open transaction while attempting to abort {}", logContext, cohort.transactionId());
1299             return true;
1300         }
1301
1302         // First entry is special, as it may already be committing
1303         final CommitEntry first = it.next();
1304         if (cohort.equals(first.cohort)) {
1305             if (cohort.getState() != State.COMMIT_PENDING) {
1306                 LOG.debug("{}: aborting head of queue {} in state {}", logContext, cohort.transactionId(),
1307                     cohort.transactionId());
1308
1309                 it.remove();
1310                 if (cohort.getCandidate() != null) {
1311                     rebaseTransactions(it, dataTree);
1312                 }
1313
1314                 processNextPending();
1315                 return true;
1316             }
1317
1318             LOG.warn("{}: transaction {} is committing, skipping abort", logContext, cohort.transactionId());
1319             return false;
1320         }
1321
1322         DataTreeTip newTip = requireNonNullElse(first.cohort.getCandidate(), dataTree);
1323         while (it.hasNext()) {
1324             final CommitEntry e = it.next();
1325             if (cohort.equals(e.cohort)) {
1326                 LOG.debug("{}: aborting queued transaction {}", logContext, cohort.transactionId());
1327
1328                 it.remove();
1329                 if (cohort.getCandidate() != null) {
1330                     rebaseTransactions(it, newTip);
1331                 }
1332
1333                 return true;
1334             }
1335
1336             newTip = requireNonNullElse(e.cohort.getCandidate(), newTip);
1337         }
1338
1339         LOG.debug("{}: aborted transaction {} not found in the queue", logContext, cohort.transactionId());
1340         return true;
1341     }
1342
1343     @SuppressWarnings("checkstyle:IllegalCatch")
1344     private void rebaseTransactions(final Iterator<CommitEntry> iter, final @NonNull DataTreeTip newTip) {
1345         tip = requireNonNull(newTip);
1346         while (iter.hasNext()) {
1347             final SimpleShardDataTreeCohort cohort = iter.next().cohort;
1348             if (cohort.getState() == State.CAN_COMMIT_COMPLETE) {
1349                 LOG.debug("{}: Revalidating queued transaction {}", logContext, cohort.transactionId());
1350
1351                 try {
1352                     tip.validate(cohort.getDataTreeModification());
1353                 } catch (DataValidationFailedException | RuntimeException e) {
1354                     LOG.debug("{}: Failed to revalidate queued transaction {}", logContext, cohort.transactionId(), e);
1355                     cohort.reportFailure(e);
1356                 }
1357             } else if (cohort.getState() == State.PRE_COMMIT_COMPLETE) {
1358                 LOG.debug("{}: Repreparing queued transaction {}", logContext, cohort.transactionId());
1359
1360                 try {
1361                     tip.validate(cohort.getDataTreeModification());
1362                     DataTreeCandidateTip candidate = tip.prepare(cohort.getDataTreeModification());
1363
1364                     cohort.setNewCandidate(candidate);
1365                     tip = candidate;
1366                 } catch (RuntimeException | DataValidationFailedException e) {
1367                     LOG.debug("{}: Failed to reprepare queued transaction {}", logContext, cohort.transactionId(), e);
1368                     cohort.reportFailure(e);
1369                 }
1370             }
1371         }
1372     }
1373
1374     final void setRunOnPendingTransactionsComplete(final Runnable operation) {
1375         runOnPendingTransactionsComplete = operation;
1376         maybeRunOperationOnPendingTransactionsComplete();
1377     }
1378
1379     private void maybeRunOperationOnPendingTransactionsComplete() {
1380         if (runOnPendingTransactionsComplete != null && !anyPendingTransactions()) {
1381             LOG.debug("{}: Pending transactions complete - running operation {}", logContext,
1382                     runOnPendingTransactionsComplete);
1383
1384             runOnPendingTransactionsComplete.run();
1385             runOnPendingTransactionsComplete = null;
1386         }
1387     }
1388
1389     final ShardStats getStats() {
1390         return shard.getShardMBean();
1391     }
1392
1393     final Iterator<SimpleShardDataTreeCohort> cohortIterator() {
1394         return Iterables.transform(Iterables.concat(pendingFinishCommits, pendingCommits, pendingTransactions),
1395             e -> e.cohort).iterator();
1396     }
1397
1398     final void removeTransactionChain(final LocalHistoryIdentifier id) {
1399         if (transactionChains.remove(id) != null) {
1400             LOG.debug("{}: Removed transaction chain {}", logContext, id);
1401         }
1402     }
1403 }