X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-akka-raft%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fraft%2Fbehaviors%2FCandidate.java;h=569f6b3d245fe5a6c1021f0537f08b3e1ec36f6e;hb=86e8e4a06b682aa772c834a2cef56d0596540e1b;hp=702417273ff586fc635ebcb65e15fa4c8bd64885;hpb=e6d2fd575fa138ec597714ad3056b5dc4761c984;p=controller.git diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/Candidate.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/Candidate.java index 702417273f..569f6b3d24 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/Candidate.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/behaviors/Candidate.java @@ -5,25 +5,29 @@ * 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 akka.actor.ActorRef; import akka.actor.ActorSelection; +import java.util.ArrayList; +import java.util.Collection; +import org.opendaylight.controller.cluster.raft.PeerInfo; 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.base.messages.ApplyState; import org.opendaylight.controller.cluster.raft.base.messages.ElectionTimeout; import org.opendaylight.controller.cluster.raft.messages.AppendEntries; import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply; import org.opendaylight.controller.cluster.raft.messages.RaftRPC; import org.opendaylight.controller.cluster.raft.messages.RequestVote; import org.opendaylight.controller.cluster.raft.messages.RequestVoteReply; - -import java.util.Set; +import scala.concurrent.duration.FiniteDuration; /** - * The behavior of a RaftActor when it is in the CandidateState - *

+ * The behavior of a RaftActor when it is in the Candidate raft state. + * + *

* Candidates (§5.2): *

*/ -public class Candidate extends AbstractRaftActorBehavior { +public final class Candidate extends AbstractRaftActorBehavior { private int voteCount; private final int votesRequired; - private final Set peers; + private final Collection votingPeers = new ArrayList<>(); - public Candidate(RaftActorContext context) { - super(context); + public Candidate(final RaftActorContext context) { + super(context, RaftState.Candidate); - peers = context.getPeerAddresses().keySet(); - - if(LOG.isDebugEnabled()) { - LOG.debug("Election:Candidate has following peers: {}", peers); + for (PeerInfo peer: context.getPeers()) { + if (peer.isVoting()) { + votingPeers.add(peer.getId()); + } } - votesRequired = getMajorityVoteCount(peers.size()); + log.debug("{}: Election: Candidate has following voting peers: {}", logName(), votingPeers); + + votesRequired = getMajorityVoteCount(votingPeers.size()); startNewTerm(); - scheduleElection(electionDuration()); + + if (votingPeers.isEmpty()) { + actor().tell(ElectionTimeout.INSTANCE, actor()); + } else { + scheduleElection(electionDuration()); + } } - @Override protected RaftActorBehavior handleAppendEntries(ActorRef sender, - AppendEntries appendEntries) { + @Override + public String getLeaderId() { + return null; + } + + @Override + public short getLeaderPayloadVersion() { + return -1; + } + + @Override + protected RaftActorBehavior handleAppendEntries(final ActorRef sender, final AppendEntries appendEntries) { + + log.debug("{}: handleAppendEntries: {}", logName(), appendEntries); - if(LOG.isDebugEnabled()) { - LOG.debug(appendEntries.toString()); + // Some other candidate for the same term became a leader and sent us an append entry + if (currentTerm() == appendEntries.getTerm()) { + log.info("{}: New Leader {} sent an AppendEntries to Candidate for term {} - will switch to Follower", + logName(), appendEntries.getLeaderId(), currentTerm()); + + return switchBehavior(new Follower(context)); } return this; } - @Override protected RaftActorBehavior handleAppendEntriesReply(ActorRef sender, - AppendEntriesReply appendEntriesReply) { - + @Override + protected RaftActorBehavior handleAppendEntriesReply(final ActorRef sender, + final AppendEntriesReply appendEntriesReply) { return this; } - @Override protected RaftActorBehavior handleRequestVoteReply(ActorRef sender, - RequestVoteReply requestVoteReply) { + @Override + protected RaftActorBehavior handleRequestVoteReply(final ActorRef sender, final RequestVoteReply requestVoteReply) { + log.debug("{}: handleRequestVoteReply: {}, current voteCount: {}", logName(), requestVoteReply, voteCount); if (requestVoteReply.isVoteGranted()) { voteCount++; } if (voteCount >= votesRequired) { - return switchBehavior(new Leader(context)); + if (context.getLastApplied() < context.getReplicatedLog().lastIndex()) { + log.info("{}: LastApplied index {} is behind last index {} - switching to PreLeader", + logName(), context.getLastApplied(), context.getReplicatedLog().lastIndex()); + return internalSwitchBehavior(RaftState.PreLeader); + } else { + return internalSwitchBehavior(RaftState.Leader); + } } return this; } - @Override public RaftState state() { - return RaftState.Candidate; + @Override + protected FiniteDuration electionDuration() { + return super.electionDuration().$div(context.getConfigParams().getCandidateElectionTimeoutDivisor()); } + @Override - public RaftActorBehavior handleMessage(ActorRef sender, Object originalMessage) { + ApplyState getApplyStateFor(final ReplicatedLogEntry entry) { + throw new IllegalStateException("A candidate should never attempt to apply " + entry); + } - Object message = fromSerializableMessage(originalMessage); + @Override + public RaftActorBehavior handleMessage(final ActorRef sender, final Object message) { + if (message instanceof ElectionTimeout) { + log.debug("{}: Received ElectionTimeout", logName()); + + if (votesRequired == 0) { + // If there are no peers then we should be a Leader + // We wait for the election timeout to occur before declare + // ourselves the leader. This gives enough time for a leader + // who we do not know about (as a peer) + // to send a message to the candidate + + return internalSwitchBehavior(RaftState.Leader); + } + + startNewTerm(); + scheduleElection(electionDuration()); + return this; + } if (message instanceof RaftRPC) { RaftRPC rpc = (RaftRPC) message; - if(LOG.isDebugEnabled()) { - LOG.debug("RaftRPC message received {} my term is {}", rpc, context.getTermInformation().getCurrentTerm()); - } + log.debug("{}: RaftRPC message received {}, my term is {}", logName(), rpc, + context.getTermInformation().getCurrentTerm()); // 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()) { - context.getTermInformation().updateAndPersist(rpc.getTerm(), null); + log.info("{}: Term {} in \"{}\" message is greater than Candidate's term {} - switching to Follower", + logName(), rpc.getTerm(), rpc, context.getTermInformation().getCurrentTerm()); - return switchBehavior(new Follower(context)); - } - } + context.getTermInformation().updateAndPersist(rpc.getTerm(), null); - if (message instanceof ElectionTimeout) { - if (votesRequired == 0) { - // If there are no peers then we should be a Leader - // We wait for the election timeout to occur before declare - // ourselves the leader. This gives enough time for a leader - // who we do not know about (as a peer) - // to send a message to the candidate + // The raft paper does not say whether or not a Candidate can/should process a RequestVote in + // this case but doing so gains quicker convergence when the sender's log is more up-to-date. + if (message instanceof RequestVote) { + super.handleMessage(sender, message); + } - return switchBehavior(new Leader(context)); + return internalSwitchBehavior(RaftState.Follower); } - startNewTerm(); - scheduleElection(electionDuration()); - return this; } return super.handleMessage(sender, message); } - private void startNewTerm() { - - // set voteCount back to 1 (that is voting for self) voteCount = 1; // Increment the election term and vote for self long currentTerm = context.getTermInformation().getCurrentTerm(); - context.getTermInformation().updateAndPersist(currentTerm + 1, - context.getId()); + long newTerm = currentTerm + 1; + context.getTermInformation().updateAndPersist(newTerm, context.getId()); - if(LOG.isDebugEnabled()) { - LOG.debug("Starting new term {}", (currentTerm + 1)); - } + log.info("{}: Starting new election term {}", logName(), newTerm); // Request for a vote // TODO: Retry request for vote if replies do not arrive in a reasonable // amount of time TBD - for (String peerId : peers) { + for (String peerId : votingPeers) { ActorSelection peerActor = context.getPeerActorSelection(peerId); - if(peerActor != null) { - peerActor.tell(new RequestVote( + if (peerActor != null) { + RequestVote requestVote = new RequestVote( context.getTermInformation().getCurrentTerm(), context.getId(), context.getReplicatedLog().lastIndex(), - context.getReplicatedLog().lastTerm()), - context.getActor() - ); - } - } + context.getReplicatedLog().lastTerm()); + log.debug("{}: Sending {} to peer {}", logName(), requestVote, peerId); + peerActor.tell(requestVote, context.getActor()); + } + } } - @Override public void close() throws Exception { + @Override + public void close() { stopElection(); } }