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