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%2FSnapshotManager.java;h=b195686d2092ff4f54353a6d18295c62ebfe9bec;hp=cb38e82ac3c7f5bb42cee275e3ed1f24a423ee0b;hb=dc538304e4d5f91185c140cc227575f4305344df;hpb=9fe7a995204bcfed3ee6b644922b8fe440fe5f5c diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/SnapshotManager.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/SnapshotManager.java index cb38e82ac3..b195686d20 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/SnapshotManager.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/SnapshotManager.java @@ -8,20 +8,20 @@ package org.opendaylight.controller.cluster.raft; -import akka.japi.Procedure; import akka.persistence.SnapshotSelectionCriteria; -import com.google.protobuf.ByteString; -import org.opendaylight.controller.cluster.DataPersistenceProvider; +import com.google.common.annotations.VisibleForTesting; +import java.util.List; +import java.util.function.Consumer; +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.SendInstallSnapshot; +import org.opendaylight.controller.cluster.raft.base.messages.SnapshotComplete; import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior; import org.slf4j.Logger; public class SnapshotManager implements SnapshotState { - private final SnapshotState IDLE = new Idle(); - private final SnapshotState CAPTURING = new Capturing(); private final SnapshotState PERSISTING = new Persisting(); private final SnapshotState CREATING = new Creating(); @@ -35,40 +35,50 @@ public class SnapshotManager implements SnapshotState { private SnapshotState currentState = IDLE; private CaptureSnapshot captureSnapshot; + private long lastSequenceNumber = -1; + + private Runnable createSnapshotProcedure; + + private ApplySnapshot applySnapshot; + private Consumer applySnapshotProcedure; public SnapshotManager(RaftActorContext context, Logger logger) { this.context = context; this.LOG = logger; } + public boolean isApplying() { + return applySnapshot != null; + } + @Override public boolean isCapturing() { return currentState.isCapturing(); } @Override - public void captureToInstall(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex) { - currentState.captureToInstall(lastLogEntry, replicatedToAllIndex); + public boolean captureToInstall(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex, String targetFollower) { + return currentState.captureToInstall(lastLogEntry, replicatedToAllIndex, targetFollower); } @Override - public void capture(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex) { - currentState.capture(lastLogEntry, replicatedToAllIndex); + public boolean capture(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex) { + return currentState.capture(lastLogEntry, replicatedToAllIndex); } @Override - public void create(Procedure callback) { - currentState.create(callback); + public void apply(ApplySnapshot snapshot) { + currentState.apply(snapshot); } @Override - public void persist(DataPersistenceProvider persistenceProvider, byte[] snapshotBytes, RaftActorBehavior currentBehavior) { - currentState.persist(persistenceProvider, snapshotBytes, currentBehavior); + public void persist(final byte[] snapshotBytes, final long totalMemory) { + currentState.persist(snapshotBytes, totalMemory); } @Override - public void commit(DataPersistenceProvider persistenceProvider, long sequenceNumber) { - currentState.commit(persistenceProvider, sequenceNumber); + public void commit(final long sequenceNumber) { + currentState.commit(sequenceNumber); } @Override @@ -77,47 +87,97 @@ public class SnapshotManager implements SnapshotState { } @Override - public long trimLog(long desiredTrimIndex) { + public long trimLog(final long desiredTrimIndex) { return currentState.trimLog(desiredTrimIndex); } + public void setCreateSnapshotRunnable(Runnable createSnapshotProcedure) { + this.createSnapshotProcedure = createSnapshotProcedure; + } + + public void setApplySnapshotConsumer(Consumer applySnapshotProcedure) { + this.applySnapshotProcedure = applySnapshotProcedure; + } + + public long getLastSequenceNumber() { + return lastSequenceNumber; + } + + @VisibleForTesting + public CaptureSnapshot getCaptureSnapshot() { + return captureSnapshot; + } + private boolean hasFollowers(){ - return context.getPeerAddresses().keySet().size() > 0; + return context.hasFollowers(); } private String persistenceId(){ return context.getId(); } + public CaptureSnapshot newCaptureSnapshot(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex, + boolean installSnapshotInitiated) { + TermInformationReader lastAppliedTermInfoReader = + lastAppliedTermInformationReader.init(context.getReplicatedLog(), context.getLastApplied(), + lastLogEntry, hasFollowers()); + + long lastAppliedIndex = lastAppliedTermInfoReader.getIndex(); + long lastAppliedTerm = lastAppliedTermInfoReader.getTerm(); + + TermInformationReader replicatedToAllTermInfoReader = + replicatedToAllTermInformationReader.init(context.getReplicatedLog(), replicatedToAllIndex); + + long newReplicatedToAllIndex = replicatedToAllTermInfoReader.getIndex(); + long newReplicatedToAllTerm = replicatedToAllTermInfoReader.getTerm(); + + List unAppliedEntries = context.getReplicatedLog().getFrom(lastAppliedIndex + 1); + + long lastLogEntryIndex = lastAppliedIndex; + long lastLogEntryTerm = lastAppliedTerm; + if(lastLogEntry != null) { + lastLogEntryIndex = lastLogEntry.getIndex(); + lastLogEntryTerm = lastLogEntry.getTerm(); + } else { + LOG.debug("{}: Capturing Snapshot : lastLogEntry is null. Using lastAppliedIndex {} and lastAppliedTerm {} instead.", + persistenceId(), lastAppliedIndex, lastAppliedTerm); + } + + return new CaptureSnapshot(lastLogEntryIndex, lastLogEntryTerm, lastAppliedIndex, lastAppliedTerm, + newReplicatedToAllIndex, newReplicatedToAllTerm, unAppliedEntries, installSnapshotInitiated); + } + private class AbstractSnapshotState implements SnapshotState { @Override public boolean isCapturing() { - return false; + return true; } @Override - public void capture(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex) { + public boolean capture(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex) { LOG.debug("capture should not be called in state {}", this); + return false; } @Override - public void captureToInstall(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex) { + public boolean captureToInstall(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex, String targetFollower) { LOG.debug("captureToInstall should not be called in state {}", this); + return false; } @Override - public void create(Procedure callback) { - LOG.debug("create should not be called in state {}", this); + public void apply(ApplySnapshot snapshot) { + LOG.debug("apply should not be called in state {}", this); } @Override - public void persist(DataPersistenceProvider persistenceProvider, byte[] snapshotBytes, RaftActorBehavior currentBehavior) { + public void persist(final byte[] snapshotBytes, final long totalMemory) { LOG.debug("persist should not be called in state {}", this); } @Override - public void commit(DataPersistenceProvider persistenceProvider, long sequenceNumber) { + public void commit(final long sequenceNumber) { LOG.debug("commit should not be called in state {}", this); } @@ -127,17 +187,22 @@ public class SnapshotManager implements SnapshotState { } @Override - public long trimLog(long desiredTrimIndex) { + public long trimLog(final long desiredTrimIndex) { LOG.debug("trimLog should not be called in state {}", this); return -1; } - protected long doTrimLog(long desiredTrimIndex){ + protected long doTrimLog(final long desiredTrimIndex) { // we would want to keep the lastApplied as its used while capturing snapshots long lastApplied = context.getLastApplied(); long tempMin = Math.min(desiredTrimIndex, (lastApplied > -1 ? lastApplied - 1 : -1)); - if (tempMin > -1 && context.getReplicatedLog().isPresent(tempMin)) { + if(LOG.isTraceEnabled()) { + LOG.trace("{}: performSnapshotWithoutCapture: desiredTrimIndex: {}, lastApplied: {}, tempMin: {}", + persistenceId(), desiredTrimIndex, lastApplied, tempMin); + } + + if (tempMin > -1 && context.getReplicatedLog().isPresent(tempMin)) { LOG.debug("{}: fakeSnapshot purging log to {} for term {}", persistenceId(), tempMin, context.getTermInformation().getCurrentTerm()); @@ -148,116 +213,139 @@ public class SnapshotManager implements SnapshotState { return tempMin; } + final RaftActorBehavior currentBehavior = context.getCurrentBehavior(); + if(tempMin > currentBehavior.getReplicatedToAllIndex()) { + // It's possible a follower was lagging and an install snapshot advanced its match index past + // the current replicatedToAllIndex. Since the follower is now caught up we should advance the + // replicatedToAllIndex (to tempMin). The fact that tempMin wasn't found in the log is likely + // due to a previous snapshot triggered by the memory threshold exceeded, in that case we + // trim the log to the last applied index even if previous entries weren't replicated to all followers. + currentBehavior.setReplicatedToAllIndex(tempMin); + } return -1; } } private class Idle extends AbstractSnapshotState { - private void capture(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex, boolean toInstall) { - TermInformationReader lastAppliedTermInfoReader = - lastAppliedTermInformationReader.init(context.getReplicatedLog(), context.getLastApplied(), - lastLogEntry, hasFollowers()); + @Override + public boolean isCapturing() { + return false; + } - long lastAppliedIndex = lastAppliedTermInfoReader.getIndex(); - long lastAppliedTerm = lastAppliedTermInfoReader.getTerm(); + private boolean capture(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex, String targetFollower) { + captureSnapshot = newCaptureSnapshot(lastLogEntry, replicatedToAllIndex, targetFollower != null); - TermInformationReader replicatedToAllTermInfoReader = - replicatedToAllTermInformationReader.init(context.getReplicatedLog(), replicatedToAllIndex); + if(captureSnapshot.isInstallSnapshotInitiated()) { + LOG.info("{}: Initiating snapshot capture {} to install on {}", + persistenceId(), captureSnapshot, targetFollower); + } else { + LOG.info("{}: Initiating snapshot capture {}", persistenceId(), captureSnapshot); + } - long newReplicatedToAllIndex = replicatedToAllTermInfoReader.getIndex(); - long newReplicatedToAllTerm = replicatedToAllTermInfoReader.getTerm(); + lastSequenceNumber = context.getPersistenceProvider().getLastSequenceNumber(); - // send a CaptureSnapshot to self to make the expensive operation async. - captureSnapshot = new CaptureSnapshot(lastLogEntry.getIndex(), - lastLogEntry.getTerm(), lastAppliedIndex, lastAppliedTerm, - newReplicatedToAllIndex, newReplicatedToAllTerm, toInstall); + LOG.debug("{}: lastSequenceNumber prior to capture: {}", persistenceId(), lastSequenceNumber); - SnapshotManager.this.currentState = CAPTURING; + SnapshotManager.this.currentState = CREATING; - LOG.info("{}: Initiating snapshot capture {}: {}", persistenceId(), toInstall ? "to install" : "", - captureSnapshot); + try { + createSnapshotProcedure.run(); + } catch (Exception e) { + SnapshotManager.this.currentState = IDLE; + LOG.error("Error creating snapshot", e); + return false; + } - context.getActor().tell(captureSnapshot, context.getActor()); + return true; } @Override - public void capture(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex) { - capture(lastLogEntry, replicatedToAllIndex, false); + public boolean capture(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex) { + return capture(lastLogEntry, replicatedToAllIndex, null); } @Override - public void captureToInstall(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex) { - capture(lastLogEntry, replicatedToAllIndex, true); + public boolean captureToInstall(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex, String targetFollower) { + return capture(lastLogEntry, replicatedToAllIndex, targetFollower); } @Override - public String toString() { - return "Idle"; - } + public void apply(ApplySnapshot applySnapshot) { + SnapshotManager.this.applySnapshot = applySnapshot; - @Override - public long trimLog(long desiredTrimIndex) { - return doTrimLog(desiredTrimIndex); - } - } + lastSequenceNumber = context.getPersistenceProvider().getLastSequenceNumber(); - private class Capturing extends AbstractSnapshotState { + LOG.debug("lastSequenceNumber prior to persisting applied snapshot: {}", lastSequenceNumber); - @Override - public boolean isCapturing() { - return true; - } + context.getPersistenceProvider().saveSnapshot(applySnapshot.getSnapshot()); - @Override - public void create(Procedure callback) { - try { - callback.apply(null); - SnapshotManager.this.currentState = CREATING; - } catch (Exception e) { - LOG.error("Unexpected error occurred", e); - } + SnapshotManager.this.currentState = PERSISTING; } @Override public String toString() { - return "Capturing"; + return "Idle"; } + @Override + public long trimLog(final long desiredTrimIndex) { + return doTrimLog(desiredTrimIndex); + } } private class Creating extends AbstractSnapshotState { @Override - public boolean isCapturing() { - return true; - } - - @Override - public void persist(DataPersistenceProvider persistenceProvider, byte[] snapshotBytes, - RaftActorBehavior currentBehavior) { + public void persist(final byte[] snapshotBytes, final long totalMemory) { // create a snapshot object from the state provided and save it // when snapshot is saved async, SaveSnapshotSuccess is raised. - Snapshot sn = Snapshot.create(snapshotBytes, - context.getReplicatedLog().getFrom(captureSnapshot.getLastAppliedIndex() + 1), + Snapshot snapshot = Snapshot.create(snapshotBytes, + captureSnapshot.getUnAppliedEntries(), captureSnapshot.getLastIndex(), captureSnapshot.getLastTerm(), - captureSnapshot.getLastAppliedIndex(), captureSnapshot.getLastAppliedTerm()); + captureSnapshot.getLastAppliedIndex(), captureSnapshot.getLastAppliedTerm(), + context.getTermInformation().getCurrentTerm(), + context.getTermInformation().getVotedFor(), context.getPeerServerInfo(true)); - persistenceProvider.saveSnapshot(sn); + context.getPersistenceProvider().saveSnapshot(snapshot); - LOG.info("{}: Persisting of snapshot done:{}", persistenceId(), sn.getLogMessage()); + LOG.info("{}: Persisting of snapshot done: {}", persistenceId(), snapshot); - long dataThreshold = Runtime.getRuntime().totalMemory() * + long dataThreshold = totalMemory * context.getConfigParams().getSnapshotDataThresholdPercentage() / 100; - if (context.getReplicatedLog().dataSize() > dataThreshold) { - // if memory is less, clear the log based on lastApplied. - // this could/should only happen if one of the followers is down - // as normally we keep removing from the log when its replicated to all. + boolean dataSizeThresholdExceeded = context.getReplicatedLog().dataSize() > dataThreshold; + + boolean logSizeExceededSnapshotBatchCount = + context.getReplicatedLog().size() >= context.getConfigParams().getSnapshotBatchCount(); + + final RaftActorBehavior currentBehavior = context.getCurrentBehavior(); + if (dataSizeThresholdExceeded || logSizeExceededSnapshotBatchCount) { + if(LOG.isDebugEnabled()) { + if(dataSizeThresholdExceeded) { + LOG.debug("{}: log data size {} exceeds the memory threshold {} - doing snapshotPreCommit with index {}", + context.getId(), context.getReplicatedLog().dataSize(), dataThreshold, + captureSnapshot.getLastAppliedIndex()); + } else { + LOG.debug("{}: log size {} exceeds the snapshot batch count {} - doing snapshotPreCommit with index {}", + context.getId(), context.getReplicatedLog().size(), + context.getConfigParams().getSnapshotBatchCount(), captureSnapshot.getLastAppliedIndex()); + } + } + + // We either exceeded the memory threshold or the log size exceeded the snapshot batch + // count so, to keep the log memory footprint in check, clear the log based on lastApplied. + // This could/should only happen if one of the followers is down as normally we keep + // removing from the log as entries are replicated to all. context.getReplicatedLog().snapshotPreCommit(captureSnapshot.getLastAppliedIndex(), captureSnapshot.getLastAppliedTerm()); - currentBehavior.setReplicatedToAllIndex(captureSnapshot.getReplicatedToAllIndex()); + // Don't reset replicatedToAllIndex to -1 as this may prevent us from trimming the log after an + // install snapshot to a follower. + if(captureSnapshot.getReplicatedToAllIndex() >= 0) { + currentBehavior.setReplicatedToAllIndex(captureSnapshot.getReplicatedToAllIndex()); + } + } else if(captureSnapshot.getReplicatedToAllIndex() != -1){ // clear the log based on replicatedToAllIndex context.getReplicatedLog().snapshotPreCommit(captureSnapshot.getReplicatedToAllIndex(), @@ -273,15 +361,14 @@ public class SnapshotManager implements SnapshotState { context.getReplicatedLog().getSnapshotTerm()); } - LOG.info("{}: Removed in-memory snapshotted entries, adjusted snaphsotIndex:{} " + - "and term:{}", persistenceId(), captureSnapshot.getLastAppliedIndex(), - captureSnapshot.getLastAppliedTerm()); + LOG.info("{}: Removed in-memory snapshotted entries, adjusted snaphsotIndex: {} " + + "and term: {}", context.getId(), context.getReplicatedLog().getSnapshotIndex(), + context.getReplicatedLog().getSnapshotTerm()); if (context.getId().equals(currentBehavior.getLeaderId()) && captureSnapshot.isInstallSnapshotInitiated()) { // this would be call straight to the leader and won't initiate in serialization - currentBehavior.handleMessage(context.getActor(), new SendInstallSnapshot( - ByteString.copyFrom(snapshotBytes))); + currentBehavior.handleMessage(context.getActor(), new SendInstallSnapshot(snapshot)); } captureSnapshot = null; @@ -298,27 +385,63 @@ public class SnapshotManager implements SnapshotState { private class Persisting extends AbstractSnapshotState { @Override - public void commit(DataPersistenceProvider persistenceProvider, long sequenceNumber) { - context.getReplicatedLog().snapshotCommit(); - persistenceProvider.deleteSnapshots(new SnapshotSelectionCriteria( - sequenceNumber - context.getConfigParams().getSnapshotBatchCount(), 43200000)); + public void commit(final long sequenceNumber) { + LOG.debug("{}: Snapshot success - sequence number: {}", persistenceId(), sequenceNumber); + + if(applySnapshot != null) { + try { + Snapshot snapshot = applySnapshot.getSnapshot(); + + //clears the followers log, sets the snapshot index to ensure adjusted-index works + context.setReplicatedLog(ReplicatedLogImpl.newInstance(snapshot, context)); + context.setLastApplied(snapshot.getLastAppliedIndex()); + context.setCommitIndex(snapshot.getLastAppliedIndex()); + context.getTermInformation().update(snapshot.getElectionTerm(), snapshot.getElectionVotedFor()); + + if(snapshot.getState().length > 0 ) { + applySnapshotProcedure.accept(snapshot.getState()); + } + + applySnapshot.getCallback().onSuccess(); + } catch (Exception e) { + LOG.error("{}: Error applying snapshot", context.getId(), e); + } + } else { + context.getReplicatedLog().snapshotCommit(); + } - persistenceProvider.deleteMessages(sequenceNumber); + context.getPersistenceProvider().deleteSnapshots(new SnapshotSelectionCriteria( + sequenceNumber - context.getConfigParams().getSnapshotBatchCount(), Long.MAX_VALUE, 0L, 0L)); - SnapshotManager.this.currentState = IDLE; + context.getPersistenceProvider().deleteMessages(lastSequenceNumber); + + snapshotComplete(); } @Override public void rollback() { - context.getReplicatedLog().snapshotRollback(); + // Nothing to rollback if we're applying a snapshot from the leader. + if(applySnapshot == null) { + context.getReplicatedLog().snapshotRollback(); + + LOG.info("{}: Replicated Log rolled back. Snapshot will be attempted in the next cycle." + + "snapshotIndex:{}, snapshotTerm:{}, log-size:{}", persistenceId(), + context.getReplicatedLog().getSnapshotIndex(), + context.getReplicatedLog().getSnapshotTerm(), + context.getReplicatedLog().size()); + } else { + applySnapshot.getCallback().onFailure(); + } - LOG.info("{}: Replicated Log rolled back. Snapshot will be attempted in the next cycle." + - "snapshotIndex:{}, snapshotTerm:{}, log-size:{}", persistenceId(), - context.getReplicatedLog().getSnapshotIndex(), - context.getReplicatedLog().getSnapshotTerm(), - context.getReplicatedLog().size()); + snapshotComplete(); + } + private void snapshotComplete() { + lastSequenceNumber = -1; + applySnapshot = null; SnapshotManager.this.currentState = IDLE; + + context.getActor().tell(SnapshotComplete.INSTANCE, context.getActor()); } @Override @@ -333,7 +456,7 @@ public class SnapshotManager implements SnapshotState { long getTerm(); } - private static class LastAppliedTermInformationReader implements TermInformationReader{ + static class LastAppliedTermInformationReader implements TermInformationReader{ private long index; private long term; @@ -344,13 +467,15 @@ public class SnapshotManager implements SnapshotState { this.term = -1L; if (!hasFollowers) { if(lastLogEntry != null) { + // since we have persisted the last-log-entry to persistent journal before the capture, + // we would want to snapshot from this entry. index = lastLogEntry.getIndex(); term = lastLogEntry.getTerm(); } } else if (entry != null) { index = entry.getIndex(); term = entry.getTerm(); - } else if(originalIndex == log.getSnapshotIndex()){ + } else if(log.getSnapshotIndex() > -1){ index = log.getSnapshotIndex(); term = log.getSnapshotTerm(); }