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

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.