2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
3 * Copyright (c) 2015 Brocade Communications Systems, Inc. and others. All rights reserved.
5 * This program and the accompanying materials are made available under the
6 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
7 * and is available at http://www.eclipse.org/legal/epl-v10.html
10 package org.opendaylight.controller.cluster.raft;
12 import akka.actor.ActorRef;
13 import akka.actor.ActorSelection;
14 import akka.actor.PoisonPill;
15 import com.google.common.annotations.VisibleForTesting;
16 import com.google.common.base.Optional;
17 import com.google.common.base.Preconditions;
18 import com.google.common.base.Verify;
19 import com.google.common.collect.Lists;
20 import java.util.Collection;
21 import java.util.HashMap;
22 import java.util.List;
24 import java.util.Objects;
25 import java.util.concurrent.TimeUnit;
26 import javax.annotation.Nonnull;
27 import javax.annotation.Nullable;
28 import org.apache.commons.lang3.time.DurationFormatUtils;
29 import org.opendaylight.controller.cluster.DataPersistenceProvider;
30 import org.opendaylight.controller.cluster.DelegatingPersistentDataProvider;
31 import org.opendaylight.controller.cluster.NonPersistentDataProvider;
32 import org.opendaylight.controller.cluster.PersistentDataProvider;
33 import org.opendaylight.controller.cluster.common.actor.AbstractUntypedPersistentActor;
34 import org.opendaylight.controller.cluster.notifications.LeaderStateChanged;
35 import org.opendaylight.controller.cluster.notifications.RoleChanged;
36 import org.opendaylight.controller.cluster.raft.base.messages.ApplyState;
37 import org.opendaylight.controller.cluster.raft.base.messages.CheckConsensusReached;
38 import org.opendaylight.controller.cluster.raft.base.messages.InitiateCaptureSnapshot;
39 import org.opendaylight.controller.cluster.raft.base.messages.LeaderTransitioning;
40 import org.opendaylight.controller.cluster.raft.base.messages.Replicate;
41 import org.opendaylight.controller.cluster.raft.base.messages.SwitchBehavior;
42 import org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader;
43 import org.opendaylight.controller.cluster.raft.behaviors.AbstractRaftActorBehavior;
44 import org.opendaylight.controller.cluster.raft.behaviors.Follower;
45 import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
46 import org.opendaylight.controller.cluster.raft.client.messages.FindLeader;
47 import org.opendaylight.controller.cluster.raft.client.messages.FindLeaderReply;
48 import org.opendaylight.controller.cluster.raft.client.messages.FollowerInfo;
49 import org.opendaylight.controller.cluster.raft.client.messages.GetOnDemandRaftState;
50 import org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState;
51 import org.opendaylight.controller.cluster.raft.client.messages.Shutdown;
52 import org.opendaylight.controller.cluster.raft.persisted.ApplyJournalEntries;
53 import org.opendaylight.controller.cluster.raft.persisted.NoopPayload;
54 import org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry;
55 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
56 import org.opendaylight.yangtools.concepts.Identifier;
57 import org.opendaylight.yangtools.concepts.Immutable;
60 * RaftActor encapsulates a state machine that needs to be kept synchronized
61 * in a cluster. It implements the RAFT algorithm as described in the paper
62 * <a href='https://ramcloud.stanford.edu/wiki/download/attachments/11370504/raft.pdf'>
63 * In Search of an Understandable Consensus Algorithm</a>
66 * RaftActor has 3 states and each state has a certain behavior associated
67 * with it. A Raft actor can behave as,
70 * <li> A Follower (or) </li>
71 * <li> A Candidate </li>
75 * A RaftActor MUST be a Leader in order to accept requests from clients to
76 * change the state of it's encapsulated state machine. Once a RaftActor becomes
77 * a Leader it is also responsible for ensuring that all followers ultimately
78 * have the same log and therefore the same state machine as itself.
81 * The current behavior of a RaftActor determines how election for leadership
82 * is initiated and how peer RaftActors react to request for votes.
85 * Each RaftActor also needs to know the current election term. It uses this
86 * information for a couple of things. One is to simply figure out who it
87 * voted for in the last election. Another is to figure out if the message
88 * it received to update it's state is stale.
91 * The RaftActor uses akka-persistence to store it's replicated log.
92 * Furthermore through it's behaviors a Raft Actor determines
94 * <li> when a log entry should be persisted </li>
95 * <li> when a log entry should be applied to the state machine (and) </li>
96 * <li> when a snapshot should be saved </li>
99 public abstract class RaftActor extends AbstractUntypedPersistentActor {
101 private static final long APPLY_STATE_DELAY_THRESHOLD_IN_NANOS = TimeUnit.MILLISECONDS.toNanos(50L); // 50 millis
104 * This context should NOT be passed directly to any other actor it is
105 * only to be consumed by the RaftActorBehaviors.
107 private final RaftActorContextImpl context;
109 private final DelegatingPersistentDataProvider delegatingPersistenceProvider;
111 private final PersistentDataProvider persistentProvider;
113 private final BehaviorStateTracker behaviorStateTracker = new BehaviorStateTracker();
115 private RaftActorRecoverySupport raftRecovery;
117 private RaftActorSnapshotMessageSupport snapshotSupport;
119 private RaftActorServerConfigurationSupport serverConfigurationSupport;
121 private RaftActorLeadershipTransferCohort leadershipTransferInProgress;
123 private boolean shuttingDown;
125 protected RaftActor(String id, Map<String, String> peerAddresses,
126 Optional<ConfigParams> configParams, short payloadVersion) {
128 persistentProvider = new PersistentDataProvider(this);
129 delegatingPersistenceProvider = new RaftActorDelegatingPersistentDataProvider(null, persistentProvider);
131 context = new RaftActorContextImpl(this.getSelf(),
132 this.getContext(), id, new ElectionTermImpl(persistentProvider, id, LOG),
133 -1, -1, peerAddresses,
134 configParams.isPresent() ? configParams.get() : new DefaultConfigParamsImpl(),
135 delegatingPersistenceProvider, LOG);
137 context.setPayloadVersion(payloadVersion);
138 context.setReplicatedLog(ReplicatedLogImpl.newInstance(context));
142 public void preStart() throws Exception {
143 LOG.info("Starting recovery for {} with journal batch size {}", persistenceId(),
144 context.getConfigParams().getJournalRecoveryLogBatchSize());
148 snapshotSupport = newRaftActorSnapshotMessageSupport();
149 serverConfigurationSupport = new RaftActorServerConfigurationSupport(this);
153 public void postStop() {
159 protected void handleRecover(Object message) {
160 if (raftRecovery == null) {
161 raftRecovery = newRaftActorRecoverySupport();
164 boolean recoveryComplete = raftRecovery.handleRecoveryMessage(message, persistentProvider);
165 if (recoveryComplete) {
166 onRecoveryComplete();
168 initializeBehavior();
174 protected RaftActorRecoverySupport newRaftActorRecoverySupport() {
175 return new RaftActorRecoverySupport(context, getRaftActorRecoveryCohort());
179 void initializeBehavior() {
180 changeCurrentBehavior(new Follower(context));
184 @SuppressWarnings("checkstyle:IllegalCatch")
185 protected void changeCurrentBehavior(RaftActorBehavior newBehavior) {
186 final RaftActorBehavior currentBehavior = getCurrentBehavior();
187 if (currentBehavior != null) {
189 currentBehavior.close();
190 } catch (Exception e) {
191 LOG.warn("{}: Error closing behavior {}", persistence(), currentBehavior, e);
195 final BehaviorState state = behaviorStateTracker.capture(currentBehavior);
196 setCurrentBehavior(newBehavior);
197 handleBehaviorChange(state, newBehavior);
201 * Method exposed for subclasses to plug-in their logic. This method is invoked by {@link #handleCommand(Object)}
202 * for messages which are not handled by this class. Subclasses overriding this class should fall back to this
203 * implementation for messages which they do not handle
205 * @param message Incoming command message
207 protected void handleNonRaftCommand(final Object message) {
214 * @deprecated This method is not final for testing purposes. DO NOT OVERRIDE IT, override
215 * {@link #handleNonRaftCommand(Object)} instead.
219 // FIXME: make this method final once our unit tests do not need to override it
220 protected void handleCommand(final Object message) {
221 if (serverConfigurationSupport.handleMessage(message, getSender())) {
224 if (snapshotSupport.handleSnapshotMessage(message, getSender())) {
228 if (message instanceof ApplyState) {
229 ApplyState applyState = (ApplyState) message;
231 long startTime = System.nanoTime();
233 if (LOG.isDebugEnabled()) {
234 LOG.debug("{}: Applying state for log index {} data {}",
235 persistenceId(), applyState.getReplicatedLogEntry().getIndex(),
236 applyState.getReplicatedLogEntry().getData());
239 if (!(applyState.getReplicatedLogEntry().getData() instanceof NoopPayload)) {
240 applyState(applyState.getClientActor(), applyState.getIdentifier(),
241 applyState.getReplicatedLogEntry().getData());
244 long elapsedTime = System.nanoTime() - startTime;
245 if (elapsedTime >= APPLY_STATE_DELAY_THRESHOLD_IN_NANOS) {
246 LOG.debug("ApplyState took more time than expected. Elapsed Time = {} ms ApplyState = {}",
247 TimeUnit.NANOSECONDS.toMillis(elapsedTime), applyState);
250 if (!hasFollowers()) {
251 // for single node, the capture should happen after the apply state
252 // as we delete messages from the persistent journal which have made it to the snapshot
253 // capturing the snapshot before applying makes the persistent journal and snapshot out of sync
254 // and recovery shows data missing
255 context.getReplicatedLog().captureSnapshotIfReady(applyState.getReplicatedLogEntry());
257 context.getSnapshotManager().trimLog(context.getLastApplied());
260 // Send it to the current behavior - some behaviors like PreLeader need to be notified of ApplyState.
261 possiblyHandleBehaviorMessage(message);
263 } else if (message instanceof ApplyJournalEntries) {
264 ApplyJournalEntries applyEntries = (ApplyJournalEntries) message;
265 LOG.debug("{}: Persisting ApplyJournalEntries with index={}", persistenceId(), applyEntries.getToIndex());
267 persistence().persistAsync(applyEntries, NoopProcedure.instance());
269 } else if (message instanceof FindLeader) {
271 new FindLeaderReply(getLeaderAddress()),
274 } else if (message instanceof GetOnDemandRaftState) {
275 onGetOnDemandRaftStats();
276 } else if (message instanceof InitiateCaptureSnapshot) {
278 } else if (message instanceof SwitchBehavior) {
279 switchBehavior((SwitchBehavior) message);
280 } else if (message instanceof LeaderTransitioning) {
281 onLeaderTransitioning((LeaderTransitioning)message);
282 } else if (message instanceof Shutdown) {
284 } else if (message instanceof Runnable) {
285 ((Runnable)message).run();
286 } else if (message instanceof NoopPayload) {
287 persistData(null, null, (NoopPayload)message, false);
288 } else if (!possiblyHandleBehaviorMessage(message)) {
289 handleNonRaftCommand(message);
293 private boolean possiblyHandleBehaviorMessage(final Object message) {
294 final RaftActorBehavior currentBehavior = getCurrentBehavior();
295 final BehaviorState state = behaviorStateTracker.capture(currentBehavior);
297 // A behavior indicates that it processed the change by returning a reference to the next behavior
298 // to be used. A null return indicates it has not processed the message and we should be passing it to
299 // the subclass for handling.
300 final RaftActorBehavior nextBehavior = currentBehavior.handleMessage(getSender(), message);
301 if (nextBehavior != null) {
302 switchBehavior(state, nextBehavior);
309 private void initiateLeadershipTransfer(final RaftActorLeadershipTransferCohort.OnComplete onComplete) {
310 LOG.debug("{}: Initiating leader transfer", persistenceId());
312 if (leadershipTransferInProgress == null) {
313 leadershipTransferInProgress = new RaftActorLeadershipTransferCohort(this);
314 leadershipTransferInProgress.addOnComplete(new RaftActorLeadershipTransferCohort.OnComplete() {
316 public void onSuccess(ActorRef raftActorRef) {
317 leadershipTransferInProgress = null;
321 public void onFailure(ActorRef raftActorRef) {
322 leadershipTransferInProgress = null;
326 leadershipTransferInProgress.addOnComplete(onComplete);
327 leadershipTransferInProgress.init();
329 LOG.debug("{}: prior leader transfer in progress - adding callback", persistenceId());
330 leadershipTransferInProgress.addOnComplete(onComplete);
334 private void onShutDown() {
335 LOG.debug("{}: onShutDown", persistenceId());
343 final RaftActorBehavior currentBehavior = context.getCurrentBehavior();
344 if (currentBehavior.state() != RaftState.Leader) {
345 // For non-leaders shutdown is a no-op
346 self().tell(PoisonPill.getInstance(), self());
350 if (context.hasFollowers()) {
351 initiateLeadershipTransfer(new RaftActorLeadershipTransferCohort.OnComplete() {
353 public void onSuccess(ActorRef raftActorRef) {
354 LOG.debug("{}: leader transfer succeeded - sending PoisonPill", persistenceId());
355 raftActorRef.tell(PoisonPill.getInstance(), raftActorRef);
359 public void onFailure(ActorRef raftActorRef) {
360 LOG.debug("{}: leader transfer failed - sending PoisonPill", persistenceId());
361 raftActorRef.tell(PoisonPill.getInstance(), raftActorRef);
365 pauseLeader(new TimedRunnable(context.getConfigParams().getElectionTimeOutInterval(), this) {
367 protected void doRun() {
368 self().tell(PoisonPill.getInstance(), self());
372 protected void doCancel() {
373 self().tell(PoisonPill.getInstance(), self());
379 private void onLeaderTransitioning(final LeaderTransitioning leaderTransitioning) {
380 LOG.debug("{}: onLeaderTransitioning: {}", persistenceId(), leaderTransitioning);
381 Optional<ActorRef> roleChangeNotifier = getRoleChangeNotifier();
382 if (getRaftState() == RaftState.Follower && roleChangeNotifier.isPresent()
383 && leaderTransitioning.getLeaderId().equals(getCurrentBehavior().getLeaderId())) {
384 roleChangeNotifier.get().tell(newLeaderStateChanged(getId(), null,
385 getCurrentBehavior().getLeaderPayloadVersion()), getSelf());
389 private void switchBehavior(SwitchBehavior message) {
390 if (!getRaftActorContext().getRaftPolicy().automaticElectionsEnabled()) {
391 RaftState newState = message.getNewState();
392 if ( newState == RaftState.Leader || newState == RaftState.Follower) {
393 switchBehavior(behaviorStateTracker.capture(getCurrentBehavior()),
394 AbstractRaftActorBehavior.createBehavior(context, message.getNewState()));
395 getRaftActorContext().getTermInformation().updateAndPersist(message.getNewTerm(), "");
397 LOG.warn("Switching to behavior : {} - not supported", newState);
402 private void switchBehavior(final BehaviorState oldBehaviorState, final RaftActorBehavior nextBehavior) {
403 setCurrentBehavior(nextBehavior);
404 handleBehaviorChange(oldBehaviorState, nextBehavior);
408 RaftActorSnapshotMessageSupport newRaftActorSnapshotMessageSupport() {
409 return new RaftActorSnapshotMessageSupport(context, getRaftActorSnapshotCohort());
412 private void onGetOnDemandRaftStats() {
413 // Debugging message to retrieve raft stats.
415 Map<String, String> peerAddresses = new HashMap<>();
416 Map<String, Boolean> peerVotingStates = new HashMap<>();
417 for (PeerInfo info: context.getPeers()) {
418 peerVotingStates.put(info.getId(), info.isVoting());
419 peerAddresses.put(info.getId(), info.getAddress() != null ? info.getAddress() : "");
422 final RaftActorBehavior currentBehavior = context.getCurrentBehavior();
423 OnDemandRaftState.Builder builder = OnDemandRaftState.builder()
424 .commitIndex(context.getCommitIndex())
425 .currentTerm(context.getTermInformation().getCurrentTerm())
426 .inMemoryJournalDataSize(replicatedLog().dataSize())
427 .inMemoryJournalLogSize(replicatedLog().size())
428 .isSnapshotCaptureInitiated(context.getSnapshotManager().isCapturing())
429 .lastApplied(context.getLastApplied())
430 .lastIndex(replicatedLog().lastIndex())
431 .lastTerm(replicatedLog().lastTerm())
432 .leader(getLeaderId())
433 .raftState(currentBehavior.state().toString())
434 .replicatedToAllIndex(currentBehavior.getReplicatedToAllIndex())
435 .snapshotIndex(replicatedLog().getSnapshotIndex())
436 .snapshotTerm(replicatedLog().getSnapshotTerm())
437 .votedFor(context.getTermInformation().getVotedFor())
438 .isVoting(context.isVotingMember())
439 .peerAddresses(peerAddresses)
440 .peerVotingStates(peerVotingStates)
441 .customRaftPolicyClassName(context.getConfigParams().getCustomRaftPolicyImplementationClass());
443 ReplicatedLogEntry lastLogEntry = replicatedLog().last();
444 if (lastLogEntry != null) {
445 builder.lastLogIndex(lastLogEntry.getIndex());
446 builder.lastLogTerm(lastLogEntry.getTerm());
449 if (getCurrentBehavior() instanceof AbstractLeader) {
450 AbstractLeader leader = (AbstractLeader)getCurrentBehavior();
451 Collection<String> followerIds = leader.getFollowerIds();
452 List<FollowerInfo> followerInfoList = Lists.newArrayListWithCapacity(followerIds.size());
453 for (String id: followerIds) {
454 final FollowerLogInformation info = leader.getFollower(id);
455 followerInfoList.add(new FollowerInfo(id, info.getNextIndex(), info.getMatchIndex(),
456 info.isFollowerActive(), DurationFormatUtils.formatDurationHMS(info.timeSinceLastActivity()),
457 context.getPeerInfo(info.getId()).isVoting()));
460 builder.followerInfoList(followerInfoList);
463 sender().tell(builder.build(), self());
467 private void handleBehaviorChange(BehaviorState oldBehaviorState, RaftActorBehavior currentBehavior) {
468 RaftActorBehavior oldBehavior = oldBehaviorState.getBehavior();
470 if (oldBehavior != currentBehavior) {
474 String lastLeaderId = oldBehavior == null ? null : oldBehaviorState.getLastLeaderId();
475 String lastValidLeaderId = oldBehavior == null ? null : oldBehaviorState.getLastValidLeaderId();
476 String oldBehaviorStateName = oldBehavior == null ? null : oldBehavior.state().name();
478 // it can happen that the state has not changed but the leader has changed.
479 Optional<ActorRef> roleChangeNotifier = getRoleChangeNotifier();
480 if (!Objects.equals(lastLeaderId, currentBehavior.getLeaderId())
481 || oldBehaviorState.getLeaderPayloadVersion() != currentBehavior.getLeaderPayloadVersion()) {
482 if (roleChangeNotifier.isPresent()) {
483 roleChangeNotifier.get().tell(newLeaderStateChanged(getId(), currentBehavior.getLeaderId(),
484 currentBehavior.getLeaderPayloadVersion()), getSelf());
487 onLeaderChanged(lastValidLeaderId, currentBehavior.getLeaderId());
489 if (leadershipTransferInProgress != null) {
490 leadershipTransferInProgress.onNewLeader(currentBehavior.getLeaderId());
493 serverConfigurationSupport.onNewLeader(currentBehavior.getLeaderId());
496 if (roleChangeNotifier.isPresent()
497 && (oldBehavior == null || oldBehavior.state() != currentBehavior.state())) {
498 roleChangeNotifier.get().tell(new RoleChanged(getId(), oldBehaviorStateName ,
499 currentBehavior.state().name()), getSelf());
503 protected LeaderStateChanged newLeaderStateChanged(String memberId, String leaderId, short leaderPayloadVersion) {
504 return new LeaderStateChanged(memberId, leaderId, leaderPayloadVersion);
508 public long snapshotSequenceNr() {
509 // When we do a snapshot capture, we also capture and save the sequence-number of the persistent journal,
510 // so that we can delete the persistent journal based on the saved sequence-number
511 // However , when akka replays the journal during recovery, it replays it from the sequence number when the
512 // snapshot was saved and not the number we saved. We would want to override it , by asking akka to use the
513 // last-sequence number known to us.
514 return context.getSnapshotManager().getLastSequenceNumber();
518 * Persists the given Payload in the journal and replicates to any followers. After successful completion,
519 * {@link #applyState(ActorRef, Identifier, Object)} is notified.
521 * @param clientActor optional ActorRef that is provided via the applyState callback
522 * @param identifier the payload identifier
523 * @param data the payload data to persist
524 * @param batchHint if true, an attempt is made to delay immediate replication and batch the payload with
525 * subsequent payloads for efficiency. Otherwise the payload is immediately replicated.
527 protected final void persistData(final ActorRef clientActor, final Identifier identifier, final Payload data,
528 final boolean batchHint) {
529 ReplicatedLogEntry replicatedLogEntry = new SimpleReplicatedLogEntry(
530 context.getReplicatedLog().lastIndex() + 1,
531 context.getTermInformation().getCurrentTerm(), data);
532 replicatedLogEntry.setPersistencePending(true);
534 LOG.debug("{}: Persist data {}", persistenceId(), replicatedLogEntry);
536 final RaftActorContext raftContext = getRaftActorContext();
538 boolean wasAppended = replicatedLog().appendAndPersist(replicatedLogEntry, persistedLogEntry -> {
539 // Clear the persistence pending flag in the log entry.
540 persistedLogEntry.setPersistencePending(false);
542 if (!hasFollowers()) {
543 // Increment the Commit Index and the Last Applied values
544 raftContext.setCommitIndex(persistedLogEntry.getIndex());
545 raftContext.setLastApplied(persistedLogEntry.getIndex());
547 // Apply the state immediately.
548 self().tell(new ApplyState(clientActor, identifier, persistedLogEntry), self());
550 // Send a ApplyJournalEntries message so that we write the fact that we applied
551 // the state to durable storage
552 self().tell(new ApplyJournalEntries(persistedLogEntry.getIndex()), self());
555 context.getReplicatedLog().captureSnapshotIfReady(replicatedLogEntry);
557 // Local persistence is complete so send the CheckConsensusReached message to the behavior (which
558 // normally should still be the leader) to check if consensus has now been reached in conjunction with
559 // follower replication.
560 getCurrentBehavior().handleMessage(getSelf(), CheckConsensusReached.INSTANCE);
564 if (wasAppended && hasFollowers()) {
565 // Send log entry for replication.
566 getCurrentBehavior().handleMessage(getSelf(), new Replicate(clientActor, identifier, replicatedLogEntry,
571 private ReplicatedLog replicatedLog() {
572 return context.getReplicatedLog();
575 protected String getId() {
576 return context.getId();
580 void setCurrentBehavior(RaftActorBehavior behavior) {
581 context.setCurrentBehavior(behavior);
584 protected RaftActorBehavior getCurrentBehavior() {
585 return context.getCurrentBehavior();
589 * Derived actors can call the isLeader method to check if the current
590 * RaftActor is the Leader or not.
592 * @return true it this RaftActor is a Leader false otherwise
594 protected boolean isLeader() {
595 return context.getId().equals(getCurrentBehavior().getLeaderId());
598 protected final boolean isLeaderActive() {
599 return getRaftState() != RaftState.IsolatedLeader && getRaftState() != RaftState.PreLeader
600 && !shuttingDown && !isLeadershipTransferInProgress();
603 private boolean isLeadershipTransferInProgress() {
604 return leadershipTransferInProgress != null && leadershipTransferInProgress.isTransferring();
608 * Derived actor can call getLeader if they need a reference to the Leader.
609 * This would be useful for example in forwarding a request to an actor
610 * which is the leader
612 * @return A reference to the leader if known, null otherwise
614 public ActorSelection getLeader() {
615 String leaderAddress = getLeaderAddress();
617 if (leaderAddress == null) {
621 return context.actorSelection(leaderAddress);
625 * Returns the id of the current leader.
627 * @return the current leader's id
629 protected final String getLeaderId() {
630 return getCurrentBehavior().getLeaderId();
634 protected final RaftState getRaftState() {
635 return getCurrentBehavior().state();
638 protected Long getCurrentTerm() {
639 return context.getTermInformation().getCurrentTerm();
642 protected RaftActorContext getRaftActorContext() {
646 protected void updateConfigParams(ConfigParams configParams) {
648 // obtain the RaftPolicy for oldConfigParams and the updated one.
649 String oldRaftPolicy = context.getConfigParams().getCustomRaftPolicyImplementationClass();
650 String newRaftPolicy = configParams.getCustomRaftPolicyImplementationClass();
652 LOG.debug("{}: RaftPolicy used with prev.config {}, RaftPolicy used with newConfig {}", persistenceId(),
653 oldRaftPolicy, newRaftPolicy);
654 context.setConfigParams(configParams);
655 if (!Objects.equals(oldRaftPolicy, newRaftPolicy)) {
656 // The RaftPolicy was modified. If the current behavior is Follower then re-initialize to Follower
657 // but transfer the previous leaderId so it doesn't immediately try to schedule an election. This
658 // avoids potential disruption. Otherwise, switch to Follower normally.
659 RaftActorBehavior behavior = getCurrentBehavior();
660 if (behavior != null && behavior.state() == RaftState.Follower) {
661 String previousLeaderId = behavior.getLeaderId();
662 short previousLeaderPayloadVersion = behavior.getLeaderPayloadVersion();
664 LOG.debug("{}: Re-initializing to Follower with previous leaderId {}", persistenceId(),
667 changeCurrentBehavior(new Follower(context, previousLeaderId, previousLeaderPayloadVersion));
669 initializeBehavior();
674 public final DataPersistenceProvider persistence() {
675 return delegatingPersistenceProvider.getDelegate();
678 public void setPersistence(DataPersistenceProvider provider) {
679 delegatingPersistenceProvider.setDelegate(provider);
682 protected void setPersistence(boolean persistent) {
683 DataPersistenceProvider currentPersistence = persistence();
684 if (persistent && (currentPersistence == null || !currentPersistence.isRecoveryApplicable())) {
685 setPersistence(new PersistentDataProvider(this));
687 if (getCurrentBehavior() != null) {
688 LOG.info("{}: Persistence has been enabled - capturing snapshot", persistenceId());
691 } else if (!persistent && (currentPersistence == null || currentPersistence.isRecoveryApplicable())) {
692 setPersistence(new NonPersistentDataProvider() {
694 * The way snapshotting works is,
696 * <li> RaftActor calls createSnapshot on the Shard
697 * <li> Shard sends a CaptureSnapshotReply and RaftActor then calls saveSnapshot
698 * <li> When saveSnapshot is invoked on the akka-persistence API it uses the SnapshotStore to save
699 * the snapshot. The SnapshotStore sends SaveSnapshotSuccess or SaveSnapshotFailure. When the
700 * RaftActor gets SaveSnapshot success it commits the snapshot to the in-memory journal. This
701 * commitSnapshot is mimicking what is done in SaveSnapshotSuccess.
705 public void saveSnapshot(Object object) {
706 // Make saving Snapshot successful
707 // Committing the snapshot here would end up calling commit in the creating state which would
708 // be a state violation. That's why now we send a message to commit the snapshot.
709 self().tell(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT, self());
716 * setPeerAddress sets the address of a known peer at a later time.
719 * This is to account for situations where a we know that a peer
720 * exists but we do not know an address up-front. This may also be used in
721 * situations where a known peer starts off in a different location and we
722 * need to change it's address
725 * Note that if the peerId does not match the list of peers passed to
726 * this actor during construction an IllegalStateException will be thrown.
728 protected void setPeerAddress(String peerId, String peerAddress) {
729 context.setPeerAddress(peerId, peerAddress);
733 * The applyState method will be called by the RaftActor when some data
734 * needs to be applied to the actor's state.
736 * @param clientActor A reference to the client who sent this message. This
737 * is the same reference that was passed to persistData
738 * by the derived actor. clientActor may be null when
739 * the RaftActor is behaving as a follower or during
741 * @param identifier The identifier of the persisted data. This is also
742 * the same identifier that was passed to persistData by
743 * the derived actor. identifier may be null when
744 * the RaftActor is behaving as a follower or during
746 * @param data A piece of data that was persisted by the persistData call.
747 * This should NEVER be null.
749 protected abstract void applyState(ActorRef clientActor, Identifier identifier, Object data);
752 * Returns the RaftActorRecoveryCohort to participate in persistence recovery.
755 protected abstract RaftActorRecoveryCohort getRaftActorRecoveryCohort();
758 * This method is called when recovery is complete.
760 protected abstract void onRecoveryComplete();
763 * Returns the RaftActorSnapshotCohort to participate in persistence recovery.
766 protected abstract RaftActorSnapshotCohort getRaftActorSnapshotCohort();
769 * This method will be called by the RaftActor when the state of the
770 * RaftActor changes. The derived actor can then use methods like
771 * isLeader or getLeader to do something useful
773 protected abstract void onStateChanged();
776 * Notifier Actor for this RaftActor to notify when a role change happens.
778 * @return ActorRef - ActorRef of the notifier or Optional.absent if none.
780 protected abstract Optional<ActorRef> getRoleChangeNotifier();
783 * This method is called prior to operations such as leadership transfer and actor shutdown when the leader
784 * must pause or stop its duties. This method allows derived classes to gracefully pause or finish current
785 * work prior to performing the operation. On completion of any work, the run method must be called on the
786 * given Runnable to proceed with the given operation. <b>Important:</b> the run method must be called on
787 * this actor's thread dispatcher as as it modifies internal state.
790 * The default implementation immediately runs the operation.
792 * @param operation the operation to run
794 protected void pauseLeader(Runnable operation) {
798 protected void onLeaderChanged(String oldLeader, String newLeader) {
801 private String getLeaderAddress() {
803 return getSelf().path().toString();
805 String leaderId = getLeaderId();
806 if (leaderId == null) {
809 String peerAddress = context.getPeerAddress(leaderId);
810 LOG.debug("{}: getLeaderAddress leaderId = {} peerAddress = {}", persistenceId(), leaderId, peerAddress);
815 protected boolean hasFollowers() {
816 return getRaftActorContext().hasFollowers();
819 private void captureSnapshot() {
820 SnapshotManager snapshotManager = context.getSnapshotManager();
822 if (!snapshotManager.isCapturing()) {
823 final long idx = getCurrentBehavior().getReplicatedToAllIndex();
824 LOG.debug("Take a snapshot of current state. lastReplicatedLog is {} and replicatedToAllIndex is {}",
825 replicatedLog().last(), idx);
827 snapshotManager.capture(replicatedLog().last(), idx);
832 * Switch this member to non-voting status. This is a no-op for all behaviors except when we are the leader,
833 * in which case we need to step down.
835 void becomeNonVoting() {
837 initiateLeadershipTransfer(new RaftActorLeadershipTransferCohort.OnComplete() {
839 public void onSuccess(ActorRef raftActorRef) {
840 LOG.debug("{}: leader transfer succeeded after change to non-voting", persistenceId());
841 ensureFollowerState();
845 public void onFailure(ActorRef raftActorRef) {
846 LOG.debug("{}: leader transfer failed after change to non-voting", persistenceId());
847 ensureFollowerState();
850 private void ensureFollowerState() {
851 // Whether or not leadership transfer succeeded, we have to step down as leader and
852 // switch to Follower so ensure that.
853 if (getRaftState() != RaftState.Follower) {
854 initializeBehavior();
862 * A point-in-time capture of {@link RaftActorBehavior} state critical for transitioning between behaviors.
864 private abstract static class BehaviorState implements Immutable {
865 @Nullable abstract RaftActorBehavior getBehavior();
867 @Nullable abstract String getLastValidLeaderId();
869 @Nullable abstract String getLastLeaderId();
871 @Nullable abstract short getLeaderPayloadVersion();
875 * A {@link BehaviorState} corresponding to non-null {@link RaftActorBehavior} state.
877 private static final class SimpleBehaviorState extends BehaviorState {
878 private final RaftActorBehavior behavior;
879 private final String lastValidLeaderId;
880 private final String lastLeaderId;
881 private final short leaderPayloadVersion;
883 SimpleBehaviorState(final String lastValidLeaderId, final String lastLeaderId,
884 final RaftActorBehavior behavior) {
885 this.lastValidLeaderId = lastValidLeaderId;
886 this.lastLeaderId = lastLeaderId;
887 this.behavior = Preconditions.checkNotNull(behavior);
888 this.leaderPayloadVersion = behavior.getLeaderPayloadVersion();
892 RaftActorBehavior getBehavior() {
897 String getLastValidLeaderId() {
898 return lastValidLeaderId;
902 short getLeaderPayloadVersion() {
903 return leaderPayloadVersion;
907 String getLastLeaderId() {
913 * Class tracking behavior-related information, which we need to keep around and pass across behavior switches.
914 * An instance is created for each RaftActor. It has two functions:
915 * - it keeps track of the last leader ID we have encountered since we have been created
916 * - it creates state capture needed to transition from one behavior to the next
918 private static final class BehaviorStateTracker {
920 * A {@link BehaviorState} corresponding to null {@link RaftActorBehavior} state. Since null behavior is only
921 * allowed before we receive the first message, we know the leader ID to be null.
923 private static final BehaviorState NULL_BEHAVIOR_STATE = new BehaviorState() {
925 RaftActorBehavior getBehavior() {
930 String getLastValidLeaderId() {
935 short getLeaderPayloadVersion() {
940 String getLastLeaderId() {
945 private String lastValidLeaderId;
946 private String lastLeaderId;
948 BehaviorState capture(final RaftActorBehavior behavior) {
949 if (behavior == null) {
950 Verify.verify(lastValidLeaderId == null, "Null behavior with non-null last leader");
951 return NULL_BEHAVIOR_STATE;
954 lastLeaderId = behavior.getLeaderId();
955 if (lastLeaderId != null) {
956 lastValidLeaderId = lastLeaderId;
959 return new SimpleBehaviorState(lastValidLeaderId, lastLeaderId, behavior);