import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
+import java.util.function.Consumer;
import java.util.function.UnaryOperator;
import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;
import org.opendaylight.controller.cluster.access.concepts.LocalHistoryIdentifier;
import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
import org.opendaylight.controller.cluster.datastore.DataTreeCohortActorRegistry.CohortRegistryCommand;
import org.opendaylight.controller.cluster.datastore.ShardDataTreeCohort.State;
+import org.opendaylight.controller.cluster.datastore.persisted.AbstractIdentifiablePayload;
+import org.opendaylight.controller.cluster.datastore.persisted.CloseLocalHistoryPayload;
import org.opendaylight.controller.cluster.datastore.persisted.CommitTransactionPayload;
+import org.opendaylight.controller.cluster.datastore.persisted.CreateLocalHistoryPayload;
import org.opendaylight.controller.cluster.datastore.persisted.MetadataShardDataTreeSnapshot;
+import org.opendaylight.controller.cluster.datastore.persisted.PurgeLocalHistoryPayload;
import org.opendaylight.controller.cluster.datastore.persisted.ShardDataTreeSnapshot;
import org.opendaylight.controller.cluster.datastore.persisted.ShardDataTreeSnapshotMetadata;
import org.opendaylight.controller.cluster.datastore.utils.DataTreeModificationOutput;
import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeTip;
import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
-import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
import org.opendaylight.yangtools.yang.data.api.schema.tree.TipProducingDataTree;
import org.opendaylight.yangtools.yang.data.api.schema.tree.TipProducingDataTreeTip;
import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType;
private static final Logger LOG = LoggerFactory.getLogger(ShardDataTree.class);
private final Map<LocalHistoryIdentifier, ShardDataTreeTransactionChain> transactionChains = new HashMap<>();
+
private final DataTreeCohortActorRegistry cohortRegistry = new DataTreeCohortActorRegistry();
private final Queue<CommitEntry> pendingTransactions = new ArrayDeque<>();
private final Queue<CommitEntry> pendingCommits = new ArrayDeque<>();
private final Queue<CommitEntry> pendingFinishCommits = new ArrayDeque<>();
+
+ /**
+ * Callbacks that need to be invoked once a payload is replicated.
+ */
+ private final Map<Payload, Runnable> replicationCallbacks = new HashMap<>();
+
private final ShardDataTreeChangeListenerPublisher treeChangeListenerPublisher;
private final ShardDataChangeListenerPublisher dataChangeListenerPublisher;
private final Collection<ShardDataTreeMetadata<?>> metadata;
@VisibleForTesting
public ShardDataTree(final Shard shard, final SchemaContext schemaContext, final TreeType treeType) {
this(shard, schemaContext, treeType, YangInstanceIdentifier.EMPTY,
- new DefaultShardDataTreeChangeListenerPublisher(),
- new DefaultShardDataChangeListenerPublisher(), "");
+ new DefaultShardDataTreeChangeListenerPublisher(), new DefaultShardDataChangeListenerPublisher(), "");
}
final String logContext() {
((CommitTransactionPayload) payload).getCandidate();
applyRecoveryCandidate(e.getValue());
allMetadataCommittedTransaction(e.getKey());
+ } else if (payload instanceof CreateLocalHistoryPayload) {
+ allMetadataCreatedLocalHistory(((CreateLocalHistoryPayload) payload).getIdentifier());
+ } else if (payload instanceof CloseLocalHistoryPayload) {
+ allMetadataClosedLocalHistory(((CloseLocalHistoryPayload) payload).getIdentifier());
+ } else if (payload instanceof PurgeLocalHistoryPayload) {
+ allMetadataPurgedLocalHistory(((PurgeLocalHistoryPayload) payload).getIdentifier());
} else if (payload instanceof DataTreeCandidatePayload) {
applyRecoveryCandidate(((DataTreeCandidatePayload) payload).getCandidate());
} else {
Verify.verify(identifier instanceof TransactionIdentifier);
payloadReplicationComplete((TransactionIdentifier) identifier);
}
+ } else if (payload instanceof CloseLocalHistoryPayload) {
+ if (identifier != null) {
+ payloadReplicationComplete((CloseLocalHistoryPayload) payload);
+ } else {
+ allMetadataClosedLocalHistory(((CloseLocalHistoryPayload) payload).getIdentifier());
+ }
+ } else if (payload instanceof CreateLocalHistoryPayload) {
+ if (identifier != null) {
+ payloadReplicationComplete((CreateLocalHistoryPayload)payload);
+ } else {
+ allMetadataCreatedLocalHistory(((CreateLocalHistoryPayload) payload).getIdentifier());
+ }
+ } else if (payload instanceof PurgeLocalHistoryPayload) {
+ if (identifier != null) {
+ payloadReplicationComplete((PurgeLocalHistoryPayload)payload);
+ } else {
+ allMetadataPurgedLocalHistory(((PurgeLocalHistoryPayload) payload).getIdentifier());
+ }
} else {
LOG.warn("{}: ignoring unhandled identifier {} payload {}", logContext, identifier, payload);
}
}
+ private void replicatePayload(final Identifier id, final Payload payload, @Nullable final Runnable callback) {
+ if (callback != null) {
+ replicationCallbacks.put(payload, callback);
+ }
+ shard.persistPayload(id, payload, true);
+ }
+
+ private void payloadReplicationComplete(final AbstractIdentifiablePayload<?> payload) {
+ final Runnable callback = replicationCallbacks.remove(payload);
+ if (callback != null) {
+ LOG.debug("{}: replication of {} completed, invoking {}", logContext, payload.getIdentifier(), callback);
+ callback.run();
+ } else {
+ LOG.debug("{}: replication of {} has no callback", logContext, payload.getIdentifier());
+ }
+ }
+
private void payloadReplicationComplete(final TransactionIdentifier txId) {
final CommitEntry current = pendingFinishCommits.peek();
if (current == null) {
}
if (!current.cohort.getIdentifier().equals(txId)) {
- LOG.warn("{}: Head of queue is {}, ignoring consensus on transaction {}", logContext,
+ LOG.debug("{}: Head of pendingFinishCommits queue is {}, ignoring consensus on transaction {}", logContext,
current.cohort.getIdentifier(), txId);
return;
}
}
}
- ShardDataTreeTransactionChain ensureTransactionChain(final LocalHistoryIdentifier localHistoryIdentifier) {
- ShardDataTreeTransactionChain chain = transactionChains.get(localHistoryIdentifier);
+ private void allMetadataCreatedLocalHistory(final LocalHistoryIdentifier historyId) {
+ for (ShardDataTreeMetadata<?> m : metadata) {
+ m.onHistoryCreated(historyId);
+ }
+ }
+
+ private void allMetadataClosedLocalHistory(final LocalHistoryIdentifier historyId) {
+ for (ShardDataTreeMetadata<?> m : metadata) {
+ m.onHistoryClosed(historyId);
+ }
+ }
+
+ private void allMetadataPurgedLocalHistory(final LocalHistoryIdentifier historyId) {
+ for (ShardDataTreeMetadata<?> m : metadata) {
+ m.onHistoryPurged(historyId);
+ }
+ }
+
+ ShardDataTreeTransactionChain ensureTransactionChain(final LocalHistoryIdentifier historyId) {
+ ShardDataTreeTransactionChain chain = transactionChains.get(historyId);
if (chain == null) {
- chain = new ShardDataTreeTransactionChain(localHistoryIdentifier, this);
- transactionChains.put(localHistoryIdentifier, chain);
+ chain = new ShardDataTreeTransactionChain(historyId, this);
+ transactionChains.put(historyId, chain);
+ shard.persistPayload(historyId, CreateLocalHistoryPayload.create(historyId), true);
}
return chain;
}
}
+ /**
+ * Immediately close all transaction chains.
+ */
void closeAllTransactionChains() {
for (ShardDataTreeTransactionChain chain : transactionChains.values()) {
chain.close();
transactionChains.clear();
}
- void closeTransactionChain(final LocalHistoryIdentifier transactionChainId) {
- final ShardDataTreeTransactionChain chain = transactionChains.remove(transactionChainId);
- if (chain != null) {
- chain.close();
- } else {
- LOG.debug("{}: Closing non-existent transaction chain {}", logContext, transactionChainId);
+ /**
+ * Close a single transaction chain.
+ *
+ * @param id History identifier
+ * @param callback Callback to invoke upon completion, may be null
+ */
+ void closeTransactionChain(final LocalHistoryIdentifier id, @Nullable final Runnable callback) {
+ final ShardDataTreeTransactionChain chain = transactionChains.get(id);
+ if (chain == null) {
+ LOG.debug("{}: Closing non-existent transaction chain {}", logContext, id);
+ if (callback != null) {
+ callback.run();
+ }
+ return;
}
+
+ chain.close();
+ replicatePayload(id, CloseLocalHistoryPayload.create(id), callback);
+ }
+
+ /**
+ * Purge a single transaction chain.
+ *
+ * @param id History identifier
+ * @param callback Callback to invoke upon completion, may be null
+ */
+ void purgeTransactionChain(final LocalHistoryIdentifier id, @Nullable final Runnable callback) {
+ final ShardDataTreeTransactionChain chain = transactionChains.remove(id);
+ if (chain == null) {
+ LOG.debug("{}: Purging non-existent transaction chain {}", logContext, id);
+ if (callback != null) {
+ callback.run();
+ }
+ return;
+ }
+
+ replicatePayload(id, PurgeLocalHistoryPayload.create(id), callback);
}
Entry<DataChangeListenerRegistration<AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>>>,
}
public Collection<ShardDataTreeCohort> getAndClearPendingTransactions() {
- Collection<ShardDataTreeCohort> ret = new ArrayList<>(pendingTransactions.size() + pendingCommits.size()
- + pendingFinishCommits.size());
+ Collection<ShardDataTreeCohort> ret = new ArrayList<>(getQueueSize());
for (CommitEntry entry: pendingFinishCommits) {
ret.add(entry.cohort);
@SuppressWarnings("checkstyle:IllegalCatch")
private void processNextPendingTransaction() {
- while (!pendingTransactions.isEmpty()) {
- final CommitEntry entry = pendingTransactions.peek();
+ processNextPending(pendingTransactions, State.CAN_COMMIT_PENDING, entry -> {
final SimpleShardDataTreeCohort cohort = entry.cohort;
final DataTreeModification modification = cohort.getDataTreeModification();
- if (cohort.isFailed()) {
- LOG.debug("{}: Removing failed transaction {}", logContext, cohort.getIdentifier());
- pendingTransactions.remove();
- continue;
- }
-
- if (cohort.getState() != State.CAN_COMMIT_PENDING) {
- break;
- }
-
LOG.debug("{}: Validating transaction {}", logContext, cohort.getIdentifier());
Exception cause;
try {
tip.validate(modification);
LOG.debug("{}: Transaction {} validated", logContext, cohort.getIdentifier());
cohort.successfulCanCommit();
- entry.lastAccess = shard.ticker().read();
+ entry.lastAccess = ticker().read();
return;
} catch (ConflictingModificationAppliedException e) {
LOG.warn("{}: Store Tx {}: Conflicting modification for path {}.", logContext, cohort.getIdentifier(),
// Failure path: propagate the failure, remove the transaction from the queue and loop to the next one
pendingTransactions.poll().cohort.failedCanCommit(cause);
- }
+ });
+ }
- maybeRunOperationOnPendingTransactionsComplete();
+ private void processNextPending() {
+ processNextPendingCommit();
+ processNextPendingTransaction();
}
- private void processNextPendingCommit() {
- while (!pendingCommits.isEmpty()) {
- final CommitEntry entry = pendingCommits.peek();
+ private void processNextPending(final Queue<CommitEntry> queue, final State allowedState,
+ final Consumer<CommitEntry> processor) {
+ while (!queue.isEmpty()) {
+ final CommitEntry entry = queue.peek();
final SimpleShardDataTreeCohort cohort = entry.cohort;
if (cohort.isFailed()) {
LOG.debug("{}: Removing failed transaction {}", logContext, cohort.getIdentifier());
- pendingCommits.remove();
+ queue.remove();
continue;
}
- if (cohort.getState() == State.COMMIT_PENDING) {
- startCommit(cohort, cohort.getCandidate());
+ if (cohort.getState() == allowedState) {
+ processor.accept(entry);
}
break;
maybeRunOperationOnPendingTransactionsComplete();
}
- private void processNextPending() {
- processNextPendingCommit();
- processNextPendingTransaction();
+ private void processNextPendingCommit() {
+ processNextPending(pendingCommits, State.COMMIT_PENDING,
+ entry -> startCommit(entry.cohort, entry.cohort.getCandidate()));
+ }
+
+ private boolean peekNextPendingCommit() {
+ final CommitEntry first = pendingCommits.peek();
+ return first != null && first.cohort.getState() == State.COMMIT_PENDING;
}
void startCanCommit(final SimpleShardDataTreeCohort cohort) {
final SimpleShardDataTreeCohort current = entry.cohort;
Verify.verify(cohort.equals(current), "Attempted to pre-commit %s while %s is pending", cohort, current);
+
+ LOG.debug("{}: Preparing transaction {}", logContext, current.getIdentifier());
+
final DataTreeCandidateTip candidate;
try {
candidate = tip.prepare(cohort.getDataTreeModification());
- } catch (Exception e) {
- failPreCommit(e);
- return;
- }
-
- try {
cohort.userPreCommit(candidate);
- } catch (ExecutionException | TimeoutException e) {
+ } catch (ExecutionException | TimeoutException | RuntimeException e) {
failPreCommit(e);
return;
}
// Set the tip of the data tree.
tip = Verify.verifyNotNull(candidate);
- entry.lastAccess = shard.ticker().read();
+ entry.lastAccess = ticker().read();
pendingTransactions.remove();
pendingCommits.add(entry);
+
+ LOG.debug("{}: Transaction {} prepared", logContext, current.getIdentifier());
+
cohort.successfulPreCommit(candidate);
processNextPendingTransaction();
return;
}
- if (shard.canSkipPayload() || candidate.getRootNode().getModificationType() == ModificationType.UNMODIFIED) {
- LOG.debug("{}: No replication required, proceeding to finish commit", logContext);
- pendingCommits.remove();
- pendingFinishCommits.add(entry);
- finishCommit(cohort);
- return;
- }
+ LOG.debug("{}: Starting commit for transaction {}", logContext, current.getIdentifier());
final TransactionIdentifier txId = cohort.getIdentifier();
final Payload payload;
try {
payload = CommitTransactionPayload.create(txId, candidate);
-
- // Once completed, we will continue via payloadReplicationComplete
- entry.lastAccess = shard.ticker().read();
- shard.persistPayload(txId, payload);
-
- LOG.debug("{}: Transaction {} submitted to persistence", logContext, txId);
-
- pendingCommits.remove();
- pendingFinishCommits.add(entry);
} catch (IOException e) {
LOG.error("{}: Failed to encode transaction {} candidate {}", logContext, txId, candidate, e);
pendingCommits.poll().cohort.failedCommit(e);
+ processNextPending();
return;
}
- processNextPending();
+ // We process next transactions pending canCommit before we call persistPayload to possibly progress subsequent
+ // transactions to the COMMIT_PENDING state so the payloads can be batched for replication. This is done for
+ // single-shard transactions that immediately transition from canCommit to preCommit to commit. Note that
+ // if the next pending transaction is progressed to COMMIT_PENDING and this method (startCommit) is called,
+ // the next transaction will not attempt to replicate b/c the current transaction is still at the head of the
+ // pendingCommits queue.
+ processNextPendingTransaction();
+
+ // After processing next pending transactions, we can now remove the current transaction from pendingCommits.
+ // Note this must be done before the call to peekNextPendingCommit below so we check the next transaction
+ // in order to properly determine the batchHint flag for the call to persistPayload.
+ pendingCommits.remove();
+ pendingFinishCommits.add(entry);
+
+ // See if the next transaction is pending commit (ie in the COMMIT_PENDING state) so it can be batched with
+ // this transaction for replication.
+ boolean replicationBatchHint = peekNextPendingCommit();
+
+ // Once completed, we will continue via payloadReplicationComplete
+ shard.persistPayload(txId, payload, replicationBatchHint);
+
+ entry.lastAccess = shard.ticker().read();
+
+ LOG.debug("{}: Transaction {} submitted to persistence", logContext, txId);
+
+ // Process the next transaction pending commit, if any. If there is one it will be batched with this
+ // transaction for replication.
+ processNextPendingCommit();
+ }
+
+ Collection<ActorRef> getCohortActors() {
+ return cohortRegistry.getCohortActors();
}
void processCohortRegistryCommand(final ActorRef sender, final CohortRegistryCommand message) {
final DataTreeModification modification) {
SimpleShardDataTreeCohort cohort = new SimpleShardDataTreeCohort(this, modification, txId,
cohortRegistry.createCohort(schemaContext, txId, COMMIT_STEP_TIMEOUT));
- pendingTransactions.add(new CommitEntry(cohort, shard.ticker().read()));
+ pendingTransactions.add(new CommitEntry(cohort, ticker().read()));
return cohort;
}
@SuppressFBWarnings(value = "DB_DUPLICATE_SWITCH_CLAUSES", justification = "See inline comments below.")
void checkForExpiredTransactions(final long transactionCommitTimeoutMillis) {
final long timeout = TimeUnit.MILLISECONDS.toNanos(transactionCommitTimeoutMillis);
- final long now = shard.ticker().read();
+ final long now = ticker().read();
final Queue<CommitEntry> currentQueue = !pendingFinishCommits.isEmpty() ? pendingFinishCommits :
!pendingCommits.isEmpty() ? pendingCommits : pendingTransactions;
return true;
} else {
- newTip = MoreObjects.firstNonNull(e.cohort.getCandidate(), dataTree);
+ newTip = MoreObjects.firstNonNull(e.cohort.getCandidate(), newTip);
}
}
}
@SuppressWarnings("checkstyle:IllegalCatch")
- private void rebaseTransactions(Iterator<CommitEntry> iter, @Nonnull TipProducingDataTreeTip newTip) {
+ private void rebaseTransactions(final Iterator<CommitEntry> iter, @Nonnull final TipProducingDataTreeTip newTip) {
tip = Preconditions.checkNotNull(newTip);
while (iter.hasNext()) {
final SimpleShardDataTreeCohort cohort = iter.next().cohort;