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