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