2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.cluster.raft;
10 import akka.japi.Procedure;
11 import com.google.common.base.Preconditions;
12 import java.util.Collections;
13 import java.util.List;
14 import javax.annotation.Nonnull;
15 import javax.annotation.Nullable;
16 import org.opendaylight.controller.cluster.raft.persisted.DeleteEntries;
19 * Implementation of ReplicatedLog used by the RaftActor.
21 class ReplicatedLogImpl extends AbstractReplicatedLogImpl {
22 private static final int DATA_SIZE_DIVIDER = 5;
24 private final RaftActorContext context;
25 private long dataSizeSinceLastSnapshot = 0L;
27 private ReplicatedLogImpl(final long snapshotIndex, final long snapshotTerm,
28 final List<ReplicatedLogEntry> unAppliedEntries,
29 final RaftActorContext context) {
30 super(snapshotIndex, snapshotTerm, unAppliedEntries, context.getId());
31 this.context = Preconditions.checkNotNull(context);
34 static ReplicatedLog newInstance(final Snapshot snapshot, final RaftActorContext context) {
35 return new ReplicatedLogImpl(snapshot.getLastAppliedIndex(), snapshot.getLastAppliedTerm(),
36 snapshot.getUnAppliedEntries(), context);
39 static ReplicatedLog newInstance(final RaftActorContext context) {
40 return new ReplicatedLogImpl(-1L, -1L, Collections.<ReplicatedLogEntry>emptyList(), context);
44 public boolean removeFromAndPersist(final long logEntryIndex) {
45 // FIXME: Maybe this should be done after the command is saved
46 long adjustedIndex = removeFrom(logEntryIndex);
47 if (adjustedIndex >= 0) {
48 context.getPersistenceProvider().persist(new DeleteEntries(adjustedIndex), NoopProcedure.instance());
56 public boolean shouldCaptureSnapshot(long logIndex) {
57 final ConfigParams config = context.getConfigParams();
58 final long journalSize = logIndex + 1;
59 final long dataThreshold = context.getTotalMemory() * config.getSnapshotDataThresholdPercentage() / 100;
61 return journalSize % config.getSnapshotBatchCount() == 0 || getDataSizeForSnapshotCheck() > dataThreshold;
65 public void captureSnapshotIfReady(final ReplicatedLogEntry replicatedLogEntry) {
66 if (shouldCaptureSnapshot(replicatedLogEntry.getIndex())) {
67 boolean started = context.getSnapshotManager().capture(replicatedLogEntry,
68 context.getCurrentBehavior().getReplicatedToAllIndex());
69 if (started && !context.hasFollowers()) {
70 dataSizeSinceLastSnapshot = 0;
75 private long getDataSizeForSnapshotCheck() {
76 if (!context.hasFollowers()) {
77 // When we do not have followers we do not maintain an in-memory log
78 // due to this the journalSize will never become anything close to the
79 // snapshot batch count. In fact will mostly be 1.
80 // Similarly since the journal's dataSize depends on the entries in the
81 // journal the journal's dataSize will never reach a value close to the
83 // By maintaining the dataSize outside the journal we are tracking essentially
84 // what we have written to the disk however since we no longer are in
85 // need of doing a snapshot just for the sake of freeing up memory we adjust
86 // the real size of data by the DATA_SIZE_DIVIDER so that we do not snapshot as often
87 // as if we were maintaining a real snapshot
88 return dataSizeSinceLastSnapshot / DATA_SIZE_DIVIDER;
95 public boolean appendAndPersist(@Nonnull final ReplicatedLogEntry replicatedLogEntry,
96 @Nullable final Procedure<ReplicatedLogEntry> callback, boolean doAsync) {
98 context.getLogger().debug("{}: Append log entry and persist {} ", context.getId(), replicatedLogEntry);
100 if (!append(replicatedLogEntry)) {
104 Procedure<ReplicatedLogEntry> persistCallback = persistedLogEntry -> {
105 context.getLogger().debug("{}: persist complete {}", context.getId(), persistedLogEntry);
107 dataSizeSinceLastSnapshot += persistedLogEntry.size();
109 if (callback != null) {
110 callback.apply(persistedLogEntry);
115 context.getPersistenceProvider().persistAsync(replicatedLogEntry, persistCallback);
117 context.getPersistenceProvider().persist(replicatedLogEntry, persistCallback);