X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-akka-raft%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fraft%2Fbehaviors%2FAbstractLeader.java;h=0188a6df1ac387e603962d838def314a7dab1c8d;hp=15dbd74d01d9b2d3b3aed4b98fdb414b3943c5ae;hb=86e8e4a06b682aa772c834a2cef56d0596540e1b;hpb=1b1360ac337d23b9a586f62616eb278c3065eef0 diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/AbstractLeader.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/AbstractLeader.java index 15dbd74d01..0188a6df1a 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/AbstractLeader.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/AbstractLeader.java @@ -5,16 +5,16 @@ * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ - package org.opendaylight.controller.cluster.raft.behaviors; +import static java.util.Objects.requireNonNull; + import akka.actor.ActorRef; import akka.actor.ActorSelection; import akka.actor.Cancellable; import com.google.common.annotations.VisibleForTesting; -import com.google.common.base.Optional; -import com.google.common.base.Preconditions; import com.google.common.io.ByteSource; +import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; import java.io.IOException; import java.io.ObjectOutputStream; import java.util.Collection; @@ -25,9 +25,11 @@ import java.util.LinkedList; import java.util.List; import java.util.Map; import java.util.Map.Entry; +import java.util.Optional; +import java.util.OptionalInt; import java.util.Queue; import java.util.concurrent.TimeUnit; -import javax.annotation.Nullable; +import org.eclipse.jdt.annotation.Nullable; import org.opendaylight.controller.cluster.io.SharedFileBackedOutputStream; import org.opendaylight.controller.cluster.messaging.MessageSlicer; import org.opendaylight.controller.cluster.messaging.SliceOptions; @@ -39,14 +41,17 @@ import org.opendaylight.controller.cluster.raft.RaftActorContext; import org.opendaylight.controller.cluster.raft.RaftState; import org.opendaylight.controller.cluster.raft.ReplicatedLogEntry; import org.opendaylight.controller.cluster.raft.VotingState; +import org.opendaylight.controller.cluster.raft.base.messages.ApplyState; import org.opendaylight.controller.cluster.raft.base.messages.CheckConsensusReached; import org.opendaylight.controller.cluster.raft.base.messages.Replicate; import org.opendaylight.controller.cluster.raft.base.messages.SendHeartBeat; import org.opendaylight.controller.cluster.raft.base.messages.SendInstallSnapshot; import org.opendaylight.controller.cluster.raft.messages.AppendEntries; import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply; +import org.opendaylight.controller.cluster.raft.messages.IdentifiablePayload; import org.opendaylight.controller.cluster.raft.messages.InstallSnapshot; import org.opendaylight.controller.cluster.raft.messages.InstallSnapshotReply; +import org.opendaylight.controller.cluster.raft.messages.Payload; import org.opendaylight.controller.cluster.raft.messages.RaftRPC; import org.opendaylight.controller.cluster.raft.messages.RequestVote; import org.opendaylight.controller.cluster.raft.messages.RequestVoteReply; @@ -97,11 +102,11 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { private final MessageSlicer appendEntriesMessageSlicer; private Cancellable heartbeatSchedule = null; - private Optional snapshotHolder = Optional.absent(); + private Optional snapshotHolder = Optional.empty(); private int minReplicationCount; protected AbstractLeader(final RaftActorContext context, final RaftState state, - @Nullable final AbstractLeader initializeFromLeader) { + final @Nullable AbstractLeader initializeFromLeader) { super(context, state); appendEntriesMessageSlicer = MessageSlicer.builder().logContext(logName()) @@ -161,7 +166,7 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { followerToLog.remove(followerId); } - public void updateMinReplicaCount() { + public final void updateMinReplicaCount() { int numVoting = 0; for (PeerInfo peer: context.getPeers()) { if (peer.isVoting()) { @@ -184,8 +189,8 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { } @VisibleForTesting - void setSnapshotHolder(@Nullable final SnapshotHolder snapshotHolder) { - this.snapshotHolder = Optional.fromNullable(snapshotHolder); + void setSnapshotHolder(final @Nullable SnapshotHolder snapshotHolder) { + this.snapshotHolder = Optional.ofNullable(snapshotHolder); } @VisibleForTesting @@ -227,9 +232,9 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { followerLogInformation.markFollowerActive(); followerLogInformation.setPayloadVersion(appendEntriesReply.getPayloadVersion()); followerLogInformation.setRaftVersion(appendEntriesReply.getRaftVersion()); + followerLogInformation.setNeedsLeaderAddress(appendEntriesReply.isNeedsLeaderAddress()); long followerLastLogIndex = appendEntriesReply.getLogLastIndex(); - long followersLastLogTermInLeadersLog = getLogEntryTerm(followerLastLogIndex); boolean updated = false; if (appendEntriesReply.getLogLastIndex() > context.getReplicatedLog().lastIndex()) { // The follower's log is actually ahead of the leader's log. Normally this doesn't happen @@ -246,9 +251,10 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { // However in this case the log terms won't match and the logs will conflict - this is handled // elsewhere. log.info("{}: handleAppendEntriesReply: follower {} lastIndex {} is ahead of our lastIndex {} " - + "(snapshotIndex {}) - forcing install snaphot", logName(), followerLogInformation.getId(), - appendEntriesReply.getLogLastIndex(), context.getReplicatedLog().lastIndex(), - context.getReplicatedLog().getSnapshotIndex()); + + "(snapshotIndex {}, snapshotTerm {}) - forcing install snaphot", logName(), + followerLogInformation.getId(), appendEntriesReply.getLogLastIndex(), + context.getReplicatedLog().lastIndex(), context.getReplicatedLog().getSnapshotIndex(), + context.getReplicatedLog().getSnapshotTerm()); followerLogInformation.setMatchIndex(-1); followerLogInformation.setNextIndex(-1); @@ -257,6 +263,7 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { updated = true; } else if (appendEntriesReply.isSuccess()) { + long followersLastLogTermInLeadersLog = getLogEntryTerm(followerLastLogIndex); if (followerLastLogIndex >= 0 && followersLastLogTermInLeadersLog >= 0 && followersLastLogTermInLeadersLog != appendEntriesReply.getLogLastTerm()) { // The follower's last entry is present in the leader's journal but the terms don't match so the @@ -278,9 +285,12 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { updated = updateFollowerLogInformation(followerLogInformation, appendEntriesReply); } } else { - log.info("{}: handleAppendEntriesReply - received unsuccessful reply: {}, leader snapshotIndex: {}", - logName(), appendEntriesReply, context.getReplicatedLog().getSnapshotIndex()); + log.info("{}: handleAppendEntriesReply - received unsuccessful reply: {}, leader snapshotIndex: {}, " + + "snapshotTerm: {}, replicatedToAllIndex: {}", logName(), appendEntriesReply, + context.getReplicatedLog().getSnapshotIndex(), context.getReplicatedLog().getSnapshotTerm(), + getReplicatedToAllIndex()); + long followersLastLogTermInLeadersLogOrSnapshot = getLogEntryOrSnapshotTerm(followerLastLogIndex); if (appendEntriesReply.isForceInstallSnapshot()) { // Reset the followers match and next index. This is to signal that this follower has nothing // in common with this Leader and so would require a snapshot to be installed @@ -289,12 +299,11 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { // Force initiate a snapshot capture initiateCaptureSnapshot(followerId); - } else if (followerLastLogIndex < 0 || followersLastLogTermInLeadersLog >= 0 - && followersLastLogTermInLeadersLog == appendEntriesReply.getLogLastTerm()) { - // The follower's log is empty or the last entry is present in the leader's journal - // and the terms match so the follower is just behind the leader's journal from - // the last snapshot, if any. We'll catch up the follower quickly by starting at the - // follower's last log index. + } else if (followerLastLogIndex < 0 || followersLastLogTermInLeadersLogOrSnapshot >= 0 + && followersLastLogTermInLeadersLogOrSnapshot == appendEntriesReply.getLogLastTerm()) { + // The follower's log is empty or the follower's last entry is present in the leader's journal or + // snapshot and the terms match so the follower is just behind the leader's journal from the last + // snapshot, if any. We'll catch up the follower quickly by starting at the follower's last log index. updated = updateFollowerLogInformation(followerLogInformation, appendEntriesReply); @@ -302,15 +311,14 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { + "updated: matchIndex: {}, nextIndex: {}", logName(), followerId, followerLogInformation.getMatchIndex(), followerLogInformation.getNextIndex()); } else { - // The follower's log conflicts with leader's log so decrement follower's next index by 1 + // The follower's log conflicts with leader's log so decrement follower's next index // in an attempt to find where the logs match. - - if (followerLogInformation.decrNextIndex()) { + if (followerLogInformation.decrNextIndex(appendEntriesReply.getLogLastIndex())) { updated = true; log.info("{}: follower {} last log term {} conflicts with the leader's {} - dec next index to {}", logName(), followerId, appendEntriesReply.getLogLastTerm(), - followersLastLogTermInLeadersLog, followerLogInformation.getNextIndex()); + followersLastLogTermInLeadersLogOrSnapshot, followerLogInformation.getNextIndex()); } } } @@ -428,8 +436,12 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { super.performSnapshotWithoutCapture(minReplicatedToAllIndex); } - @Override - protected ClientRequestTracker removeClientRequestTracker(final long logIndex) { + /** + * Removes and returns the ClientRequestTracker for the specified log index. + * @param logIndex the log index + * @return the ClientRequestTracker or null if none available + */ + private ClientRequestTracker removeClientRequestTracker(final long logIndex) { final Iterator it = trackers.iterator(); while (it.hasNext()) { final ClientRequestTracker t = it.next(); @@ -443,27 +455,49 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { } @Override - protected RaftActorBehavior handleRequestVoteReply(final ActorRef sender, - final RequestVoteReply requestVoteReply) { + final ApplyState getApplyStateFor(final ReplicatedLogEntry entry) { + // first check whether a ClientRequestTracker exists for this entry. + // If it does that means the leader wasn't dropped before the transaction applied. + // That means that this transaction can be safely applied as a local transaction since we + // have the ClientRequestTracker. + final ClientRequestTracker tracker = removeClientRequestTracker(entry.getIndex()); + if (tracker != null) { + return new ApplyState(tracker.getClientActor(), tracker.getIdentifier(), entry); + } + + // Tracker is missing, this means that we switched behaviours between replicate and applystate + // and became the leader again,. We still want to apply this as a local modification because + // we have resumed leadership with that log entry having been committed. + final Payload payload = entry.getData(); + if (payload instanceof IdentifiablePayload) { + return new ApplyState(null, ((IdentifiablePayload) payload).getIdentifier(), entry); + } + + return new ApplyState(null, null, entry); + } + + @Override + protected RaftActorBehavior handleRequestVoteReply(final ActorRef sender, final RequestVoteReply requestVoteReply) { return this; } - protected void beforeSendHeartbeat(){} + protected void beforeSendHeartbeat() { + // No-op + } @Override public RaftActorBehavior handleMessage(final ActorRef sender, final Object message) { - Preconditions.checkNotNull(sender, "sender should not be null"); + requireNonNull(sender, "sender should not be null"); if (appendEntriesMessageSlicer.handleMessage(message)) { return this; } - if (message instanceof RaftRPC) { - RaftRPC rpc = (RaftRPC) message; + if (message instanceof RaftRPC rpc) { // If RPC request or response contains term T > currentTerm: // set currentTerm = T, convert to follower (§5.1) // This applies to all RPC messages and responses - if (rpc.getTerm() > context.getTermInformation().getCurrentTerm()) { + if (rpc.getTerm() > context.getTermInformation().getCurrentTerm() && shouldUpdateTerm(rpc)) { log.info("{}: Term {} in \"{}\" message is greater than leader's term {} - switching to Follower", logName(), rpc.getTerm(), rpc, context.getTermInformation().getCurrentTerm()); @@ -477,9 +511,9 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { // start a new election due to lack of responses. This case would only occur if there isn't a majority // of other nodes available that can elect the requesting candidate. Since we're transferring // leadership, we should make every effort to get the requesting node elected. - if (message instanceof RequestVote && context.getRaftActorLeadershipTransferCohort() != null) { + if (rpc instanceof RequestVote && context.getRaftActorLeadershipTransferCohort() != null) { log.debug("{}: Leadership transfer in progress - processing RequestVote", logName()); - super.handleMessage(sender, message); + super.handleMessage(sender, rpc); } return internalSwitchBehavior(RaftState.Follower); @@ -490,8 +524,7 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { beforeSendHeartbeat(); sendHeartBeat(); scheduleHeartBeat(context.getConfigParams().getHeartBeatInterval()); - } else if (message instanceof SendInstallSnapshot) { - SendInstallSnapshot sendInstallSnapshot = (SendInstallSnapshot) message; + } else if (message instanceof SendInstallSnapshot sendInstallSnapshot) { setSnapshotHolder(new SnapshotHolder(sendInstallSnapshot.getSnapshot(), sendInstallSnapshot.getSnapshotBytes())); sendInstallSnapshot(); @@ -508,6 +541,8 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { return this; } + @SuppressFBWarnings(value = "NP_NULL_PARAM_DEREF_ALL_TARGETS_DANGEROUS", + justification = "JDT nullness with SpotBugs at setSnapshotHolder(null)") private void handleInstallSnapshotReply(final InstallSnapshotReply reply) { log.debug("{}: handleInstallSnapshotReply: {}", logName(), reply); @@ -527,6 +562,7 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { return; } + installSnapshotState.resetChunkTimer(); followerLogInformation.markFollowerActive(); if (installSnapshotState.getChunkIndex() == reply.getChunkIndex()) { @@ -658,10 +694,19 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { LeaderInstallSnapshotState installSnapshotState = followerLogInformation.getInstallSnapshotState(); if (installSnapshotState != null) { + // if install snapshot is in process , then sent next chunk if possible - if (isFollowerActive && installSnapshotState.canSendNextChunk()) { - sendSnapshotChunk(followerActor, followerLogInformation); - } else if (sendHeartbeat) { + if (isFollowerActive) { + // 30 seconds with default settings, can be modified via heartbeat or election timeout factor + FiniteDuration snapshotReplyTimeout = context.getConfigParams().getHeartBeatInterval() + .$times(context.getConfigParams().getElectionTimeoutFactor() * 3); + + if (installSnapshotState.isChunkTimedOut(snapshotReplyTimeout)) { + sendAppendEntries = !resendSnapshotChunk(followerActor, followerLogInformation); + } else if (installSnapshotState.canSendNextChunk()) { + sendSnapshotChunk(followerActor, followerLogInformation); + } + } else if (sendHeartbeat || followerLogInformation.hasStaleCommitIndex(context.getCommitIndex())) { // we send a heartbeat even if we have not received a reply for the last chunk sendAppendEntries = true; } @@ -682,7 +727,7 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { log.debug("{}: sendAppendEntries: {} is present for follower {}", logName(), followerNextIndex, followerId); - if (followerLogInformation.okToReplicate()) { + if (followerLogInformation.okToReplicate(context.getCommitIndex())) { entries = getEntriesToSend(followerLogInformation, followerActor); sendAppendEntries = true; } @@ -710,7 +755,7 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { context.getReplicatedLog().size()); } - } else if (sendHeartbeat) { + } else if (sendHeartbeat || followerLogInformation.hasStaleCommitIndex(context.getCommitIndex())) { // we send an AppendEntries, even if the follower is inactive // in-order to update the followers timestamp, in case it becomes active again sendAppendEntries = true; @@ -736,7 +781,7 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { // If the first entry's size exceeds the max data size threshold, it will be returned from the call above. If // that is the case, then we need to slice it into smaller chunks. - if (!(entries.size() == 1 && entries.get(0).getData().size() > maxDataSize)) { + if (entries.size() != 1 || entries.get(0).getData().serializedSize() <= maxDataSize) { // Don't need to slice. return entries; } @@ -813,13 +858,15 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { AppendEntries appendEntries = new AppendEntries(currentTerm(), context.getId(), getLogEntryIndex(followerNextIndex - 1), getLogEntryTerm(followerNextIndex - 1), entries, - leaderCommitIndex, super.getReplicatedToAllIndex(), context.getPayloadVersion()); + leaderCommitIndex, super.getReplicatedToAllIndex(), context.getPayloadVersion(), + followerLogInformation.getRaftVersion(), followerLogInformation.needsLeaderAddress(getId())); if (!entries.isEmpty() || log.isTraceEnabled()) { log.debug("{}: Sending AppendEntries to follower {}: {}", logName(), followerLogInformation.getId(), appendEntries); } + followerLogInformation.setSentCommitIndex(leaderCommitIndex); followerActor.tell(appendEntries, actor()); } @@ -855,7 +902,7 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { } boolean captureInitiated = context.getSnapshotManager().captureToInstall(context.getReplicatedLog().last(), - this.getReplicatedToAllIndex(), followerId); + getReplicatedToAllIndex(), followerId); if (captureInitiated) { followerLogInfo.setLeaderInstallSnapshotState(new LeaderInstallSnapshotState( context.getConfigParams().getSnapshotChunkSize(), logName())); @@ -919,31 +966,63 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { nextSnapshotChunk.length); int nextChunkIndex = installSnapshotState.incrementChunkIndex(); - Optional serverConfig = Optional.absent(); + Optional serverConfig = Optional.empty(); if (installSnapshotState.isLastChunk(nextChunkIndex)) { - serverConfig = Optional.fromNullable(context.getPeerServerInfo(true)); + serverConfig = Optional.ofNullable(context.getPeerServerInfo(true)); } - followerActor.tell( - new InstallSnapshot(currentTerm(), context.getId(), + sendSnapshotChunk(followerActor, followerLogInfo, nextSnapshotChunk, nextChunkIndex, serverConfig); + + log.debug("{}: InstallSnapshot sent to follower {}, Chunk: {}/{}", logName(), followerActor.path(), + installSnapshotState.getChunkIndex(), installSnapshotState.getTotalChunks()); + + } catch (IOException e) { + log.warn("{}: Unable to send chunk: {}/{}. Reseting snapshot progress. Snapshot state: {}", logName(), + installSnapshotState.getChunkIndex(), installSnapshotState.getTotalChunks(), + installSnapshotState); + installSnapshotState.reset(); + } + } + } + + private void sendSnapshotChunk(final ActorSelection followerActor, final FollowerLogInformation followerLogInfo, + final byte[] snapshotChunk, final int chunkIndex, + final Optional serverConfig) { + LeaderInstallSnapshotState installSnapshotState = followerLogInfo.getInstallSnapshotState(); + + installSnapshotState.startChunkTimer(); + followerActor.tell( + new InstallSnapshot(currentTerm(), context.getId(), snapshotHolder.get().getLastIncludedIndex(), snapshotHolder.get().getLastIncludedTerm(), - nextSnapshotChunk, - nextChunkIndex, + snapshotChunk, + chunkIndex, installSnapshotState.getTotalChunks(), - Optional.of(installSnapshotState.getLastChunkHashCode()), + OptionalInt.of(installSnapshotState.getLastChunkHashCode()), serverConfig - ).toSerializable(followerLogInfo.getRaftVersion()), - actor() - ); - - } catch (IOException e) { - throw new RuntimeException(e); - } + ).toSerializable(followerLogInfo.getRaftVersion()), + actor() + ); + } - log.debug("{}: InstallSnapshot sent to follower {}, Chunk: {}/{}", logName(), followerActor.path(), - installSnapshotState.getChunkIndex(), installSnapshotState.getTotalChunks()); + private boolean resendSnapshotChunk(final ActorSelection followerActor, + final FollowerLogInformation followerLogInfo) { + if (!snapshotHolder.isPresent()) { + // Seems like we should never hit this case, but just in case we do, reset the snapshot progress so that it + // can restart from the next AppendEntries. + log.warn("{}: Attempting to resend snapshot with no snapshot holder present.", logName()); + followerLogInfo.clearLeaderInstallSnapshotState(); + return false; } + + LeaderInstallSnapshotState installSnapshotState = followerLogInfo.getInstallSnapshotState(); + // we are resending, timer needs to be reset + installSnapshotState.resetChunkTimer(); + installSnapshotState.markSendStatus(false); + + sendSnapshotChunk(followerActor, followerLogInfo); + + return true; } private void sendHeartBeat() { @@ -1043,8 +1122,8 @@ public abstract class AbstractLeader extends AbstractRaftActorBehavior { private final ByteSource snapshotBytes; SnapshotHolder(final Snapshot snapshot, final ByteSource snapshotBytes) { - this.lastIncludedTerm = snapshot.getLastAppliedTerm(); - this.lastIncludedIndex = snapshot.getLastAppliedIndex(); + lastIncludedTerm = snapshot.getLastAppliedTerm(); + lastIncludedIndex = snapshot.getLastAppliedIndex(); this.snapshotBytes = snapshotBytes; }