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