X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-akka-raft%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fraft%2FRaftActorRecoverySupport.java;h=10375f9406666234bb3f6f69d14cb2ea003ef7f8;hp=5f33c738e1e44e972b5a7962302f22f177499899;hb=33877f41ffc3f8eb36ad8490315419b90817d26e;hpb=5de57714fa057ac80f930c2fcce2758ca0a5f514 diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActorRecoverySupport.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActorRecoverySupport.java index 5f33c738e1..10375f9406 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActorRecoverySupport.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/RaftActorRecoverySupport.java @@ -10,12 +10,19 @@ package org.opendaylight.controller.cluster.raft; import akka.persistence.RecoveryCompleted; import akka.persistence.SnapshotOffer; import com.google.common.base.Stopwatch; -import org.opendaylight.controller.cluster.DataPersistenceProvider; -import org.opendaylight.controller.cluster.raft.RaftActor.DeleteEntries; -import org.opendaylight.controller.cluster.raft.RaftActor.UpdateElectionTerm; -import org.opendaylight.controller.cluster.raft.base.messages.ApplyJournalEntries; -import org.opendaylight.controller.cluster.raft.base.messages.ApplyLogEntries; -import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior; +import java.util.Collections; +import java.util.concurrent.TimeUnit; +import org.opendaylight.controller.cluster.PersistentDataProvider; +import org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot; +import org.opendaylight.controller.cluster.raft.persisted.ApplyJournalEntries; +import org.opendaylight.controller.cluster.raft.persisted.DeleteEntries; +import org.opendaylight.controller.cluster.raft.persisted.EmptyState; +import org.opendaylight.controller.cluster.raft.persisted.MigratedSerializable; +import org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPayload; +import org.opendaylight.controller.cluster.raft.persisted.Snapshot; +import org.opendaylight.controller.cluster.raft.persisted.Snapshot.State; +import org.opendaylight.controller.cluster.raft.persisted.UpdateElectionTerm; +import org.opendaylight.controller.cluster.raft.protobuff.client.messages.PersistentPayload; import org.slf4j.Logger; /** @@ -24,149 +31,313 @@ import org.slf4j.Logger; * @author Thomas Pantelis */ class RaftActorRecoverySupport { - private final DataPersistenceProvider persistence; private final RaftActorContext context; - private final RaftActorBehavior currentBehavior; private final RaftActorRecoveryCohort cohort; private int currentRecoveryBatchCount; + private boolean dataRecoveredWithPersistenceDisabled; + private boolean anyDataRecovered; + private boolean hasMigratedDataRecovered; private Stopwatch recoveryTimer; + private Stopwatch recoverySnapshotTimer; private final Logger log; - RaftActorRecoverySupport(DataPersistenceProvider persistence, RaftActorContext context, - RaftActorBehavior currentBehavior, RaftActorRecoveryCohort cohort) { - this.persistence = persistence; + RaftActorRecoverySupport(final RaftActorContext context, final RaftActorRecoveryCohort cohort) { this.context = context; - this.currentBehavior = currentBehavior; this.cohort = cohort; this.log = context.getLogger(); } - boolean handleRecoveryMessage(Object message) { + boolean handleRecoveryMessage(final Object message, final PersistentDataProvider persistentProvider) { + log.trace("{}: handleRecoveryMessage: {}", context.getId(), message); + + anyDataRecovered = anyDataRecovered || !(message instanceof RecoveryCompleted); + + if (isMigratedSerializable(message)) { + hasMigratedDataRecovered = true; + } + boolean recoveryComplete = false; - if(persistence.isRecoveryApplicable()) { - if (message instanceof SnapshotOffer) { - onRecoveredSnapshot((SnapshotOffer) message); - } else if (message instanceof ReplicatedLogEntry) { - onRecoveredJournalLogEntry((ReplicatedLogEntry) message); - } else if (message instanceof ApplyLogEntries) { - // Handle this message for backwards compatibility with pre-Lithium versions. - onRecoveredApplyLogEntries(((ApplyLogEntries) message).getToIndex()); - } else if (message instanceof ApplyJournalEntries) { - onRecoveredApplyLogEntries(((ApplyJournalEntries) message).getToIndex()); - } else if (message instanceof DeleteEntries) { - replicatedLog().removeFrom(((DeleteEntries) message).getFromIndex()); - } else if (message instanceof UpdateElectionTerm) { - context.getTermInformation().update(((UpdateElectionTerm) message).getCurrentTerm(), - ((UpdateElectionTerm) message).getVotedFor()); - } else if (message instanceof RecoveryCompleted) { - onRecoveryCompletedMessage(); - recoveryComplete = true; - } + if (message instanceof UpdateElectionTerm) { + context.getTermInformation().update(((UpdateElectionTerm) message).getCurrentTerm(), + ((UpdateElectionTerm) message).getVotedFor()); + } else if (message instanceof SnapshotOffer) { + onRecoveredSnapshot((SnapshotOffer) message); + } else if (message instanceof ReplicatedLogEntry) { + onRecoveredJournalLogEntry((ReplicatedLogEntry) message); + } else if (message instanceof ApplyJournalEntries) { + onRecoveredApplyLogEntries(((ApplyJournalEntries) message).getToIndex()); + } else if (message instanceof DeleteEntries) { + onDeleteEntries((DeleteEntries) message); + } else if (message instanceof ServerConfigurationPayload) { + context.updatePeerIds((ServerConfigurationPayload)message); } else if (message instanceof RecoveryCompleted) { recoveryComplete = true; + onRecoveryCompletedMessage(persistentProvider); } return recoveryComplete; } + @SuppressWarnings("checkstyle:IllegalCatch") + private void possiblyRestoreFromSnapshot() { + Snapshot restoreFromSnapshot = cohort.getRestoreFromSnapshot(); + if (restoreFromSnapshot == null) { + return; + } + + if (anyDataRecovered) { + log.warn("{}: The provided restore snapshot was not applied because the persistence store is not empty", + context.getId()); + return; + } + + log.debug("{}: Restore snapshot: {}", context.getId(), restoreFromSnapshot); + + context.getSnapshotManager().apply(new ApplySnapshot(restoreFromSnapshot)); + } + private ReplicatedLog replicatedLog() { return context.getReplicatedLog(); } - private void initRecoveryTimer() { - if(recoveryTimer == null) { + private void initRecoveryTimers() { + if (recoveryTimer == null) { recoveryTimer = Stopwatch.createStarted(); } + if (recoverySnapshotTimer == null && context.getConfigParams().getRecoverySnapshotIntervalSeconds() > 0) { + recoverySnapshotTimer = Stopwatch.createStarted(); + } } - private void onRecoveredSnapshot(SnapshotOffer offer) { - if(log.isDebugEnabled()) { - log.debug("{}: SnapshotOffer called..", context.getId()); - } + private void onRecoveredSnapshot(final SnapshotOffer offer) { + log.debug("{}: SnapshotOffer called.", context.getId()); - initRecoveryTimer(); + initRecoveryTimers(); Snapshot snapshot = (Snapshot) offer.snapshot(); + for (ReplicatedLogEntry entry: snapshot.getUnAppliedEntries()) { + if (isMigratedPayload(entry)) { + hasMigratedDataRecovered = true; + } + } + + if (!context.getPersistenceProvider().isRecoveryApplicable()) { + // We may have just transitioned to disabled and have a snapshot containing state data and/or log + // entries - we don't want to preserve these, only the server config and election term info. + + snapshot = Snapshot.create( + EmptyState.INSTANCE, Collections.emptyList(), -1, -1, -1, -1, + snapshot.getElectionTerm(), snapshot.getElectionVotedFor(), snapshot.getServerConfiguration()); + } + // Create a replicated log with the snapshot information // The replicated log can be used later on to retrieve this snapshot // when we need to install it on a peer - context.setReplicatedLog(ReplicatedLogImpl.newInstance(snapshot, context, persistence, currentBehavior)); + context.setReplicatedLog(ReplicatedLogImpl.newInstance(snapshot, context)); context.setLastApplied(snapshot.getLastAppliedIndex()); context.setCommitIndex(snapshot.getLastAppliedIndex()); + context.getTermInformation().update(snapshot.getElectionTerm(), snapshot.getElectionVotedFor()); - Stopwatch timer = Stopwatch.createStarted(); + final Stopwatch timer = Stopwatch.createStarted(); // Apply the snapshot to the actors state - cohort.applyRecoverySnapshot(snapshot.getState()); + final State snapshotState = snapshot.getState(); + if (snapshotState.needsMigration()) { + hasMigratedDataRecovered = true; + } + if (!(snapshotState instanceof EmptyState)) { + cohort.applyRecoverySnapshot(snapshotState); + } + + if (snapshot.getServerConfiguration() != null) { + context.updatePeerIds(snapshot.getServerConfiguration()); + } timer.stop(); - log.info("Recovery snapshot applied for {} in {}: snapshotIndex={}, snapshotTerm={}, journal-size=" + - replicatedLog().size(), context.getId(), timer.toString(), - replicatedLog().getSnapshotIndex(), replicatedLog().getSnapshotTerm()); + log.info("Recovery snapshot applied for {} in {}: snapshotIndex={}, snapshotTerm={}, journal-size={}", + context.getId(), timer, replicatedLog().getSnapshotIndex(), replicatedLog().getSnapshotTerm(), + replicatedLog().size()); } - private void onRecoveredJournalLogEntry(ReplicatedLogEntry logEntry) { - if(log.isDebugEnabled()) { - log.debug("{}: Received ReplicatedLogEntry for recovery: {}", context.getId(), logEntry.getIndex()); + private void onRecoveredJournalLogEntry(final ReplicatedLogEntry logEntry) { + if (log.isDebugEnabled()) { + log.debug("{}: Received ReplicatedLogEntry for recovery: index: {}, size: {}", context.getId(), + logEntry.getIndex(), logEntry.size()); } - replicatedLog().append(logEntry); + if (isServerConfigurationPayload(logEntry)) { + context.updatePeerIds((ServerConfigurationPayload)logEntry.getData()); + } + + if (isMigratedPayload(logEntry)) { + hasMigratedDataRecovered = true; + } + + if (context.getPersistenceProvider().isRecoveryApplicable()) { + replicatedLog().append(logEntry); + } else if (!isPersistentPayload(logEntry)) { + dataRecoveredWithPersistenceDisabled = true; + } } - private void onRecoveredApplyLogEntries(long toIndex) { - if(log.isDebugEnabled()) { - log.debug("{}: Received ApplyLogEntries for recovery, applying to state: {} to {}", - context.getId(), context.getLastApplied() + 1, toIndex); + private void onRecoveredApplyLogEntries(final long toIndex) { + if (!context.getPersistenceProvider().isRecoveryApplicable()) { + dataRecoveredWithPersistenceDisabled = true; + return; } - for (long i = context.getLastApplied() + 1; i <= toIndex; i++) { - batchRecoveredLogEntry(replicatedLog().get(i)); + long lastUnappliedIndex = context.getLastApplied() + 1; + + if (log.isDebugEnabled()) { + // it can happen that lastUnappliedIndex > toIndex, if the AJE is in the persistent journal + // but the entry itself has made it to that state and recovered via the snapshot + log.debug("{}: Received apply journal entries for recovery, applying to state: {} to {}", + context.getId(), lastUnappliedIndex, toIndex); } - context.setLastApplied(toIndex); - context.setCommitIndex(toIndex); + long lastApplied = lastUnappliedIndex - 1; + for (long i = lastUnappliedIndex; i <= toIndex; i++) { + ReplicatedLogEntry logEntry = replicatedLog().get(i); + if (logEntry != null) { + lastApplied++; + batchRecoveredLogEntry(logEntry); + if (shouldTakeRecoverySnapshot() && !context.getSnapshotManager().isCapturing()) { + if (currentRecoveryBatchCount > 0) { + endCurrentLogRecoveryBatch(); + } + context.setLastApplied(lastApplied); + context.setCommitIndex(lastApplied); + takeRecoverySnapshot(logEntry); + } + } else { + // Shouldn't happen but cover it anyway. + log.error("{}: Log entry not found for index {}", context.getId(), i); + break; + } + } + + context.setLastApplied(lastApplied); + context.setCommitIndex(lastApplied); + } + + private void onDeleteEntries(final DeleteEntries deleteEntries) { + if (context.getPersistenceProvider().isRecoveryApplicable()) { + replicatedLog().removeFrom(deleteEntries.getFromIndex()); + } else { + dataRecoveredWithPersistenceDisabled = true; + } } - private void batchRecoveredLogEntry(ReplicatedLogEntry logEntry) { - initRecoveryTimer(); + private void batchRecoveredLogEntry(final ReplicatedLogEntry logEntry) { + initRecoveryTimers(); int batchSize = context.getConfigParams().getJournalRecoveryLogBatchSize(); - if(currentRecoveryBatchCount == 0) { - cohort.startLogRecoveryBatch(batchSize); - } + if (!isServerConfigurationPayload(logEntry)) { + if (currentRecoveryBatchCount == 0) { + cohort.startLogRecoveryBatch(batchSize); + } - cohort.appendRecoveredLogEntry(logEntry.getData()); + cohort.appendRecoveredLogEntry(logEntry.getData()); - if(++currentRecoveryBatchCount >= batchSize) { - endCurrentLogRecoveryBatch(); + if (++currentRecoveryBatchCount >= batchSize) { + endCurrentLogRecoveryBatch(); + } } } + private void takeRecoverySnapshot(final ReplicatedLogEntry logEntry) { + log.info("Time for recovery snapshot on entry with index {}", logEntry.getIndex()); + final SnapshotManager snapshotManager = context.getSnapshotManager(); + if (snapshotManager.capture(logEntry, -1)) { + log.info("Capturing snapshot, resetting timer for the next recovery snapshot interval."); + this.recoverySnapshotTimer.reset().start(); + } else { + log.info("SnapshotManager is not able to capture snapshot at this time. It will be retried " + + "again with the next recovered entry."); + } + } + + private boolean shouldTakeRecoverySnapshot() { + return this.recoverySnapshotTimer != null && this.recoverySnapshotTimer.elapsed(TimeUnit.SECONDS) + >= context.getConfigParams().getRecoverySnapshotIntervalSeconds(); + } + private void endCurrentLogRecoveryBatch() { cohort.applyCurrentLogRecoveryBatch(); currentRecoveryBatchCount = 0; } - private void onRecoveryCompletedMessage() { - if(currentRecoveryBatchCount > 0) { + private void onRecoveryCompletedMessage(final PersistentDataProvider persistentProvider) { + if (currentRecoveryBatchCount > 0) { endCurrentLogRecoveryBatch(); } - String recoveryTime = ""; - if(recoveryTimer != null) { - recoveryTimer.stop(); - recoveryTime = " in " + recoveryTimer.toString(); + final String recoveryTime; + if (recoveryTimer != null) { + recoveryTime = " in " + recoveryTimer.stop(); recoveryTimer = null; + } else { + recoveryTime = ""; + } + + if (recoverySnapshotTimer != null) { + recoverySnapshotTimer.stop(); + recoverySnapshotTimer = null; } - log.info("Recovery completed" + recoveryTime + " - Switching actor to Follower - " + - "Persistence Id = " + context.getId() + - " Last index in log = {}, snapshotIndex = {}, snapshotTerm = {}, " + - "journal-size = {}", replicatedLog().lastIndex(), replicatedLog().getSnapshotIndex(), - replicatedLog().getSnapshotTerm(), replicatedLog().size()); + log.info("{}: Recovery completed {} - Switching actor to Follower - last log index = {}, last log term = {}, " + + "snapshot index = {}, snapshot term = {}, journal size = {}", context.getId(), recoveryTime, + replicatedLog().lastIndex(), replicatedLog().lastTerm(), replicatedLog().getSnapshotIndex(), + replicatedLog().getSnapshotTerm(), replicatedLog().size()); + + if (dataRecoveredWithPersistenceDisabled + || hasMigratedDataRecovered && !context.getPersistenceProvider().isRecoveryApplicable()) { + if (hasMigratedDataRecovered) { + log.info("{}: Saving snapshot after recovery due to migrated messages", context.getId()); + } else { + log.info("{}: Saving snapshot after recovery due to data persistence disabled", context.getId()); + } + + // Either data persistence is disabled and we recovered some data entries (ie we must have just + // transitioned to disabled or a persistence backup was restored) or we recovered migrated + // messages. Either way, we persist a snapshot and delete all the messages from the akka journal + // to clean out unwanted messages. + + Snapshot snapshot = Snapshot.create( + EmptyState.INSTANCE, Collections.emptyList(), + -1, -1, -1, -1, + context.getTermInformation().getCurrentTerm(), context.getTermInformation().getVotedFor(), + context.getPeerServerInfo(true)); + + persistentProvider.saveSnapshot(snapshot); + + persistentProvider.deleteMessages(persistentProvider.getLastSequenceNumber()); + } else if (hasMigratedDataRecovered) { + log.info("{}: Snapshot capture initiated after recovery due to migrated messages", context.getId()); + + context.getSnapshotManager().capture(replicatedLog().last(), -1); + } else { + possiblyRestoreFromSnapshot(); + } + } + + private static boolean isServerConfigurationPayload(final ReplicatedLogEntry repLogEntry) { + return repLogEntry.getData() instanceof ServerConfigurationPayload; + } + + private static boolean isPersistentPayload(final ReplicatedLogEntry repLogEntry) { + return repLogEntry.getData() instanceof PersistentPayload; + } + + private static boolean isMigratedPayload(final ReplicatedLogEntry repLogEntry) { + return isMigratedSerializable(repLogEntry.getData()); + } + + private static boolean isMigratedSerializable(final Object message) { + return message instanceof MigratedSerializable && ((MigratedSerializable)message).isMigrated(); } }