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

   1 /*
   2  * Copyright (c) 2014 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
   9 package org.opendaylight.controller.cluster.raft;
  10
  11 import akka.japi.Procedure;
  12 import java.util.List;
  13 import javax.annotation.Nonnull;
  14 import javax.annotation.Nullable;
  15
  16 /**
  17  * Represents the ReplicatedLog that needs to be kept in sync by the RaftActor
  18  */
  19 public interface ReplicatedLog {
  20     long NO_MAX_SIZE = -1;
  21
  22     /**
  23      * Return the replicated log entry at the specified index.
  24      *
  25      * @param index the index of the log entry
  26      * @return the ReplicatedLogEntry if found, otherwise null if the adjusted index less than 0 or
  27      * greater than the size of the in-memory journal.
  28      */
  29     @Nullable ReplicatedLogEntry get(long index);
  30
  31     /**
  32      * Return the last replicated log entry in the log or null of not found.
  33      */
  34     @Nullable ReplicatedLogEntry last();
  35
  36     /**
  37      * Return the index of the last entry in the log or -1 if the log is empty.
  38      */
  39     long lastIndex();
  40
  41     /**
  42      * Return the term of the last entry in the log or -1 if the log is empty.
  43      */
  44     long lastTerm();
  45
  46     /**
  47      * Removes entries from the in-memory log starting at the given index.
  48      *
  49      * @param index the index of the first log entry to remove
  50      * @return the adjusted index of the first log entry removed or -1 if the log entry is not found.
  51      */
  52     long removeFrom(long index);
  53
  54     /**
  55      * Removes entries from the in-memory log a nd the persisted log starting at the given index.
  56      * <p>
  57      * The persisted information would then be used during recovery to properly
  58      * reconstruct the state of the in-memory replicated log
  59      *
  60      * @param index the index of the first log entry to remove
  61      */
  62     void removeFromAndPersist(long index);
  63
  64     /**
  65      * Appends an entry to the log.
  66      *
  67      * @param replicatedLogEntry the entry to append
  68      * @return true if the entry was successfully appended, false otherwise. An entry can fail to append if
  69      *         the index is already included in the log.
  70      */
  71     boolean append(ReplicatedLogEntry replicatedLogEntry);
  72
  73     /**
  74      * Optimization method to increase the capacity of the journal log prior to appending entries.
  75      *
  76      * @param amount the amount to increase by
  77      */
  78     void increaseJournalLogCapacity(int amount);
  79
  80     /**
  81      * Appends an entry to the in-memory log and persists it as well.
  82      *
  83      * @param replicatedLogEntry the entry to append
  84      */
  85     void appendAndPersist(final ReplicatedLogEntry replicatedLogEntry);
  86
  87     void appendAndPersist(ReplicatedLogEntry replicatedLogEntry, Procedure<ReplicatedLogEntry> callback);
  88
  89     /**
  90      * Returns a list of log entries starting from the given index to the end of the log.
  91      *
  92      * @param index the index of the first log entry to get.
  93      * @return the List of entries
  94      */
  95     @Nonnull List<ReplicatedLogEntry> getFrom(long index);
  96
  97     /**
  98      * Returns a list of log entries starting from the given index up to the given maximum of entries or
  99      * the given maximum accumulated size, whichever comes first.
 100      *
 101      * @param index the index of the first log entry to get
 102      * @param maxEntries the maximum number of entries to get
 103      * @param maxDataSize the maximum accumulated size of the log entries to get
 104      * @return the List of entries meeting the criteria.
 105      */
 106     @Nonnull List<ReplicatedLogEntry> getFrom(long index, int maxEntries, long maxDataSize);
 107
 108     /**
 109      *
 110      * @return the number of entries in the journal
 111      */
 112     long size();
 113
 114     /**
 115      * Checks if the entry at the specified index is present or not
 116      *
 117      * @param index the index of the log entry
 118      * @return true if the entry is present in the in-memory journal
 119      */
 120     boolean isPresent(long index);
 121
 122     /**
 123      * Checks if the entry is present in a snapshot
 124      *
 125      * @param index the index of the log entry
 126      * @return true if the entry is in the snapshot. false if the entry is not
 127      * in the snapshot even if the entry may be present in the replicated log
 128      */
 129     boolean isInSnapshot(long index);
 130
 131     /**
 132      * Get the index of the snapshot
 133      *
 134      * @return the index from which the snapshot was created. -1 otherwise.
 135      */
 136     long getSnapshotIndex();
 137
 138     /**
 139      * Get the term of the snapshot
 140      *
 141      * @return the term of the index from which the snapshot was created. -1
 142      * otherwise
 143      */
 144     long getSnapshotTerm();
 145
 146     /**
 147      * sets the snapshot index in the replicated log
 148      * @param snapshotIndex
 149      */
 150     void setSnapshotIndex(long snapshotIndex);
 151
 152     /**
 153      * sets snapshot term
 154      * @param snapshotTerm
 155      */
 156     void setSnapshotTerm(long snapshotTerm);
 157
 158     /**
 159      * Clears the journal entries with startIndex(inclusive) and endIndex (exclusive)
 160      * @param startIndex
 161      * @param endIndex
 162      */
 163     void clear(int startIndex, int endIndex);
 164
 165     /**
 166      * Handles all the bookkeeping in order to perform a rollback in the
 167      * event of SaveSnapshotFailure
 168      * @param snapshotCapturedIndex
 169      * @param snapshotCapturedTerm
 170      */
 171     void snapshotPreCommit(long snapshotCapturedIndex, long snapshotCapturedTerm);
 172
 173     /**
 174      * Sets the Replicated log to state after snapshot success.
 175      */
 176     void snapshotCommit();
 177
 178     /**
 179      * Restores the replicated log to a state in the event of a save snapshot failure
 180      */
 181     void snapshotRollback();
 182
 183     /**
 184      * Size of the data in the log (in bytes)
 185      */
 186     int dataSize();
 187
 188     /**
 189      * We decide if snapshot need to be captured based on the count/memory consumed.
 190      * @param replicatedLogEntry
 191      */
 192     void captureSnapshotIfReady(ReplicatedLogEntry replicatedLogEntry);
 193
 194 }