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=d0bb3d3b69824d18b2acdb08a4defb50d31953b2;hp=bf1eb056b577ce265c1a8e6d794a3572bf469ab5;hb=26ead80b71a367f8dac348905d440d7e203e0b4f;hpb=1d947c2e75c506dd497a15e3eef61bfa65215a35 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 bf1eb056b5..d0bb3d3b69 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 @@ -10,6 +10,7 @@ package org.opendaylight.controller.cluster.datastore; import akka.actor.ActorRef; import akka.actor.ActorSelection; +import akka.actor.Cancellable; import akka.actor.PoisonPill; import akka.actor.Props; import akka.event.Logging; @@ -20,7 +21,7 @@ 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.util.concurrent.CheckedFuture; +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; @@ -28,38 +29,41 @@ import com.google.protobuf.ByteString; import com.google.protobuf.InvalidProtocolBufferException; import org.opendaylight.controller.cluster.common.actor.CommonConfig; import org.opendaylight.controller.cluster.common.actor.MeteringBehavior; +import org.opendaylight.controller.cluster.datastore.ShardCommitCoordinator.CohortEntry; 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.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.CreateTransaction; -import org.opendaylight.controller.cluster.datastore.messages.CreateTransactionChainReply; import org.opendaylight.controller.cluster.datastore.messages.CreateTransactionReply; import org.opendaylight.controller.cluster.datastore.messages.EnableNotification; -import org.opendaylight.controller.cluster.datastore.messages.ForwardedCommitTransaction; +import org.opendaylight.controller.cluster.datastore.messages.ForwardedReadyTransaction; import org.opendaylight.controller.cluster.datastore.messages.PeerAddressResolved; import org.opendaylight.controller.cluster.datastore.messages.ReadData; import org.opendaylight.controller.cluster.datastore.messages.ReadDataReply; +import org.opendaylight.controller.cluster.datastore.messages.ReadyTransactionReply; import org.opendaylight.controller.cluster.datastore.messages.RegisterChangeListener; import org.opendaylight.controller.cluster.datastore.messages.RegisterChangeListenerReply; import org.opendaylight.controller.cluster.datastore.messages.UpdateSchemaContext; import org.opendaylight.controller.cluster.datastore.modification.Modification; import org.opendaylight.controller.cluster.datastore.modification.MutableCompositeModification; import org.opendaylight.controller.cluster.datastore.node.NormalizedNodeToNodeCodec; -import org.opendaylight.controller.cluster.raft.ConfigParams; -import org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl; import org.opendaylight.controller.cluster.raft.RaftActor; import org.opendaylight.controller.cluster.raft.ReplicatedLogEntry; import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply; import org.opendaylight.controller.cluster.raft.protobuff.client.messages.CompositeModificationPayload; +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.common.api.data.ReadFailedException; import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStore; import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStoreFactory; import org.opendaylight.controller.protobuff.messages.common.NormalizedNodeMessages; -import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction; import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort; import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionChain; import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransactionFactory; @@ -68,9 +72,12 @@ 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.yang.model.api.SchemaContext; +import scala.concurrent.duration.Duration; import scala.concurrent.duration.FiniteDuration; +import javax.annotation.Nonnull; import java.util.ArrayList; +import java.util.Collection; import java.util.HashMap; import java.util.List; import java.util.Map; @@ -85,16 +92,15 @@ import java.util.concurrent.TimeUnit; */ public class Shard extends RaftActor { - private static final ConfigParams configParams = new ShardConfigParams(); + private static final Object COMMIT_TRANSACTION_REPLY = new CommitTransactionReply().toSerializable(); + + private static final Object TX_COMMIT_TIMEOUT_CHECK_MESSAGE = "txCommitTimeoutCheck"; public static final String DEFAULT_NAME = "default"; // The state of this Shard private final InMemoryDOMDataStore store; - private final Map - modificationToCohort = new HashMap<>(); - private final LoggingAdapter LOG = Logging.getLogger(getContext().system(), this); @@ -115,11 +121,26 @@ public class Shard extends RaftActor { private ActorRef createSnapshotTransaction; + private int createSnapshotTransactionCounter; + + private final ShardCommitCoordinator commitCoordinator; + + private final long transactionCommitTimeout; + + private Cancellable txCommitTimeoutCheckSchedule; + + /** + * Coordinates persistence recovery on startup. + */ + private ShardRecoveryCoordinator recoveryCoordinator; + private List currentLogRecoveryBatch; + private final Map transactionChains = new HashMap<>(); - private Shard(ShardIdentifier name, Map peerAddresses, + protected Shard(ShardIdentifier name, Map peerAddresses, DatastoreContext datastoreContext, SchemaContext schemaContext) { - super(name.toString(), mapPeerAddresses(peerAddresses), Optional.of(configParams)); + super(name.toString(), mapPeerAddresses(peerAddresses), + Optional.of(datastoreContext.getShardRaftConfig())); this.name = name; this.datastoreContext = datastoreContext; @@ -146,6 +167,12 @@ public class Shard extends RaftActor { if (isMetricsCaptureEnabled()) { getContext().become(new MeteringBehavior(this)); } + + commitCoordinator = new ShardCommitCoordinator(TimeUnit.SECONDS.convert(1, TimeUnit.MINUTES), + datastoreContext.getShardTransactionCommitQueueCapacity()); + + transactionCommitTimeout = TimeUnit.MILLISECONDS.convert( + datastoreContext.getShardTransactionCommitTimeoutInSeconds(), TimeUnit.SECONDS); } private static Map mapPeerAddresses( @@ -171,9 +198,22 @@ public class Shard extends RaftActor { return Props.create(new ShardCreator(name, peerAddresses, datastoreContext, schemaContext)); } - @Override public void onReceiveRecover(Object message) { - LOG.debug("onReceiveRecover: Received message {} from {}", message.getClass().toString(), - getSender()); + @Override + public void postStop() { + super.postStop(); + + if(txCommitTimeoutCheckSchedule != null) { + txCommitTimeoutCheckSchedule.cancel(); + } + } + + @Override + public void onReceiveRecover(Object message) { + if(LOG.isDebugEnabled()) { + LOG.debug("onReceiveRecover: Received message {} from {}", + message.getClass().toString(), + getSender()); + } if (message instanceof RecoveryFailure){ LOG.error(((RecoveryFailure) message).cause(), "Recovery failed because of this cause"); @@ -182,49 +222,241 @@ public class Shard extends RaftActor { } } - @Override public void onReceiveCommand(Object message) { - LOG.debug("onReceiveCommand: Received message {} from {}", message.getClass().toString(), - getSender()); + @Override + public void onReceiveCommand(Object message) { + if(LOG.isDebugEnabled()) { + LOG.debug("onReceiveCommand: Received message {} from {}", message, getSender()); + } if(message.getClass().equals(ReadDataReply.SERIALIZABLE_CLASS)) { - // This must be for install snapshot. Don't want to open this up and trigger - // deSerialization - self() - .tell(new CaptureSnapshotReply(ReadDataReply.getNormalizedNodeByteString(message)), - self()); - - createSnapshotTransaction = null; - // Send a PoisonPill instead of sending close transaction because we do not really need - // a response - getSender().tell(PoisonPill.getInstance(), self()); - + handleReadDataReply(message); + } else if (message.getClass().equals(CreateTransaction.SERIALIZABLE_CLASS)) { + handleCreateTransaction(message); + } else if(message instanceof ForwardedReadyTransaction) { + handleForwardedReadyTransaction((ForwardedReadyTransaction)message); + } else if(message.getClass().equals(CanCommitTransaction.SERIALIZABLE_CLASS)) { + handleCanCommitTransaction(CanCommitTransaction.fromSerializable(message)); + } else if(message.getClass().equals(CommitTransaction.SERIALIZABLE_CLASS)) { + handleCommitTransaction(CommitTransaction.fromSerializable(message)); + } else if(message.getClass().equals(AbortTransaction.SERIALIZABLE_CLASS)) { + handleAbortTransaction(AbortTransaction.fromSerializable(message)); } else if (message.getClass().equals(CloseTransactionChain.SERIALIZABLE_CLASS)){ closeTransactionChain(CloseTransactionChain.fromSerializable(message)); } else if (message instanceof RegisterChangeListener) { registerChangeListener((RegisterChangeListener) message); } else if (message instanceof UpdateSchemaContext) { updateSchemaContext((UpdateSchemaContext) message); - } else if (message instanceof ForwardedCommitTransaction) { - handleForwardedCommit((ForwardedCommitTransaction) message); - } else if (message.getClass() - .equals(CreateTransaction.SERIALIZABLE_CLASS)) { - if (isLeader()) { - createTransaction(CreateTransaction.fromSerializable(message)); - } else if (getLeader() != null) { - getLeader().forward(message, getContext()); - } else { - getSender().tell(new akka.actor.Status.Failure(new IllegalStateException( - "Could not find leader so transaction cannot be created")), getSelf()); - } } 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(); } else { super.onReceiveCommand(message); } } + private void handleTransactionCommitTimeoutCheck() { + CohortEntry cohortEntry = commitCoordinator.getCurrentCohortEntry(); + if(cohortEntry != null) { + long elapsed = System.currentTimeMillis() - cohortEntry.getLastAccessTime(); + if(elapsed > transactionCommitTimeout) { + LOG.warning("Current transaction {} has timed out after {} ms - aborting", + cohortEntry.getTransactionID(), transactionCommitTimeout); + + doAbortTransaction(cohortEntry.getTransactionID(), null); + } + } + } + + private void handleCommitTransaction(CommitTransaction commit) { + final String transactionID = commit.getTransactionID(); + + LOG.debug("Committing transaction {}", 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("Cannot commit transaction %s - it is not the current transaction", + 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. + + 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(persistent) { + Shard.this.persistData(getSender(), transactionID, + new CompositeModificationPayload(cohortEntry.getModification().toSerializable())); + } else { + Shard.this.finishCommit(getSender(), transactionID); + } + } catch (InterruptedException | ExecutionException e) { + LOG.error(e, "An exception occurred while preCommitting transaction {}", + cohortEntry.getTransactionID()); + 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(COMMIT_TRANSACTION_REPLY, 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("Could not finish committing transaction %s - no CohortEntry found", + transactionID)); + LOG.error(ex.getMessage()); + sender.tell(new akka.actor.Status.Failure(ex), getSelf()); + } + + return; + } + + LOG.debug("Finishing commit for transaction {}", cohortEntry.getTransactionID()); + + 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(COMMIT_TRANSACTION_REPLY, getSelf()); + + shardMBean.incrementCommittedTransactionCount(); + shardMBean.setLastCommittedTransactionTime(System.currentTimeMillis()); + + } catch (InterruptedException | ExecutionException e) { + sender.tell(new akka.actor.Status.Failure(e), getSelf()); + + LOG.error(e, "An exception occurred while committing transaction {}", transactionID); + shardMBean.incrementFailedTransactionsCount(); + } + + commitCoordinator.currentTransactionComplete(transactionID, true); + } + + private void handleCanCommitTransaction(CanCommitTransaction canCommit) { + LOG.debug("Can committing transaction {}", canCommit.getTransactionID()); + commitCoordinator.handleCanCommit(canCommit, getSender(), self()); + } + + private void handleForwardedReadyTransaction(ForwardedReadyTransaction ready) { + LOG.debug("Readying transaction {}", ready.getTransactionID()); + + // 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. + ReadyTransactionReply readyTransactionReply = + new ReadyTransactionReply(Serialization.serializedActorPath(self())); + getSender().tell( + ready.isReturnSerialized() ? readyTransactionReply.toSerializable() : readyTransactionReply, + getSelf()); + } + + private void handleAbortTransaction(AbortTransaction abort) { + doAbortTransaction(abort.getTransactionID(), getSender()); + } + + private void doAbortTransaction(String transactionID, final ActorRef sender) { + final CohortEntry cohortEntry = commitCoordinator.getCohortEntryIfCurrent(transactionID); + if(cohortEntry != null) { + LOG.debug("Aborting transaction {}", transactionID); + + // 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); + + final ListenableFuture future = cohortEntry.getCohort().abort(); + final ActorRef self = getSelf(); + + Futures.addCallback(future, new FutureCallback() { + @Override + public void onSuccess(Void v) { + shardMBean.incrementAbortTransactionsCount(); + + if(sender != null) { + sender.tell(new AbortTransactionReply().toSerializable(), self); + } + } + + @Override + public void onFailure(Throwable t) { + LOG.error(t, "An exception happened during abort"); + + if(sender != null) { + sender.tell(new akka.actor.Status.Failure(t), self); + } + } + }); + } + } + + private void handleCreateTransaction(Object message) { + if (isLeader()) { + createTransaction(CreateTransaction.fromSerializable(message)); + } else if (getLeader() != null) { + getLeader().forward(message, getContext()); + } else { + getSender().tell(new akka.actor.Status.Failure(new IllegalStateException( + "Could not find shard leader so transaction cannot be created. This typically happens" + + " when system is coming up or recovering and a leader is being elected. Try again" + + " later.")), getSelf()); + } + } + + private void handleReadDataReply(Object message) { + // This must be for install snapshot. Don't want to open this up and trigger + // deSerialization + + self().tell(new CaptureSnapshotReply(ReadDataReply.getNormalizedNodeByteString(message)), + self()); + + createSnapshotTransaction = null; + + // Send a PoisonPill instead of sending close transaction because we do not really need + // a response + getSender().tell(PoisonPill.getInstance(), self()); + } + private void closeTransactionChain(CloseTransactionChain closeTransactionChain) { DOMStoreTransactionChain chain = transactionChains.remove(closeTransactionChain.getTransactionChainId()); @@ -254,33 +486,33 @@ public class Shard extends RaftActor { throw new NullPointerException("schemaContext should not be null"); } - if (transactionType - == TransactionProxy.TransactionType.READ_ONLY.ordinal()) { + if (transactionType == TransactionProxy.TransactionType.READ_ONLY.ordinal()) { shardMBean.incrementReadOnlyTransactionCount(); return getContext().actorOf( ShardTransaction.props(factory.newReadOnlyTransaction(), getSelf(), - schemaContext,datastoreContext, shardMBean), transactionId.toString()); + schemaContext,datastoreContext, shardMBean, + transactionId.getRemoteTransactionId()), transactionId.toString()); - } else if (transactionType - == TransactionProxy.TransactionType.READ_WRITE.ordinal()) { + } else if (transactionType == TransactionProxy.TransactionType.READ_WRITE.ordinal()) { shardMBean.incrementReadWriteTransactionCount(); return getContext().actorOf( ShardTransaction.props(factory.newReadWriteTransaction(), getSelf(), - schemaContext, datastoreContext, shardMBean), transactionId.toString()); + schemaContext, datastoreContext, shardMBean, + transactionId.getRemoteTransactionId()), transactionId.toString()); - } else if (transactionType - == TransactionProxy.TransactionType.WRITE_ONLY.ordinal()) { + } else if (transactionType == TransactionProxy.TransactionType.WRITE_ONLY.ordinal()) { shardMBean.incrementWriteOnlyTransactionCount(); return getContext().actorOf( ShardTransaction.props(factory.newWriteOnlyTransaction(), getSelf(), - schemaContext, datastoreContext, shardMBean), transactionId.toString()); + schemaContext, datastoreContext, shardMBean, + transactionId.getRemoteTransactionId()), transactionId.toString()); } else { throw new IllegalArgumentException( "Shard="+name + ":CreateTransaction message has unidentified transaction type=" @@ -299,7 +531,9 @@ public class Shard extends RaftActor { ShardTransactionIdentifier.builder() .remoteTransactionId(remoteTransactionId) .build(); - LOG.debug("Creating transaction : {} ", transactionId); + if(LOG.isDebugEnabled()) { + LOG.debug("Creating transaction : {} ", transactionId); + } ActorRef transactionActor = createTypedTransactionActor(transactionType, transactionId, transactionChainId); @@ -319,73 +553,16 @@ public class Shard extends RaftActor { commitCohort.commit().get(); } - - private void commit(final ActorRef sender, Object serialized) { - Modification modification = MutableCompositeModification - .fromSerializable(serialized, schemaContext); - DOMStoreThreePhaseCommitCohort cohort = - modificationToCohort.remove(serialized); - if (cohort == null) { - LOG.debug( - "Could not find cohort for modification : {}. Writing modification using a new transaction", - modification); - DOMStoreWriteTransaction transaction = - store.newWriteOnlyTransaction(); - - LOG.debug("Created new transaction {}", transaction.getIdentifier().toString()); - - modification.apply(transaction); - try { - syncCommitTransaction(transaction); - } catch (InterruptedException | ExecutionException e) { - shardMBean.incrementFailedTransactionsCount(); - LOG.error("Failed to commit", e); - return; - } - //we want to just apply the recovery commit and return + private void commitWithNewTransaction(Modification modification) { + DOMStoreWriteTransaction tx = store.newWriteOnlyTransaction(); + modification.apply(tx); + try { + syncCommitTransaction(tx); shardMBean.incrementCommittedTransactionCount(); - return; - } - - - if(sender == null){ - LOG.error("Commit failed. Sender cannot be null"); - return; - } - - final ListenableFuture future = cohort.commit(); - final ActorRef self = getSelf(); - - Futures.addCallback(future, new FutureCallback() { - @Override - public void onSuccess(Void v) { - sender.tell(new CommitTransactionReply().toSerializable(), self); - shardMBean.incrementCommittedTransactionCount(); - shardMBean.setLastCommittedTransactionTime(System.currentTimeMillis()); - } - - @Override - public void onFailure(Throwable t) { - LOG.error(t, "An exception happened during commit"); - shardMBean.incrementFailedTransactionsCount(); - sender.tell(new akka.actor.Status.Failure(t), self); - } - }); - - } - - private void handleForwardedCommit(ForwardedCommitTransaction message) { - Object serializedModification = - message.getModification().toSerializable(); - - modificationToCohort - .put(serializedModification, message.getCohort()); - - if (persistent) { - this.persistData(getSender(), "identifier", - new CompositeModificationPayload(serializedModification)); - } else { - this.commit(getSender(), serializedModification); + shardMBean.setLastCommittedTransactionTime(System.currentTimeMillis()); + } catch (InterruptedException | ExecutionException e) { + shardMBean.incrementFailedTransactionsCount(); + LOG.error(e, "Failed to commit"); } } @@ -402,8 +579,10 @@ public class Shard extends RaftActor { private void registerChangeListener( RegisterChangeListener registerChangeListener) { - LOG.debug("registerDataChangeListener for {}", registerChangeListener - .getPath()); + if(LOG.isDebugEnabled()) { + LOG.debug("registerDataChangeListener for {}", registerChangeListener + .getPath()); + } ActorSelection dataChangeListenerPath = getContext() @@ -431,48 +610,133 @@ public class Shard extends RaftActor { getContext().actorOf( DataChangeListenerRegistration.props(registration)); - LOG.debug( - "registerDataChangeListener sending reply, listenerRegistrationPath = {} " - , listenerRegistration.path().toString()); + if(LOG.isDebugEnabled()) { + LOG.debug( + "registerDataChangeListener sending reply, listenerRegistrationPath = {} " + , listenerRegistration.path().toString()); + } getSender() .tell(new RegisterChangeListenerReply(listenerRegistration.path()), getSelf()); } - private void createTransactionChain() { - DOMStoreTransactionChain chain = store.createTransactionChain(); - ActorRef transactionChain = getContext().actorOf( - ShardTransactionChain.props(chain, schemaContext, datastoreContext, shardMBean)); - getSender().tell(new CreateTransactionChainReply(transactionChain.path()).toSerializable(), - getSelf()); - } - private boolean isMetricsCaptureEnabled(){ CommonConfig config = new CommonConfig(getContext().system().settings().config()); return config.isMetricCaptureEnabled(); } - @Override protected void applyState(ActorRef clientActor, String identifier, - Object data) { + @Override + protected + void startLogRecoveryBatch(int maxBatchSize) { + currentLogRecoveryBatch = Lists.newArrayListWithCapacity(maxBatchSize); + + if(LOG.isDebugEnabled()) { + LOG.debug("{} : starting log recovery batch with max size {}", persistenceId(), maxBatchSize); + } + } + @Override + protected void appendRecoveredLogEntry(Payload data) { if (data instanceof CompositeModificationPayload) { - Object modification = - ((CompositeModificationPayload) data).getModification(); + currentLogRecoveryBatch.add(((CompositeModificationPayload) data).getModification()); + } else { + LOG.error("Unknown state received {} during recovery", data); + } + } - if (modification != null) { - commit(clientActor, modification); - } else { - LOG.error( - "modification is null - this is very unexpected, clientActor = {}, identifier = {}", - identifier, clientActor.path().toString()); + @Override + protected void applyRecoverySnapshot(ByteString snapshot) { + if(recoveryCoordinator == null) { + recoveryCoordinator = new ShardRecoveryCoordinator(persistenceId(), schemaContext); + } + + recoveryCoordinator.submit(snapshot, store.newWriteOnlyTransaction()); + + if(LOG.isDebugEnabled()) { + LOG.debug("{} : submitted recovery sbapshot", persistenceId()); + } + } + + @Override + protected void applyCurrentLogRecoveryBatch() { + if(recoveryCoordinator == null) { + recoveryCoordinator = new ShardRecoveryCoordinator(persistenceId(), schemaContext); + } + + recoveryCoordinator.submit(currentLogRecoveryBatch, store.newWriteOnlyTransaction()); + + if(LOG.isDebugEnabled()) { + LOG.debug("{} : submitted log recovery batch with size {}", persistenceId(), + currentLogRecoveryBatch.size()); + } + } + + @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(e, "Failed to commit"); + } + } + } + + recoveryCoordinator = null; + currentLogRecoveryBatch = null; + updateJournalStats(); + + //notify shard manager + getContext().parent().tell(new ActorInitialized(), getSelf()); + + // 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); + txCommitTimeoutCheckSchedule = getContext().system().scheduler().schedule( + period, period, getSelf(), + TX_COMMIT_TIMEOUT_CHECK_MESSAGE, getContext().dispatcher(), ActorRef.noSender()); + } + + @Override + protected void applyState(ActorRef clientActor, String identifier, Object data) { + + if (data instanceof CompositeModificationPayload) { + Object modification = ((CompositeModificationPayload) data).getModification(); + + if(modification == null) { + LOG.error( + "modification is null - this is very unexpected, clientActor = {}, identifier = {}", + 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, schemaContext)); + } else { + // This must be the OK to commit after replication consensus. + finishCommit(clientActor, identifier); + } } else { - LOG.error("Unknown state received {} Class loader = {} CompositeNodeMod.ClassLoader = {}", data, data.getClass().getClassLoader(), CompositeModificationPayload.class.getClassLoader()); + LOG.error("Unknown state received {} Class loader = {} CompositeNodeMod.ClassLoader = {}", + data, data.getClass().getClassLoader(), + CompositeModificationPayload.class.getClassLoader()); } - // Update stats + updateJournalStats(); + + } + + private void updateJournalStats() { ReplicatedLogEntry lastLogEntry = getLastLogEntry(); if (lastLogEntry != null) { @@ -482,17 +746,17 @@ public class Shard extends RaftActor { shardMBean.setCommitIndex(getCommitIndex()); shardMBean.setLastApplied(getLastApplied()); - } - @Override protected void createSnapshot() { + @Override + protected void createSnapshot() { if (createSnapshotTransaction == null) { // Create a transaction. We are really going to treat the transaction as a worker // so that this actor does not get block building the snapshot createSnapshotTransaction = createTransaction( TransactionProxy.TransactionType.READ_ONLY.ordinal(), - "createSnapshot", ""); + "createSnapshot" + ++createSnapshotTransactionCounter, ""); createSnapshotTransaction.tell( new ReadData(YangInstanceIdentifier.builder().build()).toSerializable(), self()); @@ -500,7 +764,9 @@ public class Shard extends RaftActor { } } - @VisibleForTesting @Override protected void applySnapshot(ByteString snapshot) { + @VisibleForTesting + @Override + protected void applySnapshot(ByteString snapshot) { // 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 @@ -510,7 +776,7 @@ public class Shard extends RaftActor { DOMStoreWriteTransaction transaction = store.newWriteOnlyTransaction(); NormalizedNodeMessages.Node serializedNode = NormalizedNodeMessages.Node.parseFrom(snapshot); NormalizedNode node = new NormalizedNodeToNodeCodec(schemaContext) - .decode(YangInstanceIdentifier.builder().build(), serializedNode); + .decode(serializedNode); // delete everything first transaction.delete(YangInstanceIdentifier.builder().build()); @@ -531,14 +797,17 @@ public class Shard extends RaftActor { .tell(new EnableNotification(isLeader()), getSelf()); } - shardMBean.setRaftState(getRaftState().name()); shardMBean.setCurrentTerm(getCurrentTerm()); // If this actor is no longer the leader close all the transaction chains if(!isLeader()){ for(Map.Entry entry : transactionChains.entrySet()){ - LOG.debug("onStateChanged: Closing transaction chain {} because shard {} is no longer the leader", entry.getKey(), getId()); + if(LOG.isDebugEnabled()) { + LOG.debug( + "onStateChanged: Closing transaction chain {} because shard {} is no longer the leader", + entry.getKey(), getId()); + } entry.getValue().close(); } @@ -547,10 +816,6 @@ public class Shard extends RaftActor { } @Override protected void onLeaderChanged(String oldLeader, String newLeader) { - if((oldLeader == null && newLeader == null) || (newLeader != null && newLeader.equals(oldLeader)) ){ - return; - } - LOG.info("Current state = {}, Leader = {}", getRaftState().name(), newLeader); shardMBean.setLeader(newLeader); } @@ -558,16 +823,6 @@ public class Shard extends RaftActor { return this.name.toString(); } - - private static class ShardConfigParams extends DefaultConfigParamsImpl { - public static final FiniteDuration HEART_BEAT_INTERVAL = - new FiniteDuration(500, TimeUnit.MILLISECONDS); - - @Override public FiniteDuration getHeartBeatInterval() { - return HEART_BEAT_INTERVAL; - } - } - private static class ShardCreator implements Creator { private static final long serialVersionUID = 1L; @@ -591,26 +846,13 @@ public class Shard extends RaftActor { } } - @VisibleForTesting NormalizedNode readStore() throws ExecutionException, InterruptedException { - DOMStoreReadTransaction transaction = store.newReadOnlyTransaction(); - - CheckedFuture>, ReadFailedException> future = - transaction.read(YangInstanceIdentifier.builder().build()); - - NormalizedNode node = future.get().get(); - - transaction.close(); - - return node; + @VisibleForTesting + InMemoryDOMDataStore getDataStore() { + return store; } - @VisibleForTesting void writeToStore(YangInstanceIdentifier id, NormalizedNode node) - throws ExecutionException, InterruptedException { - DOMStoreWriteTransaction transaction = store.newWriteOnlyTransaction(); - - transaction.write(id, node); - - syncCommitTransaction(transaction); + @VisibleForTesting + ShardStats getShardMBean() { + return shardMBean; } - }