* 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.persistence.SnapshotSelectionCriteria;
import com.google.common.annotations.VisibleForTesting;
+import com.google.common.io.ByteSource;
+import java.io.IOException;
+import java.io.OutputStream;
import java.util.List;
+import java.util.Optional;
import java.util.function.Consumer;
+import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.controller.cluster.io.FileBackedOutputStream;
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.opendaylight.controller.cluster.raft.persisted.EmptyState;
+import org.opendaylight.controller.cluster.raft.persisted.Snapshot;
import org.slf4j.Logger;
/**
private CaptureSnapshot captureSnapshot;
private long lastSequenceNumber = -1;
- private Runnable createSnapshotProcedure;
+ private Consumer<Optional<OutputStream>> createSnapshotProcedure = null;
private ApplySnapshot applySnapshot;
- private Consumer<byte[]> applySnapshotProcedure;
+ private RaftActorSnapshotCohort snapshotCohort = NoopRaftActorSnapshotCohort.INSTANCE;
/**
* Constructs an instance.
* @param context the RaftActorContext
* @param logger the Logger
*/
- public SnapshotManager(RaftActorContext context, Logger logger) {
+ public SnapshotManager(final RaftActorContext context, final Logger logger) {
this.context = context;
this.log = logger;
}
}
@Override
- public boolean captureToInstall(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex, String targetFollower) {
+ public boolean captureToInstall(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex,
+ final String targetFollower) {
return currentState.captureToInstall(lastLogEntry, replicatedToAllIndex, targetFollower);
}
@Override
- public boolean capture(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex) {
+ public boolean capture(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex) {
return currentState.capture(lastLogEntry, replicatedToAllIndex);
}
@Override
- public void apply(ApplySnapshot snapshot) {
+ public boolean captureWithForcedTrim(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex) {
+ return currentState.captureWithForcedTrim(lastLogEntry, replicatedToAllIndex);
+ }
+
+ @Override
+ public void apply(final ApplySnapshot snapshot) {
currentState.apply(snapshot);
}
@Override
- public void persist(final byte[] snapshotBytes, final long totalMemory) {
- currentState.persist(snapshotBytes, totalMemory);
+ public void persist(final Snapshot.State state, final Optional<OutputStream> installSnapshotStream,
+ final long totalMemory) {
+ currentState.persist(state, installSnapshotStream, totalMemory);
}
@Override
- public void commit(final long sequenceNumber, long timeStamp) {
+ public void commit(final long sequenceNumber, final long timeStamp) {
currentState.commit(sequenceNumber, timeStamp);
}
return currentState.trimLog(desiredTrimIndex);
}
- public void setCreateSnapshotRunnable(Runnable createSnapshotProcedure) {
+ @SuppressWarnings("checkstyle:hiddenField")
+ void setCreateSnapshotConsumer(final Consumer<Optional<OutputStream>> createSnapshotProcedure) {
this.createSnapshotProcedure = createSnapshotProcedure;
}
- public void setApplySnapshotConsumer(Consumer<byte[]> applySnapshotProcedure) {
- this.applySnapshotProcedure = applySnapshotProcedure;
+ void setSnapshotCohort(final RaftActorSnapshotCohort snapshotCohort) {
+ this.snapshotCohort = snapshotCohort;
+ }
+
+ public Snapshot.@NonNull State convertSnapshot(final ByteSource snapshotBytes) throws IOException {
+ return snapshotCohort.deserializeSnapshot(snapshotBytes);
}
public long getLastSequenceNumber() {
*
* @param lastLogEntry the last log entry for the snapshot.
* @param replicatedToAllIndex the index of the last entry replicated to all followers.
- * @param installSnapshotInitiated true if snapshot is initiated to install on a follower.
* @return a new CaptureSnapshot instance.
*/
- public CaptureSnapshot newCaptureSnapshot(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex,
- boolean installSnapshotInitiated) {
+ public CaptureSnapshot newCaptureSnapshot(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex,
+ final boolean mandatoryTrim) {
TermInformationReader lastAppliedTermInfoReader =
lastAppliedTermInformationReader.init(context.getReplicatedLog(), context.getLastApplied(),
lastLogEntry, hasFollowers());
List<ReplicatedLogEntry> unAppliedEntries = context.getReplicatedLog().getFrom(lastAppliedIndex + 1);
- long lastLogEntryIndex = lastAppliedIndex;
- long lastLogEntryTerm = lastAppliedTerm;
- if (lastLogEntry != null) {
+ final long lastLogEntryIndex;
+ final long lastLogEntryTerm;
+ if (lastLogEntry == null) {
+ // When we don't have journal present, for example two captureSnapshots executed right after another with no
+ // new journal we still want to preserve the index and term in the snapshot.
+ lastAppliedIndex = lastLogEntryIndex = context.getReplicatedLog().getSnapshotIndex();
+ lastAppliedTerm = lastLogEntryTerm = context.getReplicatedLog().getSnapshotTerm();
+
+ log.debug("{}: Capturing Snapshot : lastLogEntry is null. Using snapshot values lastAppliedIndex {} and "
+ + "lastAppliedTerm {} instead.", persistenceId(), lastAppliedIndex, lastAppliedTerm);
+ } else {
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);
+ newReplicatedToAllIndex, newReplicatedToAllTerm, unAppliedEntries, mandatoryTrim);
}
private class AbstractSnapshotState implements SnapshotState {
}
@Override
- public boolean capture(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex) {
+ public boolean capture(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex) {
log.debug("capture should not be called in state {}", this);
return false;
}
@Override
- public boolean captureToInstall(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex,
- String targetFollower) {
+ public boolean captureToInstall(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex,
+ final String targetFollower) {
log.debug("captureToInstall should not be called in state {}", this);
return false;
}
@Override
- public void apply(ApplySnapshot snapshot) {
+ public boolean captureWithForcedTrim(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex) {
+ log.debug("captureWithForcedTrim should not be called in state {}", this);
+ return false;
+ }
+
+ @Override
+ public void apply(final ApplySnapshot snapshot) {
log.debug("apply should not be called in state {}", this);
}
@Override
- public void persist(final byte[] snapshotBytes, final long totalMemory) {
+ public void persist(final Snapshot.State state, final Optional<OutputStream> installSnapshotStream,
+ final long totalMemory) {
log.debug("persist should not be called in state {}", this);
}
@Override
- public void commit(final long sequenceNumber, long timeStamp) {
+ public void commit(final long sequenceNumber, final long timeStamp) {
log.debug("commit should not be called in state {}", this);
}
//use the term of the temp-min, since we check for isPresent, entry will not be null
ReplicatedLogEntry entry = context.getReplicatedLog().get(tempMin);
context.getReplicatedLog().snapshotPreCommit(tempMin, entry.getTerm());
- context.getReplicatedLog().snapshotCommit();
+ context.getReplicatedLog().snapshotCommit(false);
return tempMin;
}
}
@SuppressWarnings("checkstyle:IllegalCatch")
- private boolean capture(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex, String targetFollower) {
- captureSnapshot = newCaptureSnapshot(lastLogEntry, replicatedToAllIndex, targetFollower != null);
+ private boolean capture(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex,
+ final String targetFollower, final boolean mandatoryTrim) {
+ captureSnapshot = newCaptureSnapshot(lastLogEntry, replicatedToAllIndex, mandatoryTrim);
- if (captureSnapshot.isInstallSnapshotInitiated()) {
+ OutputStream installSnapshotStream = null;
+ if (targetFollower != null) {
+ installSnapshotStream = context.getFileBackedOutputStreamFactory().newInstance();
log.info("{}: Initiating snapshot capture {} to install on {}",
persistenceId(), captureSnapshot, targetFollower);
} else {
SnapshotManager.this.currentState = CREATING;
try {
- createSnapshotProcedure.run();
+ createSnapshotProcedure.accept(Optional.ofNullable(installSnapshotStream));
} catch (Exception e) {
SnapshotManager.this.currentState = IDLE;
log.error("Error creating snapshot", e);
}
@Override
- public boolean capture(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex) {
- return capture(lastLogEntry, replicatedToAllIndex, null);
+ public boolean capture(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex) {
+ return capture(lastLogEntry, replicatedToAllIndex, null, false);
}
@Override
- public boolean captureToInstall(ReplicatedLogEntry lastLogEntry, long replicatedToAllIndex,
- String targetFollower) {
- return capture(lastLogEntry, replicatedToAllIndex, targetFollower);
+ public boolean captureToInstall(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex,
+ final String targetFollower) {
+ return capture(lastLogEntry, replicatedToAllIndex, targetFollower, false);
}
@Override
- public void apply(ApplySnapshot toApply) {
+ public boolean captureWithForcedTrim(final ReplicatedLogEntry lastLogEntry, final long replicatedToAllIndex) {
+ return capture(lastLogEntry, replicatedToAllIndex, null, true);
+ }
+
+ @Override
+ public void apply(final ApplySnapshot toApply) {
SnapshotManager.this.applySnapshot = toApply;
lastSequenceNumber = context.getPersistenceProvider().getLastSequenceNumber();
private class Creating extends AbstractSnapshotState {
@Override
- public void persist(final byte[] snapshotBytes, final long totalMemory) {
+ public void persist(final Snapshot.State snapshotState, final Optional<OutputStream> installSnapshotStream,
+ final long totalMemory) {
// create a snapshot object from the state provided and save it
// when snapshot is saved async, SaveSnapshotSuccess is raised.
- Snapshot snapshot = Snapshot.create(snapshotBytes,
+ Snapshot snapshot = Snapshot.create(snapshotState,
captureSnapshot.getUnAppliedEntries(),
captureSnapshot.getLastIndex(), captureSnapshot.getLastTerm(),
captureSnapshot.getLastAppliedIndex(), captureSnapshot.getLastAppliedTerm(),
log.info("{}: Persisting of snapshot done: {}", persistenceId(), snapshot);
- long dataThreshold = totalMemory * context.getConfigParams().getSnapshotDataThresholdPercentage() / 100;
- boolean dataSizeThresholdExceeded = context.getReplicatedLog().dataSize() > dataThreshold;
+ final ConfigParams config = context.getConfigParams();
+ final long absoluteThreshold = config.getSnapshotDataThreshold();
+ final long dataThreshold = absoluteThreshold != 0 ? absoluteThreshold * ConfigParams.MEGABYTE
+ : totalMemory * config.getSnapshotDataThresholdPercentage() / 100;
- boolean logSizeExceededSnapshotBatchCount =
- context.getReplicatedLog().size() >= context.getConfigParams().getSnapshotBatchCount();
+ final boolean dataSizeThresholdExceeded = context.getReplicatedLog().dataSize() > dataThreshold;
+ final boolean logSizeExceededSnapshotBatchCount =
+ context.getReplicatedLog().size() >= config.getSnapshotBatchCount();
final RaftActorBehavior currentBehavior = context.getCurrentBehavior();
- if (dataSizeThresholdExceeded || logSizeExceededSnapshotBatchCount) {
+ if (dataSizeThresholdExceeded || logSizeExceededSnapshotBatchCount || captureSnapshot.isMandatoryTrim()) {
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 {
+ } else if (logSizeExceededSnapshotBatchCount) {
log.debug("{}: log size {} exceeds the snapshot batch count {} - doing snapshotPreCommit with "
+ "index {}", context.getId(), context.getReplicatedLog().size(),
- context.getConfigParams().getSnapshotBatchCount(),
- captureSnapshot.getLastAppliedIndex());
+ config.getSnapshotBatchCount(), captureSnapshot.getLastAppliedIndex());
+ } else {
+ log.debug("{}: user triggered or root overwrite snapshot encountered, trimming log up to "
+ + "last applied index {}", context.getId(), captureSnapshot.getLastAppliedIndex());
}
}
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(snapshot));
+ if (installSnapshotStream.isPresent()) {
+ if (context.getId().equals(currentBehavior.getLeaderId())) {
+ try {
+ ByteSource snapshotBytes = ((FileBackedOutputStream)installSnapshotStream.get()).asByteSource();
+ currentBehavior.handleMessage(context.getActor(),
+ new SendInstallSnapshot(snapshot, snapshotBytes));
+ } catch (IOException e) {
+ log.error("{}: Snapshot install failed due to an unrecoverable streaming error",
+ context.getId(), e);
+ }
+ } else {
+ ((FileBackedOutputStream)installSnapshotStream.get()).cleanup();
+ }
}
captureSnapshot = null;
@Override
@SuppressWarnings("checkstyle:IllegalCatch")
- public void commit(final long sequenceNumber, long timeStamp) {
+ public void commit(final long sequenceNumber, final long timeStamp) {
log.debug("{}: Snapshot success - sequence number: {}", persistenceId(), sequenceNumber);
if (applySnapshot != null) {
context.updatePeerIds(snapshot.getServerConfiguration());
}
- if (snapshot.getState().length > 0 ) {
- applySnapshotProcedure.accept(snapshot.getState());
+ if (!(snapshot.getState() instanceof EmptyState)) {
+ snapshotCohort.applySnapshot(snapshot.getState());
}
applySnapshot.getCallback().onSuccess();
context.getReplicatedLog().snapshotCommit();
}
- context.getPersistenceProvider().deleteSnapshots(new SnapshotSelectionCriteria(sequenceNumber,
+ context.getPersistenceProvider().deleteSnapshots(new SnapshotSelectionCriteria(scala.Long.MaxValue(),
timeStamp - 1, 0L, 0L));
context.getPersistenceProvider().deleteMessages(lastSequenceNumber);
private long index;
private long term;
- LastAppliedTermInformationReader init(ReplicatedLog log, long originalIndex, ReplicatedLogEntry lastLogEntry,
- boolean hasFollowers) {
+ LastAppliedTermInformationReader init(final ReplicatedLog log, final long originalIndex,
+ final ReplicatedLogEntry lastLogEntry, final boolean hasFollowers) {
ReplicatedLogEntry entry = log.get(originalIndex);
this.index = -1L;
this.term = -1L;
private long index;
private long term;
- ReplicatedToAllTermInformationReader init(ReplicatedLog log, long originalIndex) {
+ ReplicatedToAllTermInformationReader init(final ReplicatedLog log, final long originalIndex) {
ReplicatedLogEntry entry = log.get(originalIndex);
this.index = -1L;
this.term = -1L;
Code Review / controller.git / blobdiff