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