opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActorSnapshotMessageSupport.java

   1 /*
   2  * Copyright (c) 2015 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.cluster.raft;
   9
  10 import akka.actor.ActorRef;
  11 import akka.persistence.SaveSnapshotFailure;
  12 import akka.persistence.SaveSnapshotSuccess;
  13 import akka.util.Timeout;
  14 import com.google.common.annotations.VisibleForTesting;
  15 import java.util.Collections;
  16 import java.util.Optional;
  17 import java.util.concurrent.TimeUnit;
  18 import org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot;
  19 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot;
  20 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply;
  21 import org.opendaylight.controller.cluster.raft.base.messages.SnapshotComplete;
  22 import org.opendaylight.controller.cluster.raft.client.messages.GetSnapshot;
  23 import org.opendaylight.controller.cluster.raft.client.messages.GetSnapshotReply;
  24 import org.opendaylight.controller.cluster.raft.persisted.EmptyState;
  25 import org.opendaylight.controller.cluster.raft.persisted.Snapshot;
  26 import org.slf4j.Logger;
  27 import scala.concurrent.duration.FiniteDuration;
  28
  29 /**
  30  * Handles snapshot related messages for a RaftActor.
  31  *
  32  * @author Thomas Pantelis
  33  */
  34 class RaftActorSnapshotMessageSupport {
  35     static final Object COMMIT_SNAPSHOT = new Object() {
  36         @Override
  37         public String toString() {
  38             return "commit_snapshot";
  39         }
  40     };
  41
  42     private final RaftActorContext context;
  43     private final RaftActorSnapshotCohort cohort;
  44     private final Logger log;
  45
  46     private FiniteDuration snapshotReplyActorTimeout = FiniteDuration.create(30, TimeUnit.SECONDS);
  47
  48     RaftActorSnapshotMessageSupport(final RaftActorContext context, final RaftActorSnapshotCohort cohort) {
  49         this.context = context;
  50         this.cohort = cohort;
  51         log = context.getLogger();
  52
  53         context.getSnapshotManager().setCreateSnapshotConsumer(
  54             outputStream -> cohort.createSnapshot(context.getActor(), outputStream));
  55         context.getSnapshotManager().setSnapshotCohort(cohort);
  56     }
  57
  58     RaftActorSnapshotCohort getSnapshotCohort() {
  59         return cohort;
  60     }
  61
  62     boolean handleSnapshotMessage(final Object message, final ActorRef sender) {
  63         if (message instanceof ApplySnapshot) {
  64             onApplySnapshot((ApplySnapshot) message);
  65         } else if (message instanceof SaveSnapshotSuccess) {
  66             onSaveSnapshotSuccess((SaveSnapshotSuccess) message);
  67         } else if (message instanceof SaveSnapshotFailure) {
  68             onSaveSnapshotFailure((SaveSnapshotFailure) message);
  69         } else if (message instanceof CaptureSnapshotReply) {
  70             onCaptureSnapshotReply((CaptureSnapshotReply) message);
  71         } else if (COMMIT_SNAPSHOT.equals(message)) {
  72             context.getSnapshotManager().commit(-1, -1);
  73         } else if (message instanceof GetSnapshot) {
  74             onGetSnapshot(sender, (GetSnapshot) message);
  75         } else if (message instanceof SnapshotComplete) {
  76             log.debug("{}: SnapshotComplete received", context.getId());
  77         } else {
  78             return false;
  79         }
  80
  81         return true;
  82     }
  83
  84     private void onCaptureSnapshotReply(final CaptureSnapshotReply reply) {
  85         log.debug("{}: CaptureSnapshotReply received by actor", context.getId());
  86
  87         context.getSnapshotManager().persist(reply.getSnapshotState(), reply.getInstallSnapshotStream(),
  88                 context.getTotalMemory());
  89     }
  90
  91     private void onSaveSnapshotFailure(final SaveSnapshotFailure saveSnapshotFailure) {
  92         log.error("{}: SaveSnapshotFailure received for snapshot Cause:",
  93                 context.getId(), saveSnapshotFailure.cause());
  94
  95         context.getSnapshotManager().rollback();
  96     }
  97
  98     private void onSaveSnapshotSuccess(final SaveSnapshotSuccess success) {
  99         long sequenceNumber = success.metadata().sequenceNr();
 100
 101         log.info("{}: SaveSnapshotSuccess received for snapshot, sequenceNr: {}", context.getId(), sequenceNumber);
 102
 103         context.getSnapshotManager().commit(sequenceNumber, success.metadata().timestamp());
 104     }
 105
 106     private void onApplySnapshot(final ApplySnapshot message) {
 107         log.info("{}: Applying snapshot on follower:  {}", context.getId(), message.getSnapshot());
 108
 109         context.getSnapshotManager().apply(message);
 110     }
 111
 112     private void onGetSnapshot(final ActorRef sender, final GetSnapshot getSnapshot) {
 113         log.debug("{}: onGetSnapshot", context.getId());
 114
 115
 116         if (context.getPersistenceProvider().isRecoveryApplicable()) {
 117             CaptureSnapshot captureSnapshot = context.getSnapshotManager().newCaptureSnapshot(
 118                     context.getReplicatedLog().last(), -1, true);
 119
 120             final FiniteDuration timeout =
 121                     getSnapshot.getTimeout().map(Timeout::duration).orElse(snapshotReplyActorTimeout);
 122
 123             ActorRef snapshotReplyActor = context.actorOf(GetSnapshotReplyActor.props(captureSnapshot,
 124                     ImmutableElectionTerm.copyOf(context.getTermInformation()), sender, timeout, context.getId(),
 125                     context.getPeerServerInfo(true)));
 126
 127             cohort.createSnapshot(snapshotReplyActor, Optional.empty());
 128         } else {
 129             Snapshot snapshot = Snapshot.create(
 130                     EmptyState.INSTANCE, Collections.<ReplicatedLogEntry>emptyList(),
 131                     -1, -1, -1, -1,
 132                     context.getTermInformation().getCurrentTerm(), context.getTermInformation().getVotedFor(),
 133                     context.getPeerServerInfo(true));
 134
 135             sender.tell(new GetSnapshotReply(context.getId(), snapshot), context.getActor());
 136         }
 137     }
 138
 139     @VisibleForTesting
 140     void setSnapshotReplyActorTimeout(final FiniteDuration snapshotReplyActorTimeout) {
 141         this.snapshotReplyActorTimeout = snapshotReplyActorTimeout;
 142     }
 143 }