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
  30     ReplicatedLogEntry get(long index);
  31
  32     /**
  33      * Return the last replicated log entry in the log or null of not found.
  34      *
  35      * @return the last replicated log entry in the log or null of not found.
  36      */
  37     @Nullable
  38     ReplicatedLogEntry last();
  39
  40     /**
  41      * Return the index of the last entry in the log or -1 if the log is empty.
  42      *
  43      * @return the index of the last entry in the log or -1 if the log is empty.
  44      */
  45     long lastIndex();
  46
  47     /**
  48      * Return the term of the last entry in the log or -1 if the log is empty.
  49      *
  50      * @return the term of the last entry in the log or -1 if the log is empty.
  51      */
  52     long lastTerm();
  53
  54     /**
  55      * Removes entries from the in-memory log starting at the given index.
  56      *
  57      * @param index the index of the first log entry to remove
  58      * @return the adjusted index of the first log entry removed or -1 if the log entry is not found.
  59      */
  60     long removeFrom(long index);
  61
  62     /**
  63      * Removes entries from the in-memory log and the persisted log starting at the given index.
  64      *
  65      * <p>
  66      * The persisted information would then be used during recovery to properly
  67      * reconstruct the state of the in-memory replicated log
  68      *
  69      * @param index the index of the first log entry to remove
  70      * @return true if entries were removed, false otherwise
  71      */
  72     boolean removeFromAndPersist(long index);
  73
  74     /**
  75      * Appends an entry to the log.
  76      *
  77      * @param replicatedLogEntry the entry to append
  78      * @return true if the entry was successfully appended, false otherwise. An entry can fail to append if
  79      *         the index is already included in the log.
  80      */
  81     boolean append(ReplicatedLogEntry replicatedLogEntry);
  82
  83     /**
  84      * Optimization method to increase the capacity of the journal log prior to appending entries.
  85      *
  86      * @param amount the amount to increase by
  87      */
  88     void increaseJournalLogCapacity(int amount);
  89
  90     /**
  91      * Appends an entry to the in-memory log and persists it as well.
  92      *
  93      * @param replicatedLogEntry the entry to append
  94      */
  95     void appendAndPersist(final ReplicatedLogEntry replicatedLogEntry);
  96
  97     /**
  98      * Appends an entry to the in-memory log and persists it as well.
  99      *
 100      * @param replicatedLogEntry the entry to append
 101      * @param callback the Procedure to be notified when persistence is complete.
 102      */
 103     void appendAndPersist(ReplicatedLogEntry replicatedLogEntry, Procedure<ReplicatedLogEntry> callback);
 104
 105     /**
 106      * Returns a list of log entries starting from the given index to the end of the log.
 107      *
 108      * @param index the index of the first log entry to get.
 109      * @return the List of entries
 110      */
 111     @Nonnull List<ReplicatedLogEntry> getFrom(long index);
 112
 113     /**
 114      * Returns a list of log entries starting from the given index up to the given maximum of entries or
 115      * the given maximum accumulated size, whichever comes first.
 116      *
 117      * @param index the index of the first log entry to get
 118      * @param maxEntries the maximum number of entries to get
 119      * @param maxDataSize the maximum accumulated size of the log entries to get
 120      * @return the List of entries meeting the criteria.
 121      */
 122     @Nonnull List<ReplicatedLogEntry> getFrom(long index, int maxEntries, long maxDataSize);
 123
 124     /**
 125      * Returns the number of entries in the journal.
 126      *
 127      * @return the number of entries
 128      */
 129     long size();
 130
 131     /**
 132      * Checks if the entry at the specified index is present or not.
 133      *
 134      * @param index the index of the log entry
 135      * @return true if the entry is present in the in-memory journal
 136      */
 137     boolean isPresent(long index);
 138
 139     /**
 140      * Checks if the entry is present in a snapshot.
 141      *
 142      * @param index the index of the log entry
 143      * @return true if the entry is in the snapshot. false if the entry is not in the snapshot even if the entry may
 144      *         be present in the replicated log
 145      */
 146     boolean isInSnapshot(long index);
 147
 148     /**
 149      * Returns the index of the snapshot.
 150      *
 151      * @return the index from which the snapshot was created. -1 otherwise.
 152      */
 153     long getSnapshotIndex();
 154
 155     /**
 156      * Returns the term of the snapshot.
 157      *
 158      * @return the term of the index from which the snapshot was created. -1 otherwise
 159      */
 160     long getSnapshotTerm();
 161
 162     /**
 163      * Sets the snapshot index in the replicated log.
 164      *
 165      * @param snapshotIndex the index to set
 166      */
 167     void setSnapshotIndex(long snapshotIndex);
 168
 169     /**
 170      * Sets snapshot term.
 171      *
 172      * @param snapshotTerm the term to set
 173      */
 174     void setSnapshotTerm(long snapshotTerm);
 175
 176     /**
 177      * Clears the journal entries with startIndex (inclusive) and endIndex (exclusive).
 178      *
 179      * @param startIndex the start index (inclusive)
 180      * @param endIndex the end index (exclusive)
 181      */
 182     void clear(int startIndex, int endIndex);
 183
 184     /**
 185      * Handles all the bookkeeping in order to perform a rollback in the event of SaveSnapshotFailure.
 186      *
 187      * @param snapshotCapturedIndex the new snapshot index
 188      * @param snapshotCapturedTerm the new snapshot term
 189      */
 190     void snapshotPreCommit(long snapshotCapturedIndex, long snapshotCapturedTerm);
 191
 192     /**
 193      * Sets the Replicated log to state after snapshot success.
 194      */
 195     void snapshotCommit();
 196
 197     /**
 198      * Restores the replicated log to a state in the event of a save snapshot failure.
 199      */
 200     void snapshotRollback();
 201
 202     /**
 203      * Returns the size of the data in the log (in bytes).
 204      *
 205      * @return the size of the data in the log (in bytes)
 206      */
 207     int dataSize();
 208
 209     /**
 210      * Determines if a snapshot need to be captured based on the count/memory consumed.
 211      *
 212      * @param replicatedLogEntry the last log entry.
 213      */
 214     void captureSnapshotIfReady(ReplicatedLogEntry replicatedLogEntry);
 215 }