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