Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.controller.cluster.raft;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import org.eclipse.jdt.annotation.NonNull;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Abstract class handling the mapping of
* logical LogEntry Index and the physical list index.
*/
public abstract class AbstractReplicatedLogImpl implements ReplicatedLog {
private static final Logger LOG = LoggerFactory.getLogger(AbstractReplicatedLogImpl.class);
private final String logContext;
// We define this as ArrayList so we can use ensureCapacity.
private ArrayList journal;
private long snapshotIndex = -1;
private long snapshotTerm = -1;
// to be used for rollback during save snapshot failure
private ArrayList snapshottedJournal;
private long previousSnapshotIndex = -1;
private long previousSnapshotTerm = -1;
private int dataSize = 0;
protected AbstractReplicatedLogImpl(final long snapshotIndex, final long snapshotTerm,
final List unAppliedEntries, final String logContext) {
this.snapshotIndex = snapshotIndex;
this.snapshotTerm = snapshotTerm;
this.logContext = logContext;
journal = new ArrayList<>(unAppliedEntries.size());
for (ReplicatedLogEntry entry: unAppliedEntries) {
append(entry);
}
}
protected AbstractReplicatedLogImpl() {
this(-1L, -1L, Collections.emptyList(), "");
}
protected int adjustedIndex(final long logEntryIndex) {
if (snapshotIndex < 0) {
return (int) logEntryIndex;
}
return (int) (logEntryIndex - (snapshotIndex + 1));
}
@Override
public ReplicatedLogEntry get(final long logEntryIndex) {
int adjustedIndex = adjustedIndex(logEntryIndex);
if (adjustedIndex < 0 || adjustedIndex >= journal.size()) {
// physical index should be less than list size and >= 0
return null;
}
return journal.get(adjustedIndex);
}
@Override
public ReplicatedLogEntry last() {
if (journal.isEmpty()) {
return null;
}
// get the last entry directly from the physical index
return journal.get(journal.size() - 1);
}
@Override
public RaftEntryMeta lastMeta() {
return last();
}
@Override
public long lastIndex() {
final var last = last();
// it can happen that after snapshot, all the entries of the journal are trimmed till lastApplied,
// so lastIndex = snapshotIndex
return last != null ? last.index() : snapshotIndex;
}
@Override
public long lastTerm() {
final var last = last();
// it can happen that after snapshot, all the entries of the journal are trimmed till lastApplied,
// so lastTerm = snapshotTerm
return last != null ? last.term() : snapshotTerm;
}
@Override
public long removeFrom(final long logEntryIndex) {
int adjustedIndex = adjustedIndex(logEntryIndex);
if (adjustedIndex < 0 || adjustedIndex >= journal.size()) {
// physical index should be less than list size and >= 0
return -1;
}
for (int i = adjustedIndex; i < journal.size(); i++) {
dataSize -= journal.get(i).size();
}
journal.subList(adjustedIndex , journal.size()).clear();
return adjustedIndex;
}
@Override
public boolean append(final ReplicatedLogEntry replicatedLogEntry) {
final var entryIndex = replicatedLogEntry.index();
final var lastIndex = lastIndex();
if (entryIndex > lastIndex) {
journal.add(replicatedLogEntry);
dataSize += replicatedLogEntry.size();
return true;
}
LOG.warn("{}: Cannot append new entry - new index {} is not greater than the last index {}", logContext,
entryIndex, lastIndex, new Exception("stack trace"));
return false;
}
@Override
public void increaseJournalLogCapacity(final int amount) {
journal.ensureCapacity(journal.size() + amount);
}
@Override
public List getFrom(final long logEntryIndex) {
return getFrom(logEntryIndex, journal.size(), NO_MAX_SIZE);
}
@Override
public List getFrom(final long logEntryIndex, final int maxEntries, final long maxDataSize) {
int adjustedIndex = adjustedIndex(logEntryIndex);
int size = journal.size();
if (adjustedIndex >= 0 && adjustedIndex < size) {
// physical index should be less than list size and >= 0
int maxIndex = adjustedIndex + maxEntries;
if (maxIndex > size) {
maxIndex = size;
}
if (maxDataSize == NO_MAX_SIZE) {
return new ArrayList<>(journal.subList(adjustedIndex, maxIndex));
} else {
return copyJournalEntries(adjustedIndex, maxIndex, maxDataSize);
}
} else {
return Collections.emptyList();
}
}
private @NonNull List copyJournalEntries(final int fromIndex, final int toIndex,
final long maxDataSize) {
final var retList = new ArrayList(toIndex - fromIndex);
long totalSize = 0;
for (int i = fromIndex; i < toIndex; i++) {
final var entry = journal.get(i);
totalSize += entry.serializedSize();
if (totalSize <= maxDataSize) {
retList.add(entry);
} else {
if (retList.isEmpty()) {
// Edge case - the first entry's size exceeds the threshold. We need to return
// at least the first entry so add it here.
retList.add(entry);
}
break;
}
}
return retList;
}
@Override
public long size() {
return journal.size();
}
@Override
public int dataSize() {
return dataSize;
}
@Override
public boolean isPresent(final long logEntryIndex) {
if (logEntryIndex > lastIndex()) {
// if the request logical index is less than the last present in the list
return false;
}
int adjustedIndex = adjustedIndex(logEntryIndex);
return adjustedIndex >= 0;
}
@Override
public boolean isInSnapshot(final long logEntryIndex) {
return logEntryIndex >= 0 && logEntryIndex <= snapshotIndex && snapshotIndex != -1;
}
@Override
public long getSnapshotIndex() {
return snapshotIndex;
}
@Override
public long getSnapshotTerm() {
return snapshotTerm;
}
@Override
public void setSnapshotIndex(final long snapshotIndex) {
this.snapshotIndex = snapshotIndex;
}
@Override
public void setSnapshotTerm(final long snapshotTerm) {
this.snapshotTerm = snapshotTerm;
}
@Override
public void clear(final int startIndex, final int endIndex) {
journal.subList(startIndex, endIndex).clear();
}
@Override
public void snapshotPreCommit(final long snapshotCapturedIndex, final long snapshotCapturedTerm) {
Preconditions.checkArgument(snapshotCapturedIndex >= snapshotIndex,
"snapshotCapturedIndex must be greater than or equal to snapshotIndex");
snapshottedJournal = new ArrayList<>(journal.size());
final var snapshotJournalEntries = journal.subList(0, (int) (snapshotCapturedIndex - snapshotIndex));
snapshottedJournal.addAll(snapshotJournalEntries);
snapshotJournalEntries.clear();
previousSnapshotIndex = snapshotIndex;
setSnapshotIndex(snapshotCapturedIndex);
previousSnapshotTerm = snapshotTerm;
setSnapshotTerm(snapshotCapturedTerm);
}
@Override
public void snapshotCommit(final boolean updateDataSize) {
snapshottedJournal = null;
previousSnapshotIndex = -1;
previousSnapshotTerm = -1;
if (updateDataSize) {
// need to recalc the datasize based on the entries left after precommit.
int newDataSize = 0;
for (ReplicatedLogEntry logEntry : journal) {
newDataSize += logEntry.size();
}
LOG.trace("{}: Updated dataSize from {} to {}", logContext, dataSize, newDataSize);
dataSize = newDataSize;
}
}
@Override
public void snapshotRollback() {
snapshottedJournal.addAll(journal);
journal = snapshottedJournal;
snapshottedJournal = null;
snapshotIndex = previousSnapshotIndex;
previousSnapshotIndex = -1;
snapshotTerm = previousSnapshotTerm;
previousSnapshotTerm = -1;
}
@VisibleForTesting
ReplicatedLogEntry getAtPhysicalIndex(final int index) {
return journal.get(index);
}
}
