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 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      */
  69     void append(ReplicatedLogEntry replicatedLogEntry);
  70
  71     /**
  72      * Optimization method to increase the capacity of the journal log prior to appending entries.
  73      *
  74      * @param amount the amount to increase by
  75      */
  76     void increaseJournalLogCapacity(int amount);
  77
  78     /**
  79      * Appends an entry to the in-memory log and persists it as well.
  80      *
  81      * @param replicatedLogEntry the entry to append
  82      */
  83     void appendAndPersist(final ReplicatedLogEntry replicatedLogEntry);
  84
  85     void appendAndPersist(ReplicatedLogEntry replicatedLogEntry, Procedure<ReplicatedLogEntry> callback);
  86
  87     /**
  88      * Returns a list of log entries starting from the given index to the end of the log.
  89      *
  90      * @param index the index of the first log entry to get.
  91      * @return the List of entries
  92      */
  93     @Nonnull List<ReplicatedLogEntry> getFrom(long index);
  94
  95     /**
  96      * Returns a list of log entries starting from the given index up to the given maximum of entries or
  97      * the given maximum accumulated size, whichever comes first.
  98      *
  99      * @param index the index of the first log entry to get
 100      * @param maxEntries the maximum number of entries to get
 101      * @param maxDataSize the maximum accumulated size of the log entries to get
 102      * @return the List of entries meeting the criteria.
 103      */
 104     @Nonnull List<ReplicatedLogEntry> getFrom(long index, int maxEntries, long maxDataSize);
 105
 106     /**
 107      *
 108      * @return
 109      */
 110     long size();
 111
 112     /**
 113      * Checks if the entry at the specified index is present or not
 114      *
 115      * @param index the index of the log entry
 116      * @return true if the entry is present in the in-memory journal
 117      */
 118     boolean isPresent(long index);
 119
 120     /**
 121      * Checks if the entry is present in a snapshot
 122      *
 123      * @param index the index of the log entry
 124      * @return true if the entry is in the snapshot. false if the entry is not
 125      * in the snapshot even if the entry may be present in the replicated log
 126      */
 127     boolean isInSnapshot(long index);
 128
 129     /**
 130      * Get the index of the snapshot
 131      *
 132      * @return the index from which the snapshot was created. -1 otherwise.
 133      */
 134     long getSnapshotIndex();
 135
 136     /**
 137      * Get the term of the snapshot
 138      *
 139      * @return the term of the index from which the snapshot was created. -1
 140      * otherwise
 141      */
 142     long getSnapshotTerm();
 143
 144     /**
 145      * sets the snapshot index in the replicated log
 146      * @param snapshotIndex
 147      */
 148     void setSnapshotIndex(long snapshotIndex);
 149
 150     /**
 151      * sets snapshot term
 152      * @param snapshotTerm
 153      */
 154     void setSnapshotTerm(long snapshotTerm);
 155
 156     /**
 157      * Clears the journal entries with startIndex(inclusive) and endIndex (exclusive)
 158      * @param startIndex
 159      * @param endIndex
 160      */
 161     void clear(int startIndex, int endIndex);
 162
 163     /**
 164      * Handles all the bookkeeping in order to perform a rollback in the
 165      * event of SaveSnapshotFailure
 166      * @param snapshotCapturedIndex
 167      * @param snapshotCapturedTerm
 168      */
 169     void snapshotPreCommit(long snapshotCapturedIndex, long snapshotCapturedTerm);
 170
 171     /**
 172      * Sets the Replicated log to state after snapshot success.
 173      */
 174     void snapshotCommit();
 175
 176     /**
 177      * Restores the replicated log to a state in the event of a save snapshot failure
 178      */
 179     void snapshotRollback();
 180
 181     /**
 182      * Size of the data in the log (in bytes)
 183      */
 184     int dataSize();
 185
 186     /**
 187      * We decide if snapshot need to be captured based on the count/memory consumed.
 188      * @param replicatedLogEntry
 189      */
 190     void captureSnapshotIfReady(ReplicatedLogEntry replicatedLogEntry);
 191
 192 }