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

   1 /*
   2  * Copyright (c) 2015 Cisco 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 static java.util.Objects.requireNonNull;
  11
  12 import akka.japi.Procedure;
  13 import java.util.Collections;
  14 import java.util.List;
  15 import org.opendaylight.controller.cluster.raft.persisted.DeleteEntries;
  16 import org.opendaylight.controller.cluster.raft.persisted.Snapshot;
  17
  18 /**
  19  * Implementation of ReplicatedLog used by the RaftActor.
  20  */
  21 final class ReplicatedLogImpl extends AbstractReplicatedLogImpl {
  22     private static final int DATA_SIZE_DIVIDER = 5;
  23
  24     private final RaftActorContext context;
  25     private long dataSizeSinceLastSnapshot = 0L;
  26
  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 = requireNonNull(context);
  32     }
  33
  34     static ReplicatedLog newInstance(final Snapshot snapshot, final RaftActorContext context) {
  35         return new ReplicatedLogImpl(snapshot.getLastAppliedIndex(), snapshot.getLastAppliedTerm(),
  36                 snapshot.getUnAppliedEntries(), context);
  37     }
  38
  39     static ReplicatedLog newInstance(final RaftActorContext context) {
  40         return new ReplicatedLogImpl(-1L, -1L, Collections.<ReplicatedLogEntry>emptyList(), context);
  41     }
  42
  43     @Override
  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());
  49             return true;
  50         }
  51
  52         return false;
  53     }
  54
  55     @Override
  56     public boolean shouldCaptureSnapshot(final long logIndex) {
  57         final ConfigParams config = context.getConfigParams();
  58         final long journalSize = logIndex + 1;
  59         final long dataThreshold = context.getTotalMemory() * config.getSnapshotDataThresholdPercentage() / 100;
  60
  61         return journalSize % config.getSnapshotBatchCount() == 0 || getDataSizeForSnapshotCheck() > dataThreshold;
  62     }
  63
  64     @Override
  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;
  71             }
  72         }
  73     }
  74
  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
  82             // memory threshold.
  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;
  89         } else {
  90             return dataSize();
  91         }
  92     }
  93
  94     @Override
  95     public boolean appendAndPersist(final ReplicatedLogEntry replicatedLogEntry,
  96             final Procedure<ReplicatedLogEntry> callback, final boolean doAsync)  {
  97
  98         context.getLogger().debug("{}: Append log entry and persist {} ", context.getId(), replicatedLogEntry);
  99
 100         if (!append(replicatedLogEntry)) {
 101             return false;
 102         }
 103
 104         Procedure<ReplicatedLogEntry> persistCallback = persistedLogEntry -> {
 105             context.getLogger().debug("{}: persist complete {}", context.getId(), persistedLogEntry);
 106
 107             dataSizeSinceLastSnapshot += persistedLogEntry.size();
 108
 109             if (callback != null) {
 110                 callback.apply(persistedLogEntry);
 111             }
 112         };
 113
 114         if (doAsync) {
 115             context.getPersistenceProvider().persistAsync(replicatedLogEntry, persistCallback);
 116         } else {
 117             context.getPersistenceProvider().persist(replicatedLogEntry, persistCallback);
 118         }
 119
 120         return true;
 121     }
 122 }