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=62d3259a714059f497ca3e97ad08166a3a1106bf;hp=0672023fcbfe0e207036006d85ca9d1509a94a38;hb=a5b0d08ddb4ff2ff34d27d35f0c0be4b4b416dee;hpb=7435f945b84ace0a7e92093a425696ae8bf0da32 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 0672023fcb..1f786e6a20 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 @@ -12,118 +12,136 @@ import akka.actor.ActorRef; import akka.actor.ActorSelection; import akka.actor.Cancellable; import akka.actor.Props; -import akka.japi.Creator; -import akka.persistence.RecoveryFailure; +import akka.actor.Status.Failure; import akka.serialization.Serialization; import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Optional; import com.google.common.base.Preconditions; -import com.google.common.collect.Lists; -import com.google.common.util.concurrent.FutureCallback; -import com.google.common.util.concurrent.Futures; -import com.google.common.util.concurrent.ListenableFuture; +import com.google.common.base.Ticker; +import com.google.common.collect.ImmutableList; +import com.google.common.collect.Range; import java.io.IOException; +import java.util.Arrays; import java.util.Collection; +import java.util.Collections; import java.util.HashMap; -import java.util.List; import java.util.Map; -import java.util.concurrent.ExecutionException; import java.util.concurrent.TimeUnit; import javax.annotation.Nonnull; -import org.opendaylight.controller.cluster.DataPersistenceProvider; +import javax.annotation.Nullable; +import org.opendaylight.controller.cluster.access.ABIVersion; +import org.opendaylight.controller.cluster.access.commands.ConnectClientRequest; +import org.opendaylight.controller.cluster.access.commands.ConnectClientSuccess; +import org.opendaylight.controller.cluster.access.commands.LocalHistoryRequest; +import org.opendaylight.controller.cluster.access.commands.NotLeaderException; +import org.opendaylight.controller.cluster.access.commands.TransactionRequest; +import org.opendaylight.controller.cluster.access.concepts.ClientIdentifier; +import org.opendaylight.controller.cluster.access.concepts.FrontendIdentifier; +import org.opendaylight.controller.cluster.access.concepts.Request; +import org.opendaylight.controller.cluster.access.concepts.RequestEnvelope; +import org.opendaylight.controller.cluster.access.concepts.RequestException; +import org.opendaylight.controller.cluster.access.concepts.RequestSuccess; +import org.opendaylight.controller.cluster.access.concepts.RetiredGenerationException; +import org.opendaylight.controller.cluster.access.concepts.RuntimeRequestException; +import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier; +import org.opendaylight.controller.cluster.access.concepts.UnsupportedRequestException; 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.compat.BackwardsCompatibleThreePhaseCommitCohort; 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; -import org.opendaylight.controller.cluster.datastore.messages.AbortTransactionReply; import org.opendaylight.controller.cluster.datastore.messages.ActorInitialized; +import org.opendaylight.controller.cluster.datastore.messages.BatchedModifications; import org.opendaylight.controller.cluster.datastore.messages.CanCommitTransaction; import org.opendaylight.controller.cluster.datastore.messages.CloseTransactionChain; import org.opendaylight.controller.cluster.datastore.messages.CommitTransaction; -import org.opendaylight.controller.cluster.datastore.messages.CommitTransactionReply; -import org.opendaylight.controller.cluster.datastore.messages.CreateSnapshot; import org.opendaylight.controller.cluster.datastore.messages.CreateTransaction; import org.opendaylight.controller.cluster.datastore.messages.CreateTransactionReply; -import org.opendaylight.controller.cluster.datastore.messages.EnableNotification; +import org.opendaylight.controller.cluster.datastore.messages.DatastoreSnapshot; +import org.opendaylight.controller.cluster.datastore.messages.DatastoreSnapshot.ShardSnapshot; import org.opendaylight.controller.cluster.datastore.messages.ForwardedReadyTransaction; +import org.opendaylight.controller.cluster.datastore.messages.GetShardDataTree; import org.opendaylight.controller.cluster.datastore.messages.PeerAddressResolved; -import org.opendaylight.controller.cluster.datastore.messages.ReadyTransactionReply; +import org.opendaylight.controller.cluster.datastore.messages.ReadyLocalTransaction; import org.opendaylight.controller.cluster.datastore.messages.RegisterChangeListener; -import org.opendaylight.controller.cluster.datastore.messages.RegisterChangeListenerReply; +import org.opendaylight.controller.cluster.datastore.messages.RegisterDataTreeChangeListener; +import org.opendaylight.controller.cluster.datastore.messages.ShardLeaderStateChanged; import org.opendaylight.controller.cluster.datastore.messages.UpdateSchemaContext; -import org.opendaylight.controller.cluster.datastore.modification.Modification; -import org.opendaylight.controller.cluster.datastore.modification.ModificationPayload; -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.datastore.utils.SerializationUtils; +import org.opendaylight.controller.cluster.notifications.LeaderStateChanged; +import org.opendaylight.controller.cluster.notifications.RegisterRoleChangeListener; import org.opendaylight.controller.cluster.notifications.RoleChangeNotifier; import org.opendaylight.controller.cluster.raft.RaftActor; -import org.opendaylight.controller.cluster.raft.ReplicatedLogEntry; +import org.opendaylight.controller.cluster.raft.RaftActorRecoveryCohort; +import org.opendaylight.controller.cluster.raft.RaftActorSnapshotCohort; +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.protobuff.client.messages.CompositeModificationByteStringPayload; -import org.opendaylight.controller.cluster.raft.protobuff.client.messages.CompositeModificationPayload; +import org.opendaylight.controller.cluster.raft.messages.ServerRemoved; import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload; -import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeListener; -import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStore; -import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStoreFactory; -import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort; -import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransaction; -import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionChain; -import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionFactory; -import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction; -import org.opendaylight.yangtools.concepts.ListenerRegistration; -import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; -import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; +import org.opendaylight.yangtools.concepts.Identifier; +import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException; +import org.opendaylight.yangtools.yang.data.api.schema.tree.TipProducingDataTree; +import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType; import org.opendaylight.yangtools.yang.model.api.SchemaContext; import scala.concurrent.duration.Duration; import scala.concurrent.duration.FiniteDuration; /** - * A Shard represents a portion of the logical data tree
+ * A Shard represents a portion of the logical data tree. + * *

- * Our Shard uses InMemoryDataStore as it's internal representation and delegates all requests it - *

+ * Our Shard uses InMemoryDataTree as it's internal representation and delegates all requests it */ public class Shard extends RaftActor { - private static final YangInstanceIdentifier DATASTORE_ROOT = YangInstanceIdentifier.builder().build(); - - private static final Object TX_COMMIT_TIMEOUT_CHECK_MESSAGE = "txCommitTimeoutCheck"; - @VisibleForTesting - static final String DEFAULT_NAME = "default"; + static final Object TX_COMMIT_TIMEOUT_CHECK_MESSAGE = new Object() { + @Override + public String toString() { + return "txCommitTimeoutCheck"; + } + }; - // The state of this Shard - private final InMemoryDOMDataStore store; + @VisibleForTesting + static final Object GET_SHARD_MBEAN_MESSAGE = new Object() { + @Override + public String toString() { + return "getShardMBeanMessage"; + } + }; - /// The name of this shard - private final ShardIdentifier name; + // 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"; - private final ShardStats shardMBean; + private static final Collection SUPPORTED_ABIVERSIONS; - private final List dataChangeListeners = Lists.newArrayList(); + static { + final ABIVersion[] values = ABIVersion.values(); + final ABIVersion[] real = Arrays.copyOfRange(values, 1, values.length - 1); + SUPPORTED_ABIVERSIONS = ImmutableList.copyOf(real).reverse(); + } - private final List delayedListenerRegistrations = - Lists.newArrayList(); + // FIXME: make this a dynamic property based on mailbox size and maximum number of clients + private static final int CLIENT_MAX_MESSAGES = 1000; - private final DatastoreContext datastoreContext; + // The state of this Shard + private final ShardDataTree store; - private final DataPersistenceProvider dataPersistenceProvider; + /// The name of this shard + private final String name; - private SchemaContext schemaContext; + private final ShardStats shardMBean; - private int createSnapshotTransactionCounter; + private DatastoreContext datastoreContext; private final ShardCommitCoordinator commitCoordinator; - private final long transactionCommitTimeout; + private long transactionCommitTimeout; private Cancellable txCommitTimeoutCheckSchedule; @@ -131,632 +149,549 @@ public class Shard extends RaftActor { private final MessageTracker appendEntriesReplyTracker; - /** - * Coordinates persistence recovery on startup. - */ - private ShardRecoveryCoordinator recoveryCoordinator; - private List currentLogRecoveryBatch; + private final ShardTransactionActorFactory transactionActorFactory; - private final Map transactionChains = new HashMap<>(); + private final ShardSnapshotCohort snapshotCohort; - private final String txnDispatcherPath; + private final DataTreeChangeListenerSupport treeChangeSupport = new DataTreeChangeListenerSupport(this); + private final DataChangeListenerSupport changeSupport = new DataChangeListenerSupport(this); - protected Shard(final ShardIdentifier name, final Map peerAddresses, - final DatastoreContext datastoreContext, final SchemaContext schemaContext) { - super(name.toString(), mapPeerAddresses(peerAddresses), - Optional.of(datastoreContext.getShardRaftConfig())); - this.name = name; - this.datastoreContext = datastoreContext; - this.schemaContext = schemaContext; - this.dataPersistenceProvider = (datastoreContext.isPersistent()) - ? new PersistentDataProvider() : new NonPersistentRaftDataProvider(); - this.txnDispatcherPath = new Dispatchers(context().system().dispatchers()) - .getDispatcherPath(Dispatchers.DispatcherType.Transaction); + private ShardSnapshot restoreFromSnapshot; + private final ShardTransactionMessageRetrySupport messageRetrySupport; - LOG.info("Shard created : {}, persistent : {}", name, datastoreContext.isPersistent()); + private final FrontendMetadata frontendMetadata = new FrontendMetadata(); + private final Map knownFrontends = new HashMap<>(); - store = InMemoryDOMDataStoreFactory.create(name.toString(), null, - datastoreContext.getDataStoreProperties()); + protected Shard(final AbstractBuilder builder) { + super(builder.getId().toString(), builder.getPeerAddresses(), + Optional.of(builder.getDatastoreContext().getShardRaftConfig()), DataStoreVersions.CURRENT_VERSION); - if(schemaContext != null) { - store.onGlobalContextUpdated(schemaContext); + this.name = builder.getId().toString(); + this.datastoreContext = builder.getDatastoreContext(); + this.restoreFromSnapshot = builder.getRestoreFromSnapshot(); + + setPersistence(datastoreContext.isPersistent()); + + LOG.info("Shard created : {}, persistent : {}", name, datastoreContext.isPersistent()); + + ShardDataTreeChangeListenerPublisherActorProxy treeChangeListenerPublisher = + new ShardDataTreeChangeListenerPublisherActorProxy(getContext(), name + "-DTCL-publisher"); + ShardDataChangeListenerPublisherActorProxy dataChangeListenerPublisher = + new ShardDataChangeListenerPublisherActorProxy(getContext(), name + "-DCL-publisher"); + if (builder.getDataTree() != null) { + store = new ShardDataTree(this, builder.getSchemaContext(), builder.getDataTree(), + treeChangeListenerPublisher, dataChangeListenerPublisher, name); + } else { + store = new ShardDataTree(this, builder.getSchemaContext(), builder.getTreeType(), + builder.getDatastoreContext().getStoreRoot(), treeChangeListenerPublisher, + dataChangeListenerPublisher, name); } - shardMBean = ShardMBeanFactory.getShardStatsMBean(name.toString(), - datastoreContext.getDataStoreMXBeanType()); - shardMBean.setNotificationManager(store.getDataChangeListenerNotificationManager()); + shardMBean = ShardMBeanFactory.getShardStatsMBean(name, datastoreContext.getDataStoreMXBeanType(), this); if (isMetricsCaptureEnabled()) { getContext().become(new MeteringBehavior(this)); } - commitCoordinator = new ShardCommitCoordinator(TimeUnit.SECONDS.convert(1, TimeUnit.MINUTES), - datastoreContext.getShardTransactionCommitQueueCapacity(), LOG, name.toString()); + commitCoordinator = new ShardCommitCoordinator(store, LOG, this.name); - transactionCommitTimeout = TimeUnit.MILLISECONDS.convert( - datastoreContext.getShardTransactionCommitTimeoutInSeconds(), TimeUnit.SECONDS); + setTransactionCommitTimeout(); // create a notifier actor for each cluster member - roleChangeNotifier = createRoleChangeNotifier(name.toString()); + roleChangeNotifier = createRoleChangeNotifier(name); appendEntriesReplyTracker = new MessageTracker(AppendEntriesReply.class, getRaftActorContext().getConfigParams().getIsolatedCheckIntervalInMillis()); - } - private static Map mapPeerAddresses( - final Map peerAddresses) { - Map map = new HashMap<>(); + transactionActorFactory = new ShardTransactionActorFactory(store, datastoreContext, + new Dispatchers(context().system().dispatchers()).getDispatcherPath( + Dispatchers.DispatcherType.Transaction), self(), getContext(), shardMBean); - for (Map.Entry entry : peerAddresses - .entrySet()) { - map.put(entry.getKey().toString(), entry.getValue()); - } + snapshotCohort = ShardSnapshotCohort.create(getContext(), builder.getId().getMemberName(), store, LOG, + this.name); - return map; + messageRetrySupport = new ShardTransactionMessageRetrySupport(this); } - public static Props props(final ShardIdentifier name, - final Map peerAddresses, - final DatastoreContext datastoreContext, final SchemaContext schemaContext) { - Preconditions.checkNotNull(name, "name should not be null"); - Preconditions.checkNotNull(peerAddresses, "peerAddresses should not be null"); - Preconditions.checkNotNull(datastoreContext, "dataStoreContext should not be null"); - Preconditions.checkNotNull(schemaContext, "schemaContext should not be null"); - - return Props.create(new ShardCreator(name, peerAddresses, datastoreContext, schemaContext)); + private void setTransactionCommitTimeout() { + transactionCommitTimeout = TimeUnit.MILLISECONDS.convert( + datastoreContext.getShardTransactionCommitTimeoutInSeconds(), TimeUnit.SECONDS) / 2; } - private Optional createRoleChangeNotifier(String shardId) { + private Optional createRoleChangeNotifier(final String shardId) { ActorRef shardRoleChangeNotifier = this.getContext().actorOf( RoleChangeNotifier.getProps(shardId), shardId + "-notifier"); - return Optional.of(shardRoleChangeNotifier); + return Optional.of(shardRoleChangeNotifier); } @Override public void postStop() { + LOG.info("Stopping Shard {}", persistenceId()); + super.postStop(); - if(txCommitTimeoutCheckSchedule != null) { + messageRetrySupport.close(); + + if (txCommitTimeoutCheckSchedule != null) { txCommitTimeoutCheckSchedule.cancel(); } + + commitCoordinator.abortPendingTransactions("Transaction aborted due to shutdown.", this); + + shardMBean.unregisterMBean(); } @Override - public void onReceiveRecover(final Object message) throws Exception { - if(LOG.isDebugEnabled()) { - LOG.debug("{}: onReceiveRecover: Received message {} from {}", persistenceId(), - message.getClass().toString(), getSender()); - } + protected void handleRecover(final Object message) { + LOG.debug("{}: onReceiveRecover: Received message {} from {}", persistenceId(), message.getClass(), + getSender()); - if (message instanceof RecoveryFailure){ - LOG.error("{}: Recovery failed because of this cause", - persistenceId(), ((RecoveryFailure) message).cause()); - - // Even though recovery failed, we still need to finish our recovery, eg send the - // ActorInitialized message and start the txCommitTimeoutCheckSchedule. - onRecoveryComplete(); - } else { - super.onReceiveRecover(message); - if(LOG.isTraceEnabled()) { - appendEntriesReplyTracker.begin(); - } + super.handleRecover(message); + if (LOG.isTraceEnabled()) { + appendEntriesReplyTracker.begin(); } } + @SuppressWarnings("checkstyle:IllegalCatch") @Override - public void onReceiveCommand(final Object message) throws Exception { + 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()); + } - MessageTracker.Context context = appendEntriesReplyTracker.received(message); + if (message instanceof RequestEnvelope) { + final long now = ticker().read(); + final RequestEnvelope envelope = (RequestEnvelope)message; - if(context.error().isPresent()){ - LOG.trace("{} : AppendEntriesReply failed to arrive at the expected interval {}", persistenceId(), - context.error()); - } - - try { - if (message.getClass().equals(CreateTransaction.SERIALIZABLE_CLASS)) { + try { + final RequestSuccess success = handleRequest(envelope, now); + if (success != null) { + envelope.sendSuccess(success, ticker().read() - now); + } + } catch (RequestException e) { + LOG.debug("{}: request {} failed", persistenceId(), envelope, e); + envelope.sendFailure(e, ticker().read() - now); + } catch (Exception e) { + LOG.debug("{}: request {} caused failure", persistenceId(), envelope, e); + envelope.sendFailure(new RuntimeRequestException("Request failed to process", e), + ticker().read() - now); + } + } else if (message instanceof ConnectClientRequest) { + handleConnectClient((ConnectClientRequest)message); + } else if (CreateTransaction.isSerializedType(message)) { handleCreateTransaction(message); + } else if (message instanceof BatchedModifications) { + handleBatchedModifications((BatchedModifications)message); } else if (message instanceof ForwardedReadyTransaction) { handleForwardedReadyTransaction((ForwardedReadyTransaction) message); - } else if (message.getClass().equals(CanCommitTransaction.SERIALIZABLE_CLASS)) { + } else if (message instanceof ReadyLocalTransaction) { + handleReadyLocalTransaction((ReadyLocalTransaction)message); + } else if (CanCommitTransaction.isSerializedType(message)) { handleCanCommitTransaction(CanCommitTransaction.fromSerializable(message)); - } else if (message.getClass().equals(CommitTransaction.SERIALIZABLE_CLASS)) { + } else if (CommitTransaction.isSerializedType(message)) { handleCommitTransaction(CommitTransaction.fromSerializable(message)); - } else if (message.getClass().equals(AbortTransaction.SERIALIZABLE_CLASS)) { + } else if (AbortTransaction.isSerializedType(message)) { handleAbortTransaction(AbortTransaction.fromSerializable(message)); - } else if (message.getClass().equals(CloseTransactionChain.SERIALIZABLE_CLASS)) { + } else if (CloseTransactionChain.isSerializedType(message)) { closeTransactionChain(CloseTransactionChain.fromSerializable(message)); } else if (message instanceof RegisterChangeListener) { - registerChangeListener((RegisterChangeListener) message); + changeSupport.onMessage((RegisterChangeListener) message, isLeader(), hasLeader()); + } else if (message instanceof RegisterDataTreeChangeListener) { + treeChangeSupport.onMessage((RegisterDataTreeChangeListener) message, isLeader(), hasLeader()); } else if (message instanceof UpdateSchemaContext) { updateSchemaContext((UpdateSchemaContext) message); } else if (message instanceof PeerAddressResolved) { PeerAddressResolved resolved = (PeerAddressResolved) message; - setPeerAddress(resolved.getPeerId().toString(), - resolved.getPeerAddress()); - } else if (message.equals(TX_COMMIT_TIMEOUT_CHECK_MESSAGE)) { - handleTransactionCommitTimeoutCheck(); + setPeerAddress(resolved.getPeerId(), resolved.getPeerAddress()); + } else if (TX_COMMIT_TIMEOUT_CHECK_MESSAGE.equals(message)) { + store.checkForExpiredTransactions(transactionCommitTimeout); + commitCoordinator.checkForExpiredTransactions(transactionCommitTimeout, this); + } else if (message instanceof DatastoreContext) { + onDatastoreContext((DatastoreContext)message); + } else if (message instanceof RegisterRoleChangeListener) { + roleChangeNotifier.get().forward(message, context()); + } else if (message instanceof FollowerInitialSyncUpStatus) { + shardMBean.setFollowerInitialSyncStatus(((FollowerInitialSyncUpStatus) message).isInitialSyncDone()); + context().parent().tell(message, self()); + } else if (GET_SHARD_MBEAN_MESSAGE.equals(message)) { + sender().tell(getShardMBean(), self()); + } else if (message instanceof GetShardDataTree) { + sender().tell(store.getDataTree(), self()); + } else if (message instanceof ServerRemoved) { + context().parent().forward(message, context()); + } else if (ShardTransactionMessageRetrySupport.TIMER_MESSAGE_CLASS.isInstance(message)) { + messageRetrySupport.onTimerMessage(message); + } else if (message instanceof DataTreeCohortActorRegistry.CohortRegistryCommand) { + store.processCohortRegistryCommand(getSender(), + (DataTreeCohortActorRegistry.CohortRegistryCommand) message); } else { - super.onReceiveCommand(message); + super.handleNonRaftCommand(message); } - } finally { - context.done(); } } - @Override - protected Optional getRoleChangeNotifier() { - return roleChangeNotifier; - } - - private void handleTransactionCommitTimeoutCheck() { - CohortEntry cohortEntry = commitCoordinator.getCurrentCohortEntry(); - if(cohortEntry != null) { - long elapsed = System.currentTimeMillis() - cohortEntry.getLastAccessTime(); - if(elapsed > transactionCommitTimeout) { - LOG.warn("{}: Current transaction {} has timed out after {} ms - aborting", - persistenceId(), cohortEntry.getTransactionID(), transactionCommitTimeout); - - doAbortTransaction(cohortEntry.getTransactionID(), null); + // Acquire our frontend tracking handle and verify generation matches + private LeaderFrontendState getFrontend(final ClientIdentifier clientId) throws RequestException { + final LeaderFrontendState existing = knownFrontends.get(clientId.getFrontendId()); + if (existing != null) { + final int cmp = Long.compareUnsigned(existing.getIdentifier().getGeneration(), clientId.getGeneration()); + if (cmp == 0) { + return existing; + } + if (cmp > 0) { + LOG.debug("{}: rejecting request from outdated client {}", persistenceId(), clientId); + throw new RetiredGenerationException(existing.getIdentifier().getGeneration()); } + + LOG.info("{}: retiring state {}, outdated by request from client {}", persistenceId(), existing, clientId); + existing.retire(); + knownFrontends.remove(clientId.getFrontendId()); + } else { + LOG.debug("{}: client {} is not yet known", persistenceId(), clientId); } - } - private void handleCommitTransaction(final CommitTransaction commit) { - final String transactionID = commit.getTransactionID(); - - LOG.debug("{}: Committing transaction {}", persistenceId(), transactionID); - - // Get the current in-progress cohort entry in the commitCoordinator if it corresponds to - // this transaction. - final CohortEntry cohortEntry = commitCoordinator.getCohortEntryIfCurrent(transactionID); - if(cohortEntry == null) { - // We're not the current Tx - the Tx was likely expired b/c it took too long in - // between the canCommit and commit messages. - IllegalStateException ex = new IllegalStateException( - String.format("%s: Cannot commit transaction %s - it is not the current transaction", - persistenceId(), transactionID)); - LOG.error(ex.getMessage()); - shardMBean.incrementFailedTransactionsCount(); - getSender().tell(new akka.actor.Status.Failure(ex), getSelf()); - return; - } - - // We perform the preCommit phase here atomically with the commit phase. This is an - // optimization to eliminate the overhead of an extra preCommit message. We lose front-end - // coordination of preCommit across shards in case of failure but preCommit should not - // normally fail since we ensure only one concurrent 3-phase commit. + final LeaderFrontendState ret = new LeaderFrontendState(persistenceId(), clientId, store); + knownFrontends.put(clientId.getFrontendId(), ret); + LOG.debug("{}: created state {} for client {}", persistenceId(), ret, clientId); + return ret; + } - try { - // We block on the future here so we don't have to worry about possibly accessing our - // state on a different thread outside of our dispatcher. Also, the data store - // currently uses a same thread executor anyway. - cohortEntry.getCohort().preCommit().get(); - - // If we do not have any followers and we are not using persistence we can - // apply modification to the state immediately - if(!hasFollowers() && !persistence().isRecoveryApplicable()){ - applyModificationToState(getSender(), transactionID, cohortEntry.getModification()); - } else { - Shard.this.persistData(getSender(), transactionID, - new ModificationPayload(cohortEntry.getModification())); + private static @Nonnull ABIVersion selectVersion(final ConnectClientRequest message) { + final Range clientRange = Range.closed(message.getMinVersion(), message.getMaxVersion()); + for (ABIVersion v : SUPPORTED_ABIVERSIONS) { + if (clientRange.contains(v)) { + return v; } - } catch (Exception e) { - LOG.error("{} An exception occurred while preCommitting transaction {}", - persistenceId(), cohortEntry.getTransactionID(), e); - shardMBean.incrementFailedTransactionsCount(); - getSender().tell(new akka.actor.Status.Failure(e), getSelf()); - } - - cohortEntry.updateLastAccessTime(); - } - - private void finishCommit(@Nonnull final ActorRef sender, final @Nonnull String 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. - - CohortEntry cohortEntry = commitCoordinator.getCohortEntryIfCurrent(transactionID); - if(cohortEntry == null) { - // The transaction is no longer the current commit. This can happen if the transaction - // was aborted prior, most likely due to timeout in the front-end. We need to finish - // committing the transaction though since it was successfully persisted and replicated - // however we can't use the original cohort b/c it was already preCommitted and may - // conflict with the current commit or may have been aborted so we commit with a new - // transaction. - cohortEntry = commitCoordinator.getAndRemoveCohortEntry(transactionID); - if(cohortEntry != null) { - commitWithNewTransaction(cohortEntry.getModification()); - sender.tell(CommitTransactionReply.INSTANCE.toSerializable(), getSelf()); - } else { - // This really shouldn't happen - it likely means that persistence or replication - // took so long to complete such that the cohort entry was expired from the cache. - IllegalStateException ex = new IllegalStateException( - String.format("%s: Could not finish committing transaction %s - no CohortEntry found", - persistenceId(), transactionID)); - LOG.error(ex.getMessage()); - sender.tell(new akka.actor.Status.Failure(ex), getSelf()); - } - - return; } - LOG.debug("{}: Finishing commit for transaction {}", persistenceId(), cohortEntry.getTransactionID()); + throw new IllegalArgumentException(String.format( + "No common version between backend versions %s and client versions %s", SUPPORTED_ABIVERSIONS, + clientRange)); + } + @SuppressWarnings("checkstyle:IllegalCatch") + private void handleConnectClient(final ConnectClientRequest message) { try { - // We block on the future here so we don't have to worry about possibly accessing our - // state on a different thread outside of our dispatcher. Also, the data store - // currently uses a same thread executor anyway. - cohortEntry.getCohort().commit().get(); - - sender.tell(CommitTransactionReply.INSTANCE.toSerializable(), getSelf()); - - shardMBean.incrementCommittedTransactionCount(); - shardMBean.setLastCommittedTransactionTime(System.currentTimeMillis()); - - } catch (Exception e) { - sender.tell(new akka.actor.Status.Failure(e), getSelf()); + if (!isLeader() || !isLeaderActive()) { + LOG.debug("{}: not currently leader, rejecting request {}", persistenceId(), message); + throw new NotLeaderException(getSelf()); + } - LOG.error("{}, An exception occurred while committing transaction {}", persistenceId(), - transactionID, e); - shardMBean.incrementFailedTransactionsCount(); - } finally { - commitCoordinator.currentTransactionComplete(transactionID, true); + final ABIVersion selectedVersion = selectVersion(message); + final LeaderFrontendState frontend = getFrontend(message.getTarget()); + frontend.reconnect(); + message.getReplyTo().tell(new ConnectClientSuccess(message.getTarget(), message.getSequence(), getSelf(), + ImmutableList.of(), store.getDataTree(), CLIENT_MAX_MESSAGES).toVersion(selectedVersion), + ActorRef.noSender()); + } catch (RequestException | RuntimeException e) { + message.getReplyTo().tell(new Failure(e), ActorRef.noSender()); + } + } + + private @Nullable RequestSuccess handleRequest(final RequestEnvelope envelope, final long now) + throws RequestException { + // We are not the leader, hence we want to fail-fast. + if (!isLeader() || !isLeaderActive()) { + LOG.debug("{}: not currently leader, rejecting request {}", persistenceId(), envelope); + throw new NotLeaderException(getSelf()); + } + + final Request request = envelope.getMessage(); + if (request instanceof TransactionRequest) { + final TransactionRequest txReq = (TransactionRequest)request; + final ClientIdentifier clientId = txReq.getTarget().getHistoryId().getClientId(); + return getFrontend(clientId).handleTransactionRequest(txReq, envelope, now); + } else if (request instanceof LocalHistoryRequest) { + final LocalHistoryRequest lhReq = (LocalHistoryRequest)request; + final ClientIdentifier clientId = lhReq.getTarget().getClientId(); + return getFrontend(clientId).handleLocalHistoryRequest(lhReq, envelope, now); + } else { + LOG.debug("{}: rejecting unsupported request {}", persistenceId(), request); + throw new UnsupportedRequestException(request); } } - private void handleCanCommitTransaction(final CanCommitTransaction canCommit) { - LOG.debug("{}: Can committing transaction {}", persistenceId(), canCommit.getTransactionID()); - commitCoordinator.handleCanCommit(canCommit, getSender(), self()); + private boolean hasLeader() { + return getLeaderId() != null; } - private void handleForwardedReadyTransaction(ForwardedReadyTransaction ready) { - LOG.debug("{}: Readying transaction {}, client version {}", persistenceId(), - ready.getTransactionID(), ready.getTxnClientVersion()); - - // This message is forwarded by the ShardTransaction on ready. We cache the cohort in the - // commitCoordinator in preparation for the subsequent three phase commit initiated by - // the front-end. - commitCoordinator.transactionReady(ready.getTransactionID(), ready.getCohort(), - ready.getModification()); - - // Return our actor path as we'll handle the three phase commit, except if the Tx client - // version < 1 (Helium-1 version). This means the Tx was initiated by a base Helium version - // node. In that case, the subsequent 3-phase commit messages won't contain the - // transactionId so to maintain backwards compatibility, we create a separate cohort actor - // to provide the compatible behavior. - ActorRef replyActorPath = self(); - if(ready.getTxnClientVersion() < DataStoreVersions.HELIUM_1_VERSION) { - LOG.debug("{}: Creating BackwardsCompatibleThreePhaseCommitCohort", persistenceId()); - replyActorPath = getContext().actorOf(BackwardsCompatibleThreePhaseCommitCohort.props( - ready.getTransactionID())); - } + public int getPendingTxCommitQueueSize() { + return store.getQueueSize(); + } - ReadyTransactionReply readyTransactionReply = new ReadyTransactionReply( - Serialization.serializedActorPath(replyActorPath)); - getSender().tell(ready.isReturnSerialized() ? readyTransactionReply.toSerializable() : - readyTransactionReply, getSelf()); + public int getCohortCacheSize() { + return commitCoordinator.getCohortCacheSize(); } - private void handleAbortTransaction(final AbortTransaction abort) { - doAbortTransaction(abort.getTransactionID(), getSender()); + @Override + protected Optional getRoleChangeNotifier() { + return roleChangeNotifier; } - void doAbortTransaction(final String transactionID, final ActorRef sender) { - final CohortEntry cohortEntry = commitCoordinator.getCohortEntryIfCurrent(transactionID); - if(cohortEntry != null) { - LOG.debug("{}: Aborting transaction {}", persistenceId(), transactionID); + @Override + protected LeaderStateChanged newLeaderStateChanged(final String memberId, final String leaderId, + final short leaderPayloadVersion) { + return isLeader() ? new ShardLeaderStateChanged(memberId, leaderId, store.getDataTree(), leaderPayloadVersion) + : new ShardLeaderStateChanged(memberId, leaderId, leaderPayloadVersion); + } - // We don't remove the cached cohort entry here (ie pass false) in case the Tx was - // aborted during replication in which case we may still commit locally if replication - // succeeds. - commitCoordinator.currentTransactionComplete(transactionID, false); + protected void onDatastoreContext(final DatastoreContext context) { + datastoreContext = context; - final ListenableFuture future = cohortEntry.getCohort().abort(); - final ActorRef self = getSelf(); + setTransactionCommitTimeout(); - Futures.addCallback(future, new FutureCallback() { - @Override - public void onSuccess(final Void v) { - shardMBean.incrementAbortTransactionsCount(); + setPersistence(datastoreContext.isPersistent()); - if(sender != null) { - sender.tell(AbortTransactionReply.INSTANCE.toSerializable(), self); - } - } + updateConfigParams(datastoreContext.getShardRaftConfig()); + } - @Override - public void onFailure(final Throwable t) { - LOG.error("{}: An exception happened during abort", persistenceId(), t); + boolean canSkipPayload() { + // If we do not have any followers and we are not using persistence we can apply modification to the state + // immediately + return !hasFollowers() && !persistence().isRecoveryApplicable(); + } - if(sender != null) { - sender.tell(new akka.actor.Status.Failure(t), self); - } - } - }); - } + // applyState() will be invoked once consensus is reached on the payload + void persistPayload(final TransactionIdentifier transactionId, final Payload payload) { + // We are faking the sender + persistData(self(), transactionId, payload); } - private void handleCreateTransaction(final Object message) { + private void handleCommitTransaction(final CommitTransaction commit) { if (isLeader()) { - createTransaction(CreateTransaction.fromSerializable(message)); - } else if (getLeader() != null) { - getLeader().forward(message, getContext()); + commitCoordinator.handleCommit(commit.getTransactionId(), getSender(), this); } else { - getSender().tell(new akka.actor.Status.Failure(new NoShardLeaderException(String.format( - "Could not find leader for shard %s so transaction cannot be created. This typically happens" + - " when the system is coming up or recovering and a leader is being elected. Try again" + - " later.", persistenceId()))), getSelf()); + 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 closeTransactionChain(final CloseTransactionChain closeTransactionChain) { - DOMStoreTransactionChain chain = - transactionChains.remove(closeTransactionChain.getTransactionChainId()); + private void handleCanCommitTransaction(final CanCommitTransaction canCommit) { + LOG.debug("{}: Can committing transaction {}", persistenceId(), canCommit.getTransactionId()); - if(chain != null) { - chain.close(); + if (isLeader()) { + commitCoordinator.handleCanCommit(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()); + } } } - private ActorRef createTypedTransactionActor(int transactionType, - ShardTransactionIdentifier transactionId, String transactionChainId, - short clientVersion ) { - - DOMStoreTransactionFactory factory = store; - - if(!transactionChainId.isEmpty()) { - factory = transactionChains.get(transactionChainId); - if(factory == null){ - DOMStoreTransactionChain transactionChain = store.createTransactionChain(); - transactionChains.put(transactionChainId, transactionChain); - factory = transactionChain; + @SuppressWarnings("checkstyle:IllegalCatch") + protected void handleBatchedModificationsLocal(final BatchedModifications batched, final ActorRef sender) { + try { + commitCoordinator.handleBatchedModifications(batched, sender, this); + } catch (Exception e) { + LOG.error("{}: Error handling BatchedModifications for Tx {}", persistenceId(), + batched.getTransactionId(), e); + sender.tell(new Failure(e), getSelf()); + } + } + + private void handleBatchedModifications(final BatchedModifications batched) { + // This message is sent to prepare the modifications transaction directly on the Shard as an + // optimization to avoid the extra overhead of a separate ShardTransaction actor. On the last + // BatchedModifications message, the caller sets the ready flag in the message indicating + // modifications are complete. The reply contains the cohort actor path (this actor) for the caller + // to initiate the 3-phase commit. This also avoids the overhead of sending an additional + // ReadyTransaction message. + + // If we're not the leader then forward to the leader. This is a safety measure - we shouldn't + // normally get here if we're not the leader as the front-end (TransactionProxy) should determine + // the primary/leader shard. However with timing and caching on the front-end, there's a small + // window where it could have a stale leader during leadership transitions. + // + boolean isLeaderActive = isLeaderActive(); + if (isLeader() && isLeaderActive) { + handleBatchedModificationsLocal(batched, getSender()); + } else { + ActorSelection leader = getLeader(); + if (!isLeaderActive || leader == null) { + messageRetrySupport.addMessageToRetry(batched, getSender(), + "Could not commit transaction " + batched.getTransactionId()); + } else { + // 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()); + } } } + } - if(this.schemaContext == null) { - throw new IllegalStateException("SchemaContext is not set"); + private boolean failIfIsolatedLeader(final ActorRef sender) { + if (isIsolatedLeader()) { + sender.tell(new Failure(new NoShardLeaderException(String.format( + "Shard %s was the leader but has lost contact with all of its followers. Either all" + + " other follower nodes are down or this node is isolated by a network partition.", + persistenceId()))), getSelf()); + return true; } - if (transactionType == TransactionProxy.TransactionType.READ_ONLY.ordinal()) { + return false; + } - shardMBean.incrementReadOnlyTransactionCount(); + protected boolean isIsolatedLeader() { + return getRaftState() == RaftState.IsolatedLeader; + } - return createShardTransaction(factory.newReadOnlyTransaction(), transactionId, clientVersion); + @SuppressWarnings("checkstyle:IllegalCatch") + private void handleReadyLocalTransaction(final ReadyLocalTransaction message) { + LOG.debug("{}: handleReadyLocalTransaction for {}", persistenceId(), message.getTransactionId()); - } else if (transactionType == TransactionProxy.TransactionType.READ_WRITE.ordinal()) { + boolean isLeaderActive = isLeaderActive(); + if (isLeader() && isLeaderActive) { + try { + commitCoordinator.handleReadyLocalTransaction(message, getSender(), this); + } catch (Exception e) { + LOG.error("{}: Error handling ReadyLocalTransaction for Tx {}", persistenceId(), + message.getTransactionId(), e); + getSender().tell(new Failure(e), getSelf()); + } + } else { + ActorSelection leader = getLeader(); + if (!isLeaderActive || leader == null) { + messageRetrySupport.addMessageToRetry(message, getSender(), + "Could not commit transaction " + message.getTransactionId()); + } else { + LOG.debug("{}: Forwarding ReadyLocalTransaction to leader {}", persistenceId(), leader); + message.setRemoteVersion(getCurrentBehavior().getLeaderPayloadVersion()); + leader.forward(message, getContext()); + } + } + } - shardMBean.incrementReadWriteTransactionCount(); + private void handleForwardedReadyTransaction(final ForwardedReadyTransaction forwardedReady) { + LOG.debug("{}: handleForwardedReadyTransaction for {}", persistenceId(), forwardedReady.getTransactionId()); - return createShardTransaction(factory.newReadWriteTransaction(), transactionId, clientVersion); + boolean isLeaderActive = isLeaderActive(); + if (isLeader() && isLeaderActive) { + commitCoordinator.handleForwardedReadyTransaction(forwardedReady, getSender(), this); + } else { + ActorSelection leader = getLeader(); + if (!isLeaderActive || leader == null) { + messageRetrySupport.addMessageToRetry(forwardedReady, getSender(), + "Could not commit transaction " + forwardedReady.getTransactionId()); + } else { + LOG.debug("{}: Forwarding ForwardedReadyTransaction to leader {}", persistenceId(), leader); + + ReadyLocalTransaction readyLocal = new ReadyLocalTransaction(forwardedReady.getTransactionId(), + forwardedReady.getTransaction().getSnapshot(), forwardedReady.isDoImmediateCommit()); + readyLocal.setRemoteVersion(getCurrentBehavior().getLeaderPayloadVersion()); + leader.forward(readyLocal, getContext()); + } + } + } - } else if (transactionType == TransactionProxy.TransactionType.WRITE_ONLY.ordinal()) { + private void handleAbortTransaction(final AbortTransaction abort) { + doAbortTransaction(abort.getTransactionId(), getSender()); + } - shardMBean.incrementWriteOnlyTransactionCount(); + void doAbortTransaction(final TransactionIdentifier transactionID, final ActorRef sender) { + commitCoordinator.handleAbort(transactionID, sender, this); + } - return createShardTransaction(factory.newWriteOnlyTransaction(), transactionId, clientVersion); + private void handleCreateTransaction(final Object message) { + if (isLeader()) { + createTransaction(CreateTransaction.fromSerializable(message)); + } else if (getLeader() != null) { + getLeader().forward(message, getContext()); } else { - throw new IllegalArgumentException( - "Shard="+name + ":CreateTransaction message has unidentified transaction type=" - + transactionType); + getSender().tell(new Failure(new NoShardLeaderException( + "Could not create a shard transaction", persistenceId())), getSelf()); } } - private ActorRef createShardTransaction(DOMStoreTransaction transaction, ShardTransactionIdentifier transactionId, - short clientVersion){ - return getContext().actorOf( - ShardTransaction.props(transaction, getSelf(), - schemaContext, datastoreContext, shardMBean, - transactionId.getRemoteTransactionId(), clientVersion) - .withDispatcher(txnDispatcherPath), - transactionId.toString()); - + private void closeTransactionChain(final CloseTransactionChain closeTransactionChain) { + store.closeTransactionChain(closeTransactionChain.getIdentifier()); } - private void createTransaction(CreateTransaction createTransaction) { + @SuppressWarnings("checkstyle:IllegalCatch") + private void createTransaction(final CreateTransaction createTransaction) { try { + if (TransactionType.fromInt(createTransaction.getTransactionType()) != TransactionType.READ_ONLY + && failIfIsolatedLeader(getSender())) { + return; + } + ActorRef transactionActor = createTransaction(createTransaction.getTransactionType(), - createTransaction.getTransactionId(), createTransaction.getTransactionChainId(), - createTransaction.getVersion()); + createTransaction.getTransactionId()); getSender().tell(new CreateTransactionReply(Serialization.serializedActorPath(transactionActor), - createTransaction.getTransactionId()).toSerializable(), getSelf()); + createTransaction.getTransactionId(), createTransaction.getVersion()).toSerializable(), getSelf()); } catch (Exception e) { - getSender().tell(new akka.actor.Status.Failure(e), getSelf()); - } - } - - private ActorRef createTransaction(int transactionType, String remoteTransactionId, - String transactionChainId, short clientVersion) { - - ShardTransactionIdentifier transactionId = - ShardTransactionIdentifier.builder() - .remoteTransactionId(remoteTransactionId) - .build(); - - if(LOG.isDebugEnabled()) { - LOG.debug("{}: Creating transaction : {} ", persistenceId(), transactionId); + getSender().tell(new Failure(e), getSelf()); } - - ActorRef transactionActor = createTypedTransactionActor(transactionType, transactionId, - transactionChainId, clientVersion); - - return transactionActor; } - private void syncCommitTransaction(final DOMStoreWriteTransaction transaction) - throws ExecutionException, InterruptedException { - DOMStoreThreePhaseCommitCohort commitCohort = transaction.ready(); - commitCohort.preCommit().get(); - commitCohort.commit().get(); - } - - private void commitWithNewTransaction(final Modification modification) { - DOMStoreWriteTransaction tx = store.newWriteOnlyTransaction(); - modification.apply(tx); - try { - syncCommitTransaction(tx); - shardMBean.incrementCommittedTransactionCount(); - shardMBean.setLastCommittedTransactionTime(System.currentTimeMillis()); - } catch (InterruptedException | ExecutionException e) { - shardMBean.incrementFailedTransactionsCount(); - LOG.error("{}: Failed to commit", persistenceId(), e); - } + private ActorRef createTransaction(final int transactionType, final TransactionIdentifier transactionId) { + LOG.debug("{}: Creating transaction : {} ", persistenceId(), transactionId); + return transactionActorFactory.newShardTransaction(TransactionType.fromInt(transactionType), + transactionId); } private void updateSchemaContext(final UpdateSchemaContext message) { - this.schemaContext = message.getSchemaContext(); updateSchemaContext(message.getSchemaContext()); - store.onGlobalContextUpdated(message.getSchemaContext()); } @VisibleForTesting void updateSchemaContext(final SchemaContext schemaContext) { - store.onGlobalContextUpdated(schemaContext); - } - - private void registerChangeListener(final RegisterChangeListener registerChangeListener) { - - LOG.debug("{}: registerDataChangeListener for {}", persistenceId(), registerChangeListener.getPath()); - - ListenerRegistration>> registration; - if(isLeader()) { - registration = doChangeListenerRegistration(registerChangeListener); - } else { - LOG.debug("{}: Shard is not the leader - delaying registration", persistenceId()); - - DelayedListenerRegistration delayedReg = - new DelayedListenerRegistration(registerChangeListener); - delayedListenerRegistrations.add(delayedReg); - registration = delayedReg; - } - - ActorRef listenerRegistration = getContext().actorOf( - DataChangeListenerRegistration.props(registration)); - - LOG.debug("{}: registerDataChangeListener sending reply, listenerRegistrationPath = {} ", - persistenceId(), listenerRegistration.path()); - - getSender().tell(new RegisterChangeListenerReply(listenerRegistration.path()), getSelf()); + store.updateSchemaContext(schemaContext); } - private ListenerRegistration>> doChangeListenerRegistration( - final RegisterChangeListener registerChangeListener) { - - ActorSelection dataChangeListenerPath = getContext().system().actorSelection( - registerChangeListener.getDataChangeListenerPath()); - - // Notify the listener if notifications should be enabled or not - // If this shard is the leader then it will enable notifications else - // it will not - dataChangeListenerPath.tell(new EnableNotification(true), getSelf()); - - // Now store a reference to the data change listener so it can be notified - // at a later point if notifications should be enabled or disabled - dataChangeListeners.add(dataChangeListenerPath); - - AsyncDataChangeListener> listener = - new DataChangeListenerProxy(dataChangeListenerPath); - - LOG.debug("{}: Registering for path {}", persistenceId(), registerChangeListener.getPath()); - - return store.registerChangeListener(registerChangeListener.getPath(), listener, - registerChangeListener.getScope()); - } - - private boolean isMetricsCaptureEnabled(){ + private boolean isMetricsCaptureEnabled() { CommonConfig config = new CommonConfig(getContext().system().settings().config()); return config.isMetricCaptureEnabled(); } @Override - protected - void startLogRecoveryBatch(final int maxBatchSize) { - currentLogRecoveryBatch = Lists.newArrayListWithCapacity(maxBatchSize); - - if(LOG.isDebugEnabled()) { - LOG.debug("{}: starting log recovery batch with max size {}", persistenceId(), maxBatchSize); - } - } - - @Override - protected void appendRecoveredLogEntry(final Payload data) { - if(data instanceof ModificationPayload) { - try { - currentLogRecoveryBatch.add(((ModificationPayload) data).getModification()); - } catch (ClassNotFoundException | IOException e) { - LOG.error("{}: Error extracting ModificationPayload", persistenceId(), e); - } - } else if (data instanceof CompositeModificationPayload) { - currentLogRecoveryBatch.add(((CompositeModificationPayload) data).getModification()); - } else if (data instanceof CompositeModificationByteStringPayload) { - currentLogRecoveryBatch.add(((CompositeModificationByteStringPayload) data).getModification()); - } else { - LOG.error("{}: Unknown state received {} during recovery", persistenceId(), data); - } + @VisibleForTesting + public RaftActorSnapshotCohort getRaftActorSnapshotCohort() { + return snapshotCohort; } @Override - protected void applyRecoverySnapshot(final byte[] snapshotBytes) { - if(recoveryCoordinator == null) { - recoveryCoordinator = new ShardRecoveryCoordinator(persistenceId(), schemaContext, - LOG, name.toString()); - } - - recoveryCoordinator.submit(snapshotBytes, store.newWriteOnlyTransaction()); - - if(LOG.isDebugEnabled()) { - LOG.debug("{}: submitted recovery sbapshot", persistenceId()); - } - } - - @Override - protected void applyCurrentLogRecoveryBatch() { - if(recoveryCoordinator == null) { - recoveryCoordinator = new ShardRecoveryCoordinator(persistenceId(), schemaContext, - LOG, name.toString()); - } - - recoveryCoordinator.submit(currentLogRecoveryBatch, store.newWriteOnlyTransaction()); - - if(LOG.isDebugEnabled()) { - LOG.debug("{}: submitted log recovery batch with size {}", persistenceId(), - currentLogRecoveryBatch.size()); - } + @Nonnull + protected RaftActorRecoveryCohort getRaftActorRecoveryCohort() { + return new ShardRecoveryCoordinator(store, + restoreFromSnapshot != null ? restoreFromSnapshot.getSnapshot() : null, persistenceId(), LOG); } @Override protected void onRecoveryComplete() { - if(recoveryCoordinator != null) { - Collection txList = recoveryCoordinator.getTransactions(); - - if(LOG.isDebugEnabled()) { - LOG.debug("{}: recovery complete - committing {} Tx's", persistenceId(), txList.size()); - } - - for(DOMStoreWriteTransaction tx: txList) { - try { - syncCommitTransaction(tx); - shardMBean.incrementCommittedTransactionCount(); - } catch (InterruptedException | ExecutionException e) { - shardMBean.incrementFailedTransactionsCount(); - LOG.error("{}: Failed to commit", persistenceId(), e); - } - } - } - - recoveryCoordinator = null; - currentLogRecoveryBatch = null; - updateJournalStats(); + restoreFromSnapshot = null; //notify shard manager getContext().parent().tell(new ActorInitialized(), getSelf()); // Being paranoid here - this method should only be called once but just in case... - if(txCommitTimeoutCheckSchedule == null) { + if (txCommitTimeoutCheckSchedule == null) { // Schedule a message to be periodically sent to check if the current in-progress // transaction should be expired and aborted. FiniteDuration period = Duration.create(transactionCommitTimeout / 3, TimeUnit.MILLISECONDS); @@ -767,179 +702,104 @@ public class Shard extends RaftActor { } @Override - protected void applyState(final ActorRef clientActor, final String identifier, final Object data) { - - if(data instanceof ModificationPayload) { + protected void applyState(final ActorRef clientActor, final Identifier identifier, final Object data) { + if (data instanceof Payload) { try { - applyModificationToState(clientActor, identifier, ((ModificationPayload) data).getModification()); - } catch (ClassNotFoundException | IOException e) { - LOG.error("{}: Error extracting ModificationPayload", persistenceId(), e); + store.applyReplicatedPayload(identifier, (Payload)data); + } catch (DataValidationFailedException | IOException e) { + LOG.error("{}: Error applying replica {}", persistenceId(), identifier, e); } - } - 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()); - } - - updateJournalStats(); - - } - - private void applyModificationToState(ActorRef clientActor, String identifier, Object modification) { - if(modification == null) { - LOG.error( - "{}: modification is null - this is very unexpected, clientActor = {}, identifier = {}", - persistenceId(), identifier, clientActor != null ? clientActor.path().toString() : null); - } else if(clientActor == null) { - // There's no clientActor to which to send a commit reply so we must be applying - // replicated state from the leader. - commitWithNewTransaction(MutableCompositeModification.fromSerializable(modification)); - } else { - // This must be the OK to commit after replication consensus. - finishCommit(clientActor, identifier); - } - } - - private void updateJournalStats() { - ReplicatedLogEntry lastLogEntry = getLastLogEntry(); - - if (lastLogEntry != null) { - shardMBean.setLastLogIndex(lastLogEntry.getIndex()); - shardMBean.setLastLogTerm(lastLogEntry.getTerm()); - } - - shardMBean.setCommitIndex(getCommitIndex()); - shardMBean.setLastApplied(getLastApplied()); - shardMBean.setInMemoryJournalDataSize(getRaftActorContext().getReplicatedLog().dataSize()); - } - - @Override - protected void createSnapshot() { - // Create a transaction actor. We are really going to treat the transaction as a worker - // so that this actor does not get block building the snapshot. THe transaction actor will - // after processing the CreateSnapshot message. - - ActorRef createSnapshotTransaction = createTransaction( - TransactionProxy.TransactionType.READ_ONLY.ordinal(), - "createSnapshot" + ++createSnapshotTransactionCounter, "", - DataStoreVersions.CURRENT_VERSION); - - createSnapshotTransaction.tell(CreateSnapshot.INSTANCE, self()); - } - - @VisibleForTesting - @Override - protected void applySnapshot(final byte[] snapshotBytes) { - // Since this will be done only on Recovery or when this actor is a Follower - // we can safely commit everything in here. We not need to worry about event notifications - // as they would have already been disabled on the follower - - LOG.info("{}: Applying snapshot", persistenceId()); - try { - DOMStoreWriteTransaction transaction = store.newWriteOnlyTransaction(); - - NormalizedNode node = SerializationUtils.deserializeNormalizedNode(snapshotBytes); - - // delete everything first - transaction.delete(DATASTORE_ROOT); - - // Add everything from the remote node back - transaction.write(DATASTORE_ROOT, node); - syncCommitTransaction(transaction); - } catch (InterruptedException | ExecutionException e) { - LOG.error("{}: An exception occurred when applying snapshot", persistenceId(), e); - } finally { - LOG.info("{}: Done applying snapshot", persistenceId()); + LOG.error("{}: Unknown state for {} received {}", persistenceId(), identifier, data); } } @Override protected void onStateChanged() { boolean isLeader = isLeader(); - for (ActorSelection dataChangeListener : dataChangeListeners) { - dataChangeListener.tell(new EnableNotification(isLeader), getSelf()); - } + boolean hasLeader = hasLeader(); + changeSupport.onLeadershipChange(isLeader, hasLeader); + treeChangeSupport.onLeadershipChange(isLeader, hasLeader); - if(isLeader) { - for(DelayedListenerRegistration reg: delayedListenerRegistrations) { - if(!reg.isClosed()) { - reg.setDelegate(doChangeListenerRegistration(reg.getRegisterChangeListener())); - } + // If this actor is no longer the leader close all the transaction chains + if (!isLeader) { + if (LOG.isDebugEnabled()) { + LOG.debug( + "{}: onStateChanged: Closing all transaction chains because shard {} is no longer the leader", + persistenceId(), getId()); } - delayedListenerRegistrations.clear(); + store.closeAllTransactionChains(); } - shardMBean.setRaftState(getRaftState().name()); - shardMBean.setCurrentTerm(getCurrentTerm()); + if (hasLeader && !isIsolatedLeader()) { + messageRetrySupport.retryMessages(); + } + } - // If this actor is no longer the leader close all the transaction chains - if(!isLeader){ - for(Map.Entry entry : transactionChains.entrySet()){ - if(LOG.isDebugEnabled()) { - LOG.debug( - "{}: onStateChanged: Closing transaction chain {} because shard {} is no longer the leader", - persistenceId(), entry.getKey(), getId()); + @Override + protected void onLeaderChanged(final String oldLeader, final String newLeader) { + shardMBean.incrementLeadershipChangeCount(); + + 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 = convertPendingTransactionsToMessages(); + + if (!messagesToForward.isEmpty()) { + LOG.debug("{}: Forwarding {} pending transaction messages to leader {}", persistenceId(), + messagesToForward.size(), leader); + + for (Object message : messagesToForward) { + leader.tell(message, self()); + } } - entry.getValue().close(); + } else { + commitCoordinator.abortPendingTransactions("The transacton was aborted due to inflight leadership " + + "change and the leader address isn't available.", this); } + } - transactionChains.clear(); + if (hasLeader && !isIsolatedLeader()) { + messageRetrySupport.retryMessages(); } } - @Override - protected DataPersistenceProvider persistence() { - return dataPersistenceProvider; + /** + * Clears all pending transactions and converts them to messages to be forwarded to a new leader. + * + * @return the converted messages + */ + public Collection convertPendingTransactionsToMessages() { + return commitCoordinator.convertPendingTransactionsToMessages( + datastoreContext.getShardBatchedModificationCount()); } - @Override protected void onLeaderChanged(final String oldLeader, final String newLeader) { - shardMBean.setLeader(newLeader); + @Override + protected void pauseLeader(final Runnable operation) { + LOG.debug("{}: In pauseLeader, operation: {}", persistenceId(), operation); + store.setRunOnPendingTransactionsComplete(operation); } - @Override public String persistenceId() { - return this.name.toString(); + @Override + public String persistenceId() { + return this.name; } @VisibleForTesting - DataPersistenceProvider getDataPersistenceProvider() { - return dataPersistenceProvider; + ShardCommitCoordinator getCommitCoordinator() { + return commitCoordinator; } - private static class ShardCreator implements Creator { - - private static final long serialVersionUID = 1L; - - final ShardIdentifier name; - final Map peerAddresses; - final DatastoreContext datastoreContext; - final SchemaContext schemaContext; - - ShardCreator(final ShardIdentifier name, final Map peerAddresses, - final DatastoreContext datastoreContext, final SchemaContext schemaContext) { - this.name = name; - this.peerAddresses = peerAddresses; - this.datastoreContext = datastoreContext; - this.schemaContext = schemaContext; - } - - @Override - public Shard create() throws Exception { - return new Shard(name, peerAddresses, datastoreContext, schemaContext); - } + public DatastoreContext getDatastoreContext() { + return datastoreContext; } @VisibleForTesting - InMemoryDOMDataStore getDataStore() { + public ShardDataTree getDataStore() { return store; } @@ -948,44 +808,126 @@ public class Shard extends RaftActor { return shardMBean; } - private static class DelayedListenerRegistration implements - ListenerRegistration>> { + public static Builder builder() { + return new Builder(); + } - private volatile boolean closed; + public abstract static class AbstractBuilder, S extends Shard> { + private final Class shardClass; + private ShardIdentifier id; + private Map peerAddresses = Collections.emptyMap(); + private DatastoreContext datastoreContext; + private SchemaContext schemaContext; + private DatastoreSnapshot.ShardSnapshot restoreFromSnapshot; + private TipProducingDataTree dataTree; + private volatile boolean sealed; - private final RegisterChangeListener registerChangeListener; + protected AbstractBuilder(final Class shardClass) { + this.shardClass = shardClass; + } - private volatile ListenerRegistration>> delegate; + protected void checkSealed() { + Preconditions.checkState(!sealed, "Builder isalready sealed - further modifications are not allowed"); + } - DelayedListenerRegistration(final RegisterChangeListener registerChangeListener) { - this.registerChangeListener = registerChangeListener; + @SuppressWarnings("unchecked") + private T self() { + return (T) this; } - void setDelegate( final ListenerRegistration>> registration) { - this.delegate = registration; + public T id(final ShardIdentifier newId) { + checkSealed(); + this.id = newId; + return self(); } - boolean isClosed() { - return closed; + public T peerAddresses(final Map newPeerAddresses) { + checkSealed(); + this.peerAddresses = newPeerAddresses; + return self(); } - RegisterChangeListener getRegisterChangeListener() { - return registerChangeListener; + public T datastoreContext(final DatastoreContext newDatastoreContext) { + checkSealed(); + this.datastoreContext = newDatastoreContext; + return self(); } - @Override - public AsyncDataChangeListener> getInstance() { - return delegate != null ? delegate.getInstance() : null; + public T schemaContext(final SchemaContext newSchemaContext) { + checkSealed(); + this.schemaContext = newSchemaContext; + return self(); } - @Override - public void close() { - closed = true; - if(delegate != null) { - delegate.close(); + public T restoreFromSnapshot(final DatastoreSnapshot.ShardSnapshot newRestoreFromSnapshot) { + checkSealed(); + this.restoreFromSnapshot = newRestoreFromSnapshot; + return self(); + } + + public T dataTree(final TipProducingDataTree newDataTree) { + checkSealed(); + this.dataTree = newDataTree; + return self(); + } + + public ShardIdentifier getId() { + return id; + } + + public Map getPeerAddresses() { + return peerAddresses; + } + + public DatastoreContext getDatastoreContext() { + return datastoreContext; + } + + public SchemaContext getSchemaContext() { + return schemaContext; + } + + public DatastoreSnapshot.ShardSnapshot getRestoreFromSnapshot() { + return restoreFromSnapshot; + } + + public TipProducingDataTree getDataTree() { + return dataTree; + } + + public TreeType getTreeType() { + switch (datastoreContext.getLogicalStoreType()) { + case CONFIGURATION: + return TreeType.CONFIGURATION; + case OPERATIONAL: + return TreeType.OPERATIONAL; + default: + throw new IllegalStateException("Unhandled logical store type " + + datastoreContext.getLogicalStoreType()); } } + + protected void verify() { + Preconditions.checkNotNull(id, "id should not be null"); + Preconditions.checkNotNull(peerAddresses, "peerAddresses should not be null"); + Preconditions.checkNotNull(datastoreContext, "dataStoreContext should not be null"); + Preconditions.checkNotNull(schemaContext, "schemaContext should not be null"); + } + + public Props props() { + sealed = true; + verify(); + return Props.create(shardClass, this); + } + } + + public static class Builder extends AbstractBuilder { + private Builder() { + super(Shard.class); + } + } + + Ticker ticker() { + return Ticker.systemTicker(); } }