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

©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.