package org.opendaylight.controller.cluster.raft;
import akka.actor.ActorRef;
-import akka.japi.Procedure;
import akka.persistence.SaveSnapshotFailure;
import akka.persistence.SaveSnapshotSuccess;
+import akka.util.Timeout;
import com.google.common.annotations.VisibleForTesting;
import java.util.Collections;
+import java.util.Optional;
import java.util.concurrent.TimeUnit;
-import org.apache.commons.lang3.SerializationUtils;
import org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot;
import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot;
import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply;
-import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
+import org.opendaylight.controller.cluster.raft.base.messages.SnapshotComplete;
import org.opendaylight.controller.cluster.raft.client.messages.GetSnapshot;
import org.opendaylight.controller.cluster.raft.client.messages.GetSnapshotReply;
+import org.opendaylight.controller.cluster.raft.persisted.EmptyState;
+import org.opendaylight.controller.cluster.raft.persisted.Snapshot;
import org.slf4j.Logger;
-import scala.concurrent.duration.Duration;
+import scala.concurrent.duration.FiniteDuration;
/**
* Handles snapshot related messages for a RaftActor.
* @author Thomas Pantelis
*/
class RaftActorSnapshotMessageSupport {
- static final String COMMIT_SNAPSHOT = "commit_snapshot";
-
- private final RaftActorContext context;
- private final RaftActorBehavior currentBehavior;
- private final RaftActorSnapshotCohort cohort;
- private final Logger log;
-
- private final Procedure<Void> createSnapshotProcedure = new Procedure<Void>() {
+ static final Object COMMIT_SNAPSHOT = new Object() {
@Override
- public void apply(Void notUsed) {
- cohort.createSnapshot(context.getActor());
+ public String toString() {
+ return "commit_snapshot";
}
};
- private final Procedure<byte[]> applySnapshotProcedure = new Procedure<byte[]>() {
- @Override
- public void apply(byte[] state) {
- cohort.applySnapshot(state);
- }
- };
+ private final RaftActorContext context;
+ private final RaftActorSnapshotCohort cohort;
+ private final Logger log;
- private Duration snapshotReplyActorTimeout = Duration.create(30, TimeUnit.SECONDS);
+ private FiniteDuration snapshotReplyActorTimeout = FiniteDuration.create(30, TimeUnit.SECONDS);
- RaftActorSnapshotMessageSupport(RaftActorContext context, RaftActorBehavior currentBehavior,
- RaftActorSnapshotCohort cohort) {
+ RaftActorSnapshotMessageSupport(final RaftActorContext context, final RaftActorSnapshotCohort cohort) {
this.context = context;
- this.currentBehavior = currentBehavior;
this.cohort = cohort;
- this.log = context.getLogger();
+ log = context.getLogger();
- context.getSnapshotManager().setCreateSnapshotCallable(createSnapshotProcedure);
- context.getSnapshotManager().setApplySnapshotProcedure(applySnapshotProcedure);
+ context.getSnapshotManager().setCreateSnapshotConsumer(
+ outputStream -> cohort.createSnapshot(context.getActor(), outputStream));
+ context.getSnapshotManager().setSnapshotCohort(cohort);
}
- boolean handleSnapshotMessage(Object message, ActorRef sender) {
- if(message instanceof ApplySnapshot ) {
- onApplySnapshot((ApplySnapshot) message);
- return true;
- } else if (message instanceof SaveSnapshotSuccess) {
- onSaveSnapshotSuccess((SaveSnapshotSuccess) message);
- return true;
- } else if (message instanceof SaveSnapshotFailure) {
- onSaveSnapshotFailure((SaveSnapshotFailure) message);
- return true;
- } else if (message instanceof CaptureSnapshotReply) {
- onCaptureSnapshotReply(((CaptureSnapshotReply) message).getSnapshot());
- return true;
- } else if (message.equals(COMMIT_SNAPSHOT)) {
- context.getSnapshotManager().commit(-1, currentBehavior);
- return true;
- } else if (message instanceof GetSnapshot) {
- onGetSnapshot(sender);
- return true;
+ RaftActorSnapshotCohort getSnapshotCohort() {
+ return cohort;
+ }
+
+ boolean handleSnapshotMessage(final Object message, final ActorRef sender) {
+ if (message instanceof ApplySnapshot applySnapshot) {
+ onApplySnapshot(applySnapshot);
+ } else if (message instanceof SaveSnapshotSuccess saveSnapshotSuccess) {
+ onSaveSnapshotSuccess(saveSnapshotSuccess);
+ } else if (message instanceof SaveSnapshotFailure saveSnapshotFailure) {
+ onSaveSnapshotFailure(saveSnapshotFailure);
+ } else if (message instanceof CaptureSnapshotReply captureSnapshotReply) {
+ onCaptureSnapshotReply(captureSnapshotReply);
+ } else if (COMMIT_SNAPSHOT.equals(message)) {
+ context.getSnapshotManager().commit(-1, -1);
+ } else if (message instanceof GetSnapshot getSnapshot) {
+ onGetSnapshot(sender, getSnapshot);
+ } else if (message instanceof SnapshotComplete) {
+ log.debug("{}: SnapshotComplete received", context.getId());
} else {
return false;
}
+
+ return true;
}
- private void onCaptureSnapshotReply(byte[] snapshotBytes) {
- log.debug("{}: CaptureSnapshotReply received by actor: snapshot size {}", context.getId(), snapshotBytes.length);
+ private void onCaptureSnapshotReply(final CaptureSnapshotReply reply) {
+ log.debug("{}: CaptureSnapshotReply received by actor", context.getId());
- context.getSnapshotManager().persist(snapshotBytes, currentBehavior, context.getTotalMemory());
+ context.getSnapshotManager().persist(reply.getSnapshotState(), reply.getInstallSnapshotStream(),
+ context.getTotalMemory());
}
- private void onSaveSnapshotFailure(SaveSnapshotFailure saveSnapshotFailure) {
+ private void onSaveSnapshotFailure(final SaveSnapshotFailure saveSnapshotFailure) {
log.error("{}: SaveSnapshotFailure received for snapshot Cause:",
context.getId(), saveSnapshotFailure.cause());
context.getSnapshotManager().rollback();
}
- private void onSaveSnapshotSuccess(SaveSnapshotSuccess success) {
- log.info("{}: SaveSnapshotSuccess received for snapshot", context.getId());
-
+ private void onSaveSnapshotSuccess(final SaveSnapshotSuccess success) {
long sequenceNumber = success.metadata().sequenceNr();
- context.getSnapshotManager().commit(sequenceNumber, currentBehavior);
+ log.info("{}: SaveSnapshotSuccess received for snapshot, sequenceNr: {}", context.getId(), sequenceNumber);
+
+ context.getSnapshotManager().commit(sequenceNumber, success.metadata().timestamp());
}
- private void onApplySnapshot(ApplySnapshot message) {
- log.info("{}: Applying snapshot on follower with snapshotIndex: {}, snapshotTerm: {}", context.getId(),
- message.getSnapshot().getLastAppliedIndex(), message.getSnapshot().getLastAppliedTerm());
+ private void onApplySnapshot(final ApplySnapshot message) {
+ log.info("{}: Applying snapshot on follower: {}", context.getId(), message.getSnapshot());
context.getSnapshotManager().apply(message);
}
- private void onGetSnapshot(ActorRef sender) {
+ private void onGetSnapshot(final ActorRef sender, final GetSnapshot getSnapshot) {
log.debug("{}: onGetSnapshot", context.getId());
- if(context.getPersistenceProvider().isRecoveryApplicable()) {
+
+ if (context.getPersistenceProvider().isRecoveryApplicable()) {
CaptureSnapshot captureSnapshot = context.getSnapshotManager().newCaptureSnapshot(
- context.getReplicatedLog().last(), -1, false);
+ context.getReplicatedLog().last(), -1, true);
+
+ final FiniteDuration timeout =
+ getSnapshot.getTimeout().map(Timeout::duration).orElse(snapshotReplyActorTimeout);
ActorRef snapshotReplyActor = context.actorOf(GetSnapshotReplyActor.props(captureSnapshot,
- ImmutableElectionTerm.copyOf(context.getTermInformation()), sender,
- snapshotReplyActorTimeout, context.getId(), context.getPeerServerInfo()));
+ ImmutableElectionTerm.copyOf(context.getTermInformation()), sender, timeout, context.getId(),
+ context.getPeerServerInfo(true)));
- cohort.createSnapshot(snapshotReplyActor);
+ cohort.createSnapshot(snapshotReplyActor, Optional.empty());
} else {
- Snapshot snapshot = Snapshot.create(new byte[0], Collections.<ReplicatedLogEntry>emptyList(), -1, -1, -1, -1,
+ Snapshot snapshot = Snapshot.create(
+ EmptyState.INSTANCE, Collections.<ReplicatedLogEntry>emptyList(),
+ -1, -1, -1, -1,
context.getTermInformation().getCurrentTerm(), context.getTermInformation().getVotedFor(),
- context.getPeerServerInfo());
+ context.getPeerServerInfo(true));
- sender.tell(new GetSnapshotReply(context.getId(), SerializationUtils.serialize(snapshot)),
- context.getActor());
+ sender.tell(new GetSnapshotReply(context.getId(), snapshot), context.getActor());
}
}
@VisibleForTesting
- void setSnapshotReplyActorTimeout(Duration snapshotReplyActorTimeout) {
+ void setSnapshotReplyActorTimeout(final FiniteDuration snapshotReplyActorTimeout) {
this.snapshotReplyActorTimeout = snapshotReplyActorTimeout;
}
}