X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-distributed-datastore%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fdatastore%2FShard.java;h=b76c0fac34c2b9f7299eb69f230fc2c714bb235e;hp=439c2baac83dd42bb426dab7eb8a5dda7a277e54;hb=4062f5241a2a6f58ffb83dd1e9939ee66122d217;hpb=a14ed47823d85d2547fbfd7e6c42649962913d34 diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/Shard.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/Shard.java index 439c2baac8..b76c0fac34 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/Shard.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/Shard.java @@ -17,16 +17,18 @@ import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Optional; import com.google.common.base.Preconditions; import java.io.IOException; +import java.util.Collection; import java.util.Collections; import java.util.Map; +import java.util.concurrent.ExecutionException; import java.util.concurrent.TimeUnit; import javax.annotation.Nonnull; import org.opendaylight.controller.cluster.common.actor.CommonConfig; +import org.opendaylight.controller.cluster.common.actor.MessageTracker; +import org.opendaylight.controller.cluster.common.actor.MessageTracker.Error; import org.opendaylight.controller.cluster.common.actor.MeteringBehavior; -import org.opendaylight.controller.cluster.datastore.ShardCommitCoordinator.CohortEntry; import org.opendaylight.controller.cluster.datastore.exceptions.NoShardLeaderException; import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier; -import org.opendaylight.controller.cluster.datastore.identifiers.ShardTransactionIdentifier; import org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard.ShardMBeanFactory; import org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard.ShardStats; import org.opendaylight.controller.cluster.datastore.messages.AbortTransaction; @@ -51,7 +53,6 @@ import org.opendaylight.controller.cluster.datastore.messages.UpdateSchemaContex import org.opendaylight.controller.cluster.datastore.modification.Modification; import org.opendaylight.controller.cluster.datastore.modification.MutableCompositeModification; import org.opendaylight.controller.cluster.datastore.utils.Dispatchers; -import org.opendaylight.controller.cluster.datastore.utils.MessageTracker; import org.opendaylight.controller.cluster.notifications.LeaderStateChanged; import org.opendaylight.controller.cluster.notifications.RegisterRoleChangeListener; import org.opendaylight.controller.cluster.notifications.RoleChangeNotifier; @@ -62,9 +63,8 @@ import org.opendaylight.controller.cluster.raft.RaftState; import org.opendaylight.controller.cluster.raft.base.messages.FollowerInitialSyncUpStatus; import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply; import org.opendaylight.controller.cluster.raft.messages.ServerRemoved; -import org.opendaylight.controller.cluster.raft.protobuff.client.messages.CompositeModificationByteStringPayload; -import org.opendaylight.controller.cluster.raft.protobuff.client.messages.CompositeModificationPayload; -import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree; +import org.opendaylight.yangtools.concepts.Identifier; +import org.opendaylight.yangtools.util.StringIdentifier; import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate; import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException; import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType; @@ -81,13 +81,24 @@ import scala.concurrent.duration.FiniteDuration; */ public class Shard extends RaftActor { - protected static final Object TX_COMMIT_TIMEOUT_CHECK_MESSAGE = "txCommitTimeoutCheck"; - @VisibleForTesting - static final Object GET_SHARD_MBEAN_MESSAGE = "getShardMBeanMessage"; + static final Object TX_COMMIT_TIMEOUT_CHECK_MESSAGE = new Object() { + @Override + public String toString() { + return "txCommitTimeoutCheck"; + } + }; @VisibleForTesting - static final String DEFAULT_NAME = "default"; + static final Object GET_SHARD_MBEAN_MESSAGE = new Object() { + @Override + public String toString() { + return "getShardMBeanMessage"; + } + }; + + // FIXME: shard names should be encapsulated in their own class and this should be exposed as a constant. + public static final String DEFAULT_NAME = "default"; // The state of this Shard private final ShardDataTree store; @@ -133,7 +144,9 @@ public class Shard extends RaftActor { LOG.info("Shard created : {}, persistent : {}", name, datastoreContext.isPersistent()); - store = new ShardDataTree(builder.getSchemaContext(), builder.getTreeType()); + store = new ShardDataTree(builder.getSchemaContext(), builder.getTreeType(), + new ShardDataTreeChangeListenerPublisherActorProxy(getContext(), name + "-DTCL-publisher"), + new ShardDataChangeListenerPublisherActorProxy(getContext(), name + "-DCL-publisher"), name); shardMBean = ShardMBeanFactory.getShardStatsMBean(name.toString(), datastoreContext.getDataStoreMXBeanType()); @@ -193,30 +206,28 @@ public class Shard extends RaftActor { } @Override - public void onReceiveRecover(final Object message) throws Exception { + protected void handleRecover(final Object message) { LOG.debug("{}: onReceiveRecover: Received message {} from {}", persistenceId(), message.getClass(), getSender()); - super.onReceiveRecover(message); + super.handleRecover(message); if (LOG.isTraceEnabled()) { appendEntriesReplyTracker.begin(); } } @Override - public void onReceiveCommand(final Object message) throws Exception { - - MessageTracker.Context context = appendEntriesReplyTracker.received(message); - - if(context.error().isPresent()){ - LOG.trace("{} : AppendEntriesReply failed to arrive at the expected interval {}", persistenceId(), - context.error()); - } + protected void handleNonRaftCommand(final Object message) { + try (final MessageTracker.Context context = appendEntriesReplyTracker.received(message)) { + final Optional maybeError = context.error(); + if (maybeError.isPresent()) { + LOG.trace("{} : AppendEntriesReply failed to arrive at the expected interval {}", persistenceId(), + maybeError.get()); + } - try { if (CreateTransaction.isSerializedType(message)) { handleCreateTransaction(message); - } else if (BatchedModifications.class.isInstance(message)) { + } else if (message instanceof BatchedModifications) { handleBatchedModifications((BatchedModifications)message); } else if (message instanceof ForwardedReadyTransaction) { handleForwardedReadyTransaction((ForwardedReadyTransaction) message); @@ -240,7 +251,7 @@ public class Shard extends RaftActor { PeerAddressResolved resolved = (PeerAddressResolved) message; setPeerAddress(resolved.getPeerId().toString(), resolved.getPeerAddress()); - } else if (message.equals(TX_COMMIT_TIMEOUT_CHECK_MESSAGE)) { + } else if (TX_COMMIT_TIMEOUT_CHECK_MESSAGE.equals(message)) { commitCoordinator.checkForExpiredTransactions(transactionCommitTimeout, this); } else if(message instanceof DatastoreContext) { onDatastoreContext((DatastoreContext)message); @@ -257,11 +268,12 @@ public class Shard extends RaftActor { context().parent().forward(message, context()); } else if(ShardTransactionMessageRetrySupport.TIMER_MESSAGE_CLASS.isInstance(message)) { messageRetrySupport.onTimerMessage(message); + } else if (message instanceof DataTreeCohortActorRegistry.CohortRegistryCommand) { + commitCoordinator.processCohortRegistryCommand(getSender(), + (DataTreeCohortActorRegistry.CohortRegistryCommand) message); } else { - super.onReceiveCommand(message); + super.handleNonRaftCommand(message); } - } finally { - context.done(); } } @@ -284,9 +296,8 @@ public class Shard extends RaftActor { @Override protected LeaderStateChanged newLeaderStateChanged(String memberId, String leaderId, short leaderPayloadVersion) { - return new ShardLeaderStateChanged(memberId, leaderId, - isLeader() ? Optional.of(store.getDataTree()) : Optional.absent(), - leaderPayloadVersion); + return isLeader() ? new ShardLeaderStateChanged(memberId, leaderId, store.getDataTree(), leaderPayloadVersion) + : new ShardLeaderStateChanged(memberId, leaderId, leaderPayloadVersion); } protected void onDatastoreContext(DatastoreContext context) { @@ -318,22 +329,54 @@ public class Shard extends RaftActor { if ((!hasFollowers() && !persistence().isRecoveryApplicable()) || isEmptyCommit(candidate)) { applyModificationToState(cohortEntry.getReplySender(), cohortEntry.getTransactionID(), candidate); } else { - Shard.this.persistData(cohortEntry.getReplySender(), cohortEntry.getTransactionID(), + persistData(cohortEntry.getReplySender(), cohortEntry.getTransactionID(), DataTreeCandidatePayload.create(candidate)); } } private void handleCommitTransaction(final CommitTransaction commit) { - if(!commitCoordinator.handleCommit(commit.getTransactionID(), getSender(), this)) { - shardMBean.incrementFailedTransactionsCount(); + if (isLeader()) { + if(!commitCoordinator.handleCommit(new StringIdentifier(commit.getTransactionID()), getSender(), this)) { + shardMBean.incrementFailedTransactionsCount(); + } + } else { + ActorSelection leader = getLeader(); + if (leader == null) { + messageRetrySupport.addMessageToRetry(commit, getSender(), + "Could not commit transaction " + commit.getTransactionID()); + } else { + LOG.debug("{}: Forwarding CommitTransaction to leader {}", persistenceId(), leader); + leader.forward(commit, getContext()); + } } } - private void finishCommit(@Nonnull final ActorRef sender, @Nonnull final String transactionID, @Nonnull final CohortEntry cohortEntry) { + private void finishCommit(@Nonnull final ActorRef sender, @Nonnull final Identifier transactionID, + @Nonnull final CohortEntry cohortEntry) { LOG.debug("{}: Finishing commit for transaction {}", persistenceId(), cohortEntry.getTransactionID()); try { + try { cohortEntry.commit(); + } catch(ExecutionException e) { + // We may get a "store tree and candidate base differ" IllegalStateException from commit under + // certain edge case scenarios so we'll try to re-apply the candidate from scratch as a last + // resort. Eg, we're a follower and a tx payload is replicated but the leader goes down before + // applying it to the state. We then become the leader and a second tx is pre-committed and + // replicated. When consensus occurs, this will cause the first tx to be applied as a foreign + // candidate via applyState prior to the second tx. Since the second tx has already been + // pre-committed, when it gets here to commit it will get an IllegalStateException. + + // FIXME - this is not an ideal way to handle this scenario. This is temporary - a cleaner + // solution will be forthcoming. + if(e.getCause() instanceof IllegalStateException) { + LOG.debug("{}: commit failed for transaction {} - retrying as foreign candidate", persistenceId(), + transactionID, e); + store.applyForeignCandidate(transactionID, cohortEntry.getCandidate()); + } else { + throw e; + } + } sender.tell(CommitTransactionReply.instance(cohortEntry.getClientVersion()).toSerializable(), getSelf()); @@ -351,7 +394,7 @@ public class Shard extends RaftActor { } } - private void finishCommit(@Nonnull final ActorRef sender, final @Nonnull String transactionID) { + private void finishCommit(@Nonnull final ActorRef sender, final @Nonnull Identifier transactionID) { // With persistence enabled, this method is called via applyState by the leader strategy // after the commit has been replicated to a majority of the followers. @@ -390,12 +433,24 @@ public class Shard extends RaftActor { private void handleCanCommitTransaction(final CanCommitTransaction canCommit) { LOG.debug("{}: Can committing transaction {}", persistenceId(), canCommit.getTransactionID()); - commitCoordinator.handleCanCommit(canCommit.getTransactionID(), getSender(), this); + + if (isLeader()) { + commitCoordinator.handleCanCommit(new StringIdentifier(canCommit.getTransactionID()), getSender(), this); + } else { + ActorSelection leader = getLeader(); + if (leader == null) { + messageRetrySupport.addMessageToRetry(canCommit, getSender(), + "Could not canCommit transaction " + canCommit.getTransactionID()); + } else { + LOG.debug("{}: Forwarding CanCommitTransaction to leader {}", persistenceId(), leader); + leader.forward(canCommit, getContext()); + } + } } protected void handleBatchedModificationsLocal(BatchedModifications batched, ActorRef sender) { try { - commitCoordinator.handleBatchedModifications(batched, sender, this); + commitCoordinator.handleBatchedModifications(batched, sender, this, store.getSchemaContext()); } catch (Exception e) { LOG.error("{}: Error handling BatchedModifications for Tx {}", persistenceId(), batched.getTransactionID(), e); @@ -425,11 +480,19 @@ public class Shard extends RaftActor { messageRetrySupport.addMessageToRetry(batched, getSender(), "Could not commit transaction " + batched.getTransactionID()); } else { - // TODO: what if this is not the first batch and leadership changed in between batched messages? - // We could check if the commitCoordinator already has a cached entry and forward all the previous - // batched modifications. - LOG.debug("{}: Forwarding BatchedModifications to leader {}", persistenceId(), leader); - leader.forward(batched, getContext()); + // If this is not the first batch and leadership changed in between batched messages, + // we need to reconstruct previous BatchedModifications from the transaction + // DataTreeModification, honoring the max batched modification count, and forward all the + // previous BatchedModifications to the new leader. + Collection newModifications = commitCoordinator.createForwardedBatchedModifications( + batched, datastoreContext.getShardBatchedModificationCount()); + + LOG.debug("{}: Forwarding {} BatchedModifications to leader {}", persistenceId(), + newModifications.size(), leader); + + for(BatchedModifications bm: newModifications) { + leader.forward(bm, getContext()); + } } } } @@ -456,7 +519,7 @@ public class Shard extends RaftActor { boolean isLeaderActive = isLeaderActive(); if (isLeader() && isLeaderActive) { try { - commitCoordinator.handleReadyLocalTransaction(message, getSender(), this); + commitCoordinator.handleReadyLocalTransaction(message, getSender(), this, store.getSchemaContext()); } catch (Exception e) { LOG.error("{}: Error handling ReadyLocalTransaction for Tx {}", persistenceId(), message.getTransactionID(), e); @@ -480,7 +543,8 @@ public class Shard extends RaftActor { boolean isLeaderActive = isLeaderActive(); if (isLeader() && isLeaderActive) { - commitCoordinator.handleForwardedReadyTransaction(forwardedReady, getSender(), this); + commitCoordinator.handleForwardedReadyTransaction(forwardedReady, getSender(), this, + store.getSchemaContext()); } else { ActorSelection leader = getLeader(); if (!isLeaderActive || leader == null) { @@ -502,7 +566,7 @@ public class Shard extends RaftActor { } void doAbortTransaction(final String transactionID, final ActorRef sender) { - commitCoordinator.handleAbort(transactionID, sender, this); + commitCoordinator.handleAbort(new StringIdentifier(transactionID), sender, this); } private void handleCreateTransaction(final Object message) { @@ -520,13 +584,6 @@ public class Shard extends RaftActor { store.closeTransactionChain(closeTransactionChain.getTransactionChainId()); } - private ActorRef createTypedTransactionActor(int transactionType, - ShardTransactionIdentifier transactionId, String transactionChainId) { - - return transactionActorFactory.newShardTransaction(TransactionType.fromInt(transactionType), - transactionId, transactionChainId); - } - private void createTransaction(CreateTransaction createTransaction) { try { if(TransactionType.fromInt(createTransaction.getTransactionType()) != TransactionType.READ_ONLY && @@ -544,20 +601,10 @@ public class Shard extends RaftActor { } } - private ActorRef createTransaction(int transactionType, String remoteTransactionId, - String transactionChainId) { - - - ShardTransactionIdentifier transactionId = new ShardTransactionIdentifier(remoteTransactionId); - - if(LOG.isDebugEnabled()) { - LOG.debug("{}: Creating transaction : {} ", persistenceId(), transactionId); - } - - ActorRef transactionActor = createTypedTransactionActor(transactionType, transactionId, - transactionChainId); - - return transactionActor; + private ActorRef createTransaction(int transactionType, String transactionId, String transactionChainId) { + LOG.debug("{}: Creating transaction : {} ", persistenceId(), transactionId); + return transactionActorFactory.newShardTransaction(TransactionType.fromInt(transactionType), + transactionId, transactionChainId); } private void commitWithNewTransaction(final Modification modification) { @@ -619,7 +666,7 @@ public class Shard extends RaftActor { } @Override - protected void applyState(final ActorRef clientActor, final String identifier, final Object data) { + protected void applyState(final ActorRef clientActor, final Identifier identifier, final Object data) { if (data instanceof DataTreeCandidatePayload) { if (clientActor == null) { // No clientActor indicates a replica coming from the leader @@ -632,22 +679,13 @@ public class Shard extends RaftActor { // Replication consensus reached, proceed to commit finishCommit(clientActor, identifier); } - } else if (data instanceof CompositeModificationPayload) { - Object modification = ((CompositeModificationPayload) data).getModification(); - - applyModificationToState(clientActor, identifier, modification); - } else if(data instanceof CompositeModificationByteStringPayload ){ - Object modification = ((CompositeModificationByteStringPayload) data).getModification(); - - applyModificationToState(clientActor, identifier, modification); } else { - LOG.error("{}: Unknown state received {} Class loader = {} CompositeNodeMod.ClassLoader = {}", - persistenceId(), data, data.getClass().getClassLoader(), - CompositeModificationPayload.class.getClassLoader()); + LOG.error("{}: Unknown state received {} ClassLoader {}", persistenceId(), data, + data.getClass().getClassLoader()); } } - private void applyModificationToState(ActorRef clientActor, String identifier, Object modification) { + private void applyModificationToState(ActorRef clientActor, Identifier identifier, Object modification) { if(modification == null) { LOG.error( "{}: modification is null - this is very unexpected, clientActor = {}, identifier = {}", @@ -678,9 +716,6 @@ public class Shard extends RaftActor { } store.closeAllTransactionChains(); - - commitCoordinator.abortPendingTransactions( - "The transacton was aborted due to inflight leadership change.", this); } if(hasLeader && !isIsolatedLeader()) { @@ -692,7 +727,31 @@ public class Shard extends RaftActor { protected void onLeaderChanged(String oldLeader, String newLeader) { shardMBean.incrementLeadershipChangeCount(); - if(hasLeader() && !isIsolatedLeader()) { + boolean hasLeader = hasLeader(); + if(hasLeader && !isLeader()) { + // Another leader was elected. If we were the previous leader and had pending transactions, convert + // them to transaction messages and send to the new leader. + ActorSelection leader = getLeader(); + if(leader != null) { + Collection messagesToForward = commitCoordinator.convertPendingTransactionsToMessages( + datastoreContext.getShardBatchedModificationCount()); + + if(!messagesToForward.isEmpty()) { + LOG.debug("{}: Forwarding {} pending transaction messages to leader {}", persistenceId(), + messagesToForward.size(), leader); + + for(Object message: messagesToForward) { + leader.tell(message, self()); + } + } + } else { + commitCoordinator.abortPendingTransactions( + "The transacton was aborted due to inflight leadership change and the leader address isn't available.", + this); + } + } + + if(hasLeader && !isIsolatedLeader()) { messageRetrySupport.retryMessages(); } }