/* * Copyright (c) 2015 Brocade Communications Systems, Inc. and others. All rights reserved. * * This program and the accompanying materials are made available under the * 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; import akka.actor.ActorRef; import akka.actor.ActorSelection; import akka.actor.Cancellable; import com.google.common.base.Preconditions; import java.util.ArrayDeque; import java.util.ArrayList; import java.util.List; import java.util.Map; import java.util.Queue; import java.util.UUID; import javax.annotation.Nullable; import org.opendaylight.controller.cluster.raft.RaftActorLeadershipTransferCohort.OnComplete; import org.opendaylight.controller.cluster.raft.ServerConfigurationPayload.ServerInfo; import org.opendaylight.controller.cluster.raft.base.messages.ApplyState; import org.opendaylight.controller.cluster.raft.base.messages.SnapshotComplete; import org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader; import org.opendaylight.controller.cluster.raft.messages.AddServer; import org.opendaylight.controller.cluster.raft.messages.AddServerReply; import org.opendaylight.controller.cluster.raft.messages.ChangeServersVotingStatus; import org.opendaylight.controller.cluster.raft.messages.RemoveServer; import org.opendaylight.controller.cluster.raft.messages.RemoveServerReply; import org.opendaylight.controller.cluster.raft.messages.ServerChangeReply; import org.opendaylight.controller.cluster.raft.messages.ServerChangeStatus; import org.opendaylight.controller.cluster.raft.messages.ServerRemoved; import org.opendaylight.controller.cluster.raft.messages.UnInitializedFollowerSnapshotReply; import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Handles server configuration related messages for a RaftActor. * * @author Thomas Pantelis */ class RaftActorServerConfigurationSupport { private static final Logger LOG = LoggerFactory.getLogger(RaftActorServerConfigurationSupport.class); private final OperationState IDLE = new Idle(); private final RaftActor raftActor; private final RaftActorContext raftContext; private final Queue> pendingOperationsQueue = new ArrayDeque<>(); private OperationState currentOperationState = IDLE; RaftActorServerConfigurationSupport(RaftActor raftActor) { this.raftActor = raftActor; this.raftContext = raftActor.getRaftActorContext(); } boolean handleMessage(Object message, ActorRef sender) { if(message instanceof AddServer) { onAddServer((AddServer) message, sender); return true; } else if(message instanceof RemoveServer) { onRemoveServer((RemoveServer) message, sender); return true; } else if(message instanceof ChangeServersVotingStatus) { onChangeServersVotingStatus((ChangeServersVotingStatus) message, sender); return true; } else if (message instanceof ServerOperationTimeout) { currentOperationState.onServerOperationTimeout((ServerOperationTimeout) message); return true; } else if (message instanceof UnInitializedFollowerSnapshotReply) { currentOperationState.onUnInitializedFollowerSnapshotReply((UnInitializedFollowerSnapshotReply) message); return true; } else if(message instanceof ApplyState) { return onApplyState((ApplyState) message); } else if(message instanceof SnapshotComplete) { currentOperationState.onSnapshotComplete(); return false; } else { return false; } } private void onChangeServersVotingStatus(ChangeServersVotingStatus message, ActorRef sender) { LOG.debug("{}: onChangeServersVotingStatus: {}, state: {}", raftContext.getId(), message, currentOperationState); onNewOperation(new ChangeServersVotingStatusContext(message, sender)); } private void onRemoveServer(RemoveServer removeServer, ActorRef sender) { LOG.debug("{}: onRemoveServer: {}, state: {}", raftContext.getId(), removeServer, currentOperationState); boolean isSelf = removeServer.getServerId().equals(raftActor.getId()); if(isSelf && !raftContext.hasFollowers()) { sender.tell(new RemoveServerReply(ServerChangeStatus.NOT_SUPPORTED, raftActor.getLeaderId()), raftActor.getSelf()); } else if(!isSelf && !raftContext.getPeerIds().contains(removeServer.getServerId())) { sender.tell(new RemoveServerReply(ServerChangeStatus.DOES_NOT_EXIST, raftActor.getLeaderId()), raftActor.getSelf()); } else { String serverAddress = isSelf ? raftActor.self().path().toString() : raftContext.getPeerAddress(removeServer.getServerId()); onNewOperation(new RemoveServerContext(removeServer, serverAddress, sender)); } } private boolean onApplyState(ApplyState applyState) { Payload data = applyState.getReplicatedLogEntry().getData(); if(data instanceof ServerConfigurationPayload) { currentOperationState.onApplyState(applyState); return true; } return false; } /** * The algorithm for AddServer is as follows: * * If the install snapshot times out after a period of 2 * election time out * */ private void onAddServer(AddServer addServer, ActorRef sender) { LOG.debug("{}: onAddServer: {}, state: {}", raftContext.getId(), addServer, currentOperationState); onNewOperation(new AddServerContext(addServer, sender)); } private void onNewOperation(ServerOperationContext operationContext) { if (raftActor.isLeader()) { currentOperationState.onNewOperation(operationContext); } else { ActorSelection leader = raftActor.getLeader(); if (leader != null) { LOG.debug("{}: Not leader - forwarding to leader {}", raftContext.getId(), leader); leader.forward(operationContext.getOperation(), raftActor.getContext()); } else { LOG.debug("{}: No leader - returning NO_LEADER reply", raftContext.getId()); operationContext.getClientRequestor().tell(operationContext.newReply( ServerChangeStatus.NO_LEADER, null), raftActor.self()); } } } /** * Interface for the initial state for a server operation. */ private interface InitialOperationState { void initiate(); } /** * Abstract base class for a server operation FSM state. Handles common behavior for all states. */ private abstract class OperationState { void onNewOperation(ServerOperationContext operationContext) { // We're currently processing another operation so queue it to be processed later. LOG.debug("{}: Server operation already in progress - queueing {}", raftContext.getId(), operationContext.getOperation()); pendingOperationsQueue.add(operationContext); } void onServerOperationTimeout(ServerOperationTimeout timeout) { LOG.debug("onServerOperationTimeout should not be called in state {}", this); } void onUnInitializedFollowerSnapshotReply(UnInitializedFollowerSnapshotReply reply) { LOG.debug("onUnInitializedFollowerSnapshotReply was called in state {}", this); } void onApplyState(ApplyState applyState) { LOG.debug("onApplyState was called in state {}", this); } void onSnapshotComplete() { } protected void persistNewServerConfiguration(ServerOperationContext operationContext){ raftContext.setDynamicServerConfigurationInUse(); ServerConfigurationPayload payload = raftContext.getPeerServerInfo( operationContext.includeSelfInNewConfiguration(raftActor)); LOG.debug("{}: New server configuration : {}", raftContext.getId(), payload.getServerConfig()); raftActor.persistData(operationContext.getClientRequestor(), operationContext.getContextId(), payload); currentOperationState = new Persisting(operationContext, newTimer(new ServerOperationTimeout( operationContext.getLoggingContext()))); sendReply(operationContext, ServerChangeStatus.OK); } protected void operationComplete(ServerOperationContext operationContext, @Nullable ServerChangeStatus replyStatus) { if(replyStatus != null) { sendReply(operationContext, replyStatus); } operationContext.operationComplete(raftActor, replyStatus == null || replyStatus == ServerChangeStatus.OK); currentOperationState = IDLE; ServerOperationContext nextOperation = pendingOperationsQueue.poll(); if(nextOperation != null) { RaftActorServerConfigurationSupport.this.onNewOperation(nextOperation); } } protected void sendReply(ServerOperationContext operationContext, ServerChangeStatus status) { LOG.debug("{}: Returning {} for operation {}", raftContext.getId(), status, operationContext.getOperation()); operationContext.getClientRequestor().tell(operationContext.newReply(status, raftActor.getLeaderId()), raftActor.self()); } Cancellable newTimer(Object message) { return raftContext.getActorSystem().scheduler().scheduleOnce( raftContext.getConfigParams().getElectionTimeOutInterval().$times(2), raftContext.getActor(), message, raftContext.getActorSystem().dispatcher(), raftContext.getActor()); } @Override public String toString() { return getClass().getSimpleName(); } } /** * The state when no server operation is in progress. It immediately initiates new server operations. */ private final class Idle extends OperationState { @Override public void onNewOperation(ServerOperationContext operationContext) { operationContext.newInitialOperationState(RaftActorServerConfigurationSupport.this).initiate(); } @Override public void onApplyState(ApplyState applyState) { // Noop - we override b/c ApplyState is called normally for followers in the idle state. } } /** * The state when a new server configuration is being persisted and replicated. */ private final class Persisting extends OperationState { private final ServerOperationContext operationContext; private final Cancellable timer; private boolean timedOut = false; Persisting(ServerOperationContext operationContext, Cancellable timer) { this.operationContext = operationContext; this.timer = timer; } @Override public void onApplyState(ApplyState applyState) { // Sanity check - we could get an ApplyState from a previous operation that timed out so make // sure it's meant for us. if(operationContext.getContextId().equals(applyState.getIdentifier())) { LOG.info("{}: {} has been successfully replicated to a majority of followers", raftActor.getId(), applyState.getReplicatedLogEntry().getData()); timer.cancel(); operationComplete(operationContext, null); } } @Override public void onServerOperationTimeout(ServerOperationTimeout timeout) { LOG.warn("{}: Timeout occured while replicating the new server configuration for {}", raftContext.getId(), timeout.getLoggingContext()); timedOut = true; // Fail any pending operations ServerOperationContext nextOperation = pendingOperationsQueue.poll(); while(nextOperation != null) { sendReply(nextOperation, ServerChangeStatus.PRIOR_REQUEST_CONSENSUS_TIMEOUT); nextOperation = pendingOperationsQueue.poll(); } } @Override public void onNewOperation(ServerOperationContext operationContext) { if(timedOut) { sendReply(operationContext, ServerChangeStatus.PRIOR_REQUEST_CONSENSUS_TIMEOUT); } else { super.onNewOperation(operationContext); } } } /** * Abstract base class for an AddServer operation state. */ private abstract class AddServerState extends OperationState { private final AddServerContext addServerContext; AddServerState(AddServerContext addServerContext) { this.addServerContext = addServerContext; } AddServerContext getAddServerContext() { return addServerContext; } Cancellable newInstallSnapshotTimer() { return newTimer(new ServerOperationTimeout(addServerContext.getOperation().getNewServerId())); } void handleInstallSnapshotTimeout(ServerOperationTimeout timeout) { String serverId = timeout.getLoggingContext(); LOG.debug("{}: handleInstallSnapshotTimeout for new server {}", raftContext.getId(), serverId); // cleanup raftContext.removePeer(serverId); boolean isLeader = raftActor.isLeader(); if(isLeader) { AbstractLeader leader = (AbstractLeader) raftActor.getCurrentBehavior(); leader.removeFollower(serverId); } operationComplete(getAddServerContext(), isLeader ? ServerChangeStatus.TIMEOUT : ServerChangeStatus.NO_LEADER); } } /** * The initial state for the AddServer operation. It adds the new follower as a peer and initiates * snapshot capture, if necessary. */ private final class InitialAddServerState extends AddServerState implements InitialOperationState { InitialAddServerState(AddServerContext addServerContext) { super(addServerContext); } @Override public void initiate() { AbstractLeader leader = (AbstractLeader) raftActor.getCurrentBehavior(); AddServer addServer = getAddServerContext().getOperation(); LOG.debug("{}: Initiating {}", raftContext.getId(), addServer); if(raftContext.getPeerInfo(addServer.getNewServerId()) != null) { operationComplete(getAddServerContext(), ServerChangeStatus.ALREADY_EXISTS); return; } VotingState votingState = addServer.isVotingMember() ? VotingState.VOTING_NOT_INITIALIZED : VotingState.NON_VOTING; raftContext.addToPeers(addServer.getNewServerId(), addServer.getNewServerAddress(), votingState); leader.addFollower(addServer.getNewServerId()); if(votingState == VotingState.VOTING_NOT_INITIALIZED){ // schedule the install snapshot timeout timer Cancellable installSnapshotTimer = newInstallSnapshotTimer(); if(leader.initiateCaptureSnapshot(addServer.getNewServerId())) { LOG.debug("{}: Initiating capture snapshot for new server {}", raftContext.getId(), addServer.getNewServerId()); currentOperationState = new InstallingSnapshot(getAddServerContext(), installSnapshotTimer); } else { LOG.debug("{}: Snapshot already in progress - waiting for completion", raftContext.getId()); currentOperationState = new WaitingForPriorSnapshotComplete(getAddServerContext(), installSnapshotTimer); } } else { LOG.debug("{}: New follower is non-voting - directly persisting new server configuration", raftContext.getId()); persistNewServerConfiguration(getAddServerContext()); } } } /** * The AddServer operation state for when the catch-up snapshot is being installed. It handles successful * reply or timeout. */ private final class InstallingSnapshot extends AddServerState { private final Cancellable installSnapshotTimer; InstallingSnapshot(AddServerContext addServerContext, Cancellable installSnapshotTimer) { super(addServerContext); this.installSnapshotTimer = Preconditions.checkNotNull(installSnapshotTimer); } @Override public void onServerOperationTimeout(ServerOperationTimeout timeout) { handleInstallSnapshotTimeout(timeout); LOG.warn("{}: Timeout occured for new server {} while installing snapshot", raftContext.getId(), timeout.getLoggingContext()); } @Override public void onUnInitializedFollowerSnapshotReply(UnInitializedFollowerSnapshotReply reply) { LOG.debug("{}: onUnInitializedFollowerSnapshotReply: {}", raftContext.getId(), reply); String followerId = reply.getFollowerId(); // Sanity check to guard against receiving an UnInitializedFollowerSnapshotReply from a prior // add server operation that timed out. if(getAddServerContext().getOperation().getNewServerId().equals(followerId) && raftActor.isLeader()) { AbstractLeader leader = (AbstractLeader) raftActor.getCurrentBehavior(); raftContext.getPeerInfo(followerId).setVotingState(VotingState.VOTING); leader.updateMinReplicaCount(); persistNewServerConfiguration(getAddServerContext()); installSnapshotTimer.cancel(); } else { LOG.debug("{}: Dropping UnInitializedFollowerSnapshotReply for server {}: {}", raftContext.getId(), followerId, !raftActor.isLeader() ? "not leader" : "server Id doesn't match"); } } } /** * The AddServer operation state for when there is a snapshot already in progress. When the current * snapshot completes, it initiates an install snapshot. */ private final class WaitingForPriorSnapshotComplete extends AddServerState { private final Cancellable snapshotTimer; WaitingForPriorSnapshotComplete(AddServerContext addServerContext, Cancellable snapshotTimer) { super(addServerContext); this.snapshotTimer = Preconditions.checkNotNull(snapshotTimer); } @Override public void onSnapshotComplete() { LOG.debug("{}: onSnapshotComplete", raftContext.getId()); if(!raftActor.isLeader()) { LOG.debug("{}: No longer the leader", raftContext.getId()); return; } AbstractLeader leader = (AbstractLeader) raftActor.getCurrentBehavior(); if(leader.initiateCaptureSnapshot(getAddServerContext().getOperation().getNewServerId())) { LOG.debug("{}: Initiating capture snapshot for new server {}", raftContext.getId(), getAddServerContext().getOperation().getNewServerId()); currentOperationState = new InstallingSnapshot(getAddServerContext(), newInstallSnapshotTimer()); snapshotTimer.cancel(); } } @Override public void onServerOperationTimeout(ServerOperationTimeout timeout) { handleInstallSnapshotTimeout(timeout); LOG.warn("{}: Timeout occured for new server {} while waiting for prior snapshot to complete", raftContext.getId(), timeout.getLoggingContext()); } } /** * Stores context information for a server operation. * * @param the operation type */ private static abstract class ServerOperationContext { private final T operation; private final ActorRef clientRequestor; private final String contextId; ServerOperationContext(T operation, ActorRef clientRequestor){ this.operation = operation; this.clientRequestor = clientRequestor; contextId = UUID.randomUUID().toString(); } String getContextId() { return contextId; } T getOperation() { return operation; } ActorRef getClientRequestor() { return clientRequestor; } void operationComplete(RaftActor raftActor, boolean succeeded) { } boolean includeSelfInNewConfiguration(RaftActor raftActor) { return true; } abstract Object newReply(ServerChangeStatus status, String leaderId); abstract InitialOperationState newInitialOperationState(RaftActorServerConfigurationSupport support); abstract String getLoggingContext(); } /** * Stores context information for an AddServer operation. */ private static class AddServerContext extends ServerOperationContext { AddServerContext(AddServer addServer, ActorRef clientRequestor) { super(addServer, clientRequestor); } @Override Object newReply(ServerChangeStatus status, String leaderId) { return new AddServerReply(status, leaderId); } @Override InitialOperationState newInitialOperationState(RaftActorServerConfigurationSupport support) { return support.new InitialAddServerState(this); } @Override String getLoggingContext() { return getOperation().getNewServerId(); } } private abstract class RemoveServerState extends OperationState { private final RemoveServerContext removeServerContext; protected RemoveServerState(RemoveServerContext removeServerContext) { this.removeServerContext = Preconditions.checkNotNull(removeServerContext); } public RemoveServerContext getRemoveServerContext() { return removeServerContext; } } private final class InitialRemoveServerState extends RemoveServerState implements InitialOperationState{ protected InitialRemoveServerState(RemoveServerContext removeServerContext) { super(removeServerContext); } @Override public void initiate() { String serverId = getRemoveServerContext().getOperation().getServerId(); raftContext.removePeer(serverId); ((AbstractLeader)raftActor.getCurrentBehavior()).removeFollower(serverId); persistNewServerConfiguration(getRemoveServerContext()); } } private static class RemoveServerContext extends ServerOperationContext { private final String peerAddress; RemoveServerContext(RemoveServer operation, String peerAddress, ActorRef clientRequestor) { super(operation, clientRequestor); this.peerAddress = peerAddress; } @Override Object newReply(ServerChangeStatus status, String leaderId) { return new RemoveServerReply(status, leaderId); } @Override InitialOperationState newInitialOperationState(RaftActorServerConfigurationSupport support) { return support.new InitialRemoveServerState(this); } @Override void operationComplete(RaftActor raftActor, boolean succeeded) { if(peerAddress != null) { raftActor.context().actorSelection(peerAddress).tell(new ServerRemoved(getOperation().getServerId()), raftActor.getSelf()); } } @Override boolean includeSelfInNewConfiguration(RaftActor raftActor) { return !getOperation().getServerId().equals(raftActor.getId()); } @Override String getLoggingContext() { return getOperation().getServerId(); } } private static class ChangeServersVotingStatusContext extends ServerOperationContext { ChangeServersVotingStatusContext(ChangeServersVotingStatus convertMessage, ActorRef clientRequestor) { super(convertMessage, clientRequestor); } @Override InitialOperationState newInitialOperationState(RaftActorServerConfigurationSupport support) { return support.new ChangeServersVotingStatusState(this); } @Override Object newReply(ServerChangeStatus status, String leaderId) { return new ServerChangeReply(status, leaderId); } @Override void operationComplete(final RaftActor raftActor, boolean succeeded) { // If this leader changed to non-voting we need to step down as leader so we'll try to transfer // leadership. boolean localServerChangedToNonVoting = Boolean.FALSE.equals(getOperation(). getServerVotingStatusMap().get(raftActor.getRaftActorContext().getId())); if(succeeded && localServerChangedToNonVoting && raftActor.isLeader()) { raftActor.initiateLeadershipTransfer(new OnComplete() { @Override public void onSuccess(ActorRef raftActorRef, ActorRef replyTo) { LOG.debug("{}: leader transfer succeeded after change to non-voting", raftActor.persistenceId()); ensureFollowerState(raftActor); } @Override public void onFailure(ActorRef raftActorRef, ActorRef replyTo) { LOG.debug("{}: leader transfer failed after change to non-voting", raftActor.persistenceId()); ensureFollowerState(raftActor); } private void ensureFollowerState(RaftActor raftActor) { // Whether or not leadership transfer succeeded, we have to step down as leader and // switch to Follower so ensure that. if(raftActor.getRaftState() != RaftState.Follower) { raftActor.initializeBehavior(); } } }); } } @Override String getLoggingContext() { return getOperation().getServerVotingStatusMap().toString(); } } private class ChangeServersVotingStatusState extends OperationState implements InitialOperationState { private final ChangeServersVotingStatusContext changeVotingStatusContext; ChangeServersVotingStatusState(ChangeServersVotingStatusContext changeVotingStatusContext) { this.changeVotingStatusContext = changeVotingStatusContext; } @Override public void initiate() { LOG.debug("Initiating ChangeServersVotingStatusState"); Map serverVotingStatusMap = changeVotingStatusContext.getOperation().getServerVotingStatusMap(); List newServerInfoList = new ArrayList<>(); for(String peerId: raftContext.getPeerIds()) { newServerInfoList.add(new ServerInfo(peerId, serverVotingStatusMap.containsKey(peerId) ? serverVotingStatusMap.get(peerId) : raftContext.getPeerInfo(peerId).isVoting())); } newServerInfoList.add(new ServerInfo(raftContext.getId(), serverVotingStatusMap.containsKey( raftContext.getId()) ? serverVotingStatusMap.get(raftContext.getId()) : raftContext.isVotingMember())); raftContext.updatePeerIds(new ServerConfigurationPayload(newServerInfoList)); AbstractLeader leader = (AbstractLeader) raftActor.getCurrentBehavior(); leader.updateMinReplicaCount(); persistNewServerConfiguration(changeVotingStatusContext); } } static class ServerOperationTimeout { private final String loggingContext; ServerOperationTimeout(String loggingContext){ this.loggingContext = Preconditions.checkNotNull(loggingContext, "loggingContext should not be null"); } String getLoggingContext() { return loggingContext; } } }