X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-akka-raft%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fraft%2Fmessages%2FAppendEntries.java;h=892ea3356a58259b5a91b6ab3ea7bcfda8ef70b9;hb=HEAD;hp=4d4b7e4fdd8204bc29dd8a66667a47913e2aca18;hpb=81674d6fd50b419b868d0851062e23f34b34557d;p=controller.git diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/AppendEntries.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/AppendEntries.java index 4d4b7e4fdd..892ea3356a 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/AppendEntries.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/AppendEntries.java @@ -5,30 +5,32 @@ * 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.messages; -import com.google.common.base.Preconditions; +import static java.util.Objects.requireNonNull; + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.collect.ImmutableList; import java.io.Externalizable; import java.io.IOException; import java.io.ObjectInput; import java.io.ObjectOutput; -import java.util.ArrayList; import java.util.List; -import javax.annotation.Nonnull; +import org.eclipse.jdt.annotation.NonNull; +import org.eclipse.jdt.annotation.Nullable; +import org.opendaylight.controller.cluster.raft.RaftVersions; import org.opendaylight.controller.cluster.raft.ReplicatedLogEntry; import org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry; -import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload; /** - * Invoked by leader to replicate log entries (§5.3); also used as - * heartbeat (§5.2). + * Invoked by leader to replicate log entries (§5.3); also used as heartbeat (§5.2). */ -public class AppendEntries extends AbstractRaftRPC { +public final class AppendEntries extends AbstractRaftRPC { + @java.io.Serial private static final long serialVersionUID = 1L; // So that follower can redirect clients - private final String leaderId; + private final @NonNull String leaderId; // Index of log entry immediately preceding new ones private final long prevLogIndex; @@ -37,7 +39,7 @@ public class AppendEntries extends AbstractRaftRPC { private final long prevLogTerm; // log entries to store (empty for heart beat - may send more than one for efficiency) - private final List entries; + private final @NonNull List entries; // leader's commitIndex private final long leaderCommit; @@ -47,21 +49,46 @@ public class AppendEntries extends AbstractRaftRPC { private final short payloadVersion; - public AppendEntries(long term, @Nonnull String leaderId, long prevLogIndex, long prevLogTerm, - @Nonnull List entries, long leaderCommit, long replicatedToAllIndex, - short payloadVersion) { + private final short recipientRaftVersion; + + private final short leaderRaftVersion; + + private final String leaderAddress; + + AppendEntries(final long term, @NonNull final String leaderId, final long prevLogIndex, + final long prevLogTerm, @NonNull final List entries, final long leaderCommit, + final long replicatedToAllIndex, final short payloadVersion, final short recipientRaftVersion, + final short leaderRaftVersion, @Nullable final String leaderAddress) { super(term); - this.leaderId = Preconditions.checkNotNull(leaderId); + this.leaderId = requireNonNull(leaderId); this.prevLogIndex = prevLogIndex; this.prevLogTerm = prevLogTerm; - this.entries = Preconditions.checkNotNull(entries); + this.entries = requireNonNull(entries); this.leaderCommit = leaderCommit; this.replicatedToAllIndex = replicatedToAllIndex; this.payloadVersion = payloadVersion; + this.recipientRaftVersion = recipientRaftVersion; + this.leaderRaftVersion = leaderRaftVersion; + this.leaderAddress = leaderAddress; + } + + public AppendEntries(final long term, final @NonNull String leaderId, final long prevLogIndex, + final long prevLogTerm, final @NonNull List entries, final long leaderCommit, + final long replicatedToAllIndex, final short payloadVersion, final short recipientRaftVersion, + final @Nullable String leaderAddress) { + this(term, leaderId, prevLogIndex, prevLogTerm, entries, leaderCommit, replicatedToAllIndex, payloadVersion, + recipientRaftVersion, RaftVersions.CURRENT_VERSION, leaderAddress); + } + + @VisibleForTesting + public AppendEntries(final long term, final @NonNull String leaderId, final long prevLogIndex, + final long prevLogTerm, final @NonNull List entries, final long leaderCommit, + final long replicatedToAllIndex, final short payloadVersion) { + this(term, leaderId, prevLogIndex, prevLogTerm, entries, leaderCommit, replicatedToAllIndex, payloadVersion, + RaftVersions.CURRENT_VERSION, null); } - @Nonnull - public String getLeaderId() { + public @NonNull String getLeaderId() { return leaderId; } @@ -73,8 +100,7 @@ public class AppendEntries extends AbstractRaftRPC { return prevLogTerm; } - @Nonnull - public List getEntries() { + public @NonNull List getEntries() { return entries; } @@ -90,6 +116,14 @@ public class AppendEntries extends AbstractRaftRPC { return payloadVersion; } + public @Nullable String leaderAddress() { + return leaderAddress; + } + + public short getLeaderRaftVersion() { + return leaderRaftVersion; + } + @Override public String toString() { return "AppendEntries [leaderId=" + leaderId @@ -98,14 +132,22 @@ public class AppendEntries extends AbstractRaftRPC { + ", leaderCommit=" + leaderCommit + ", replicatedToAllIndex=" + replicatedToAllIndex + ", payloadVersion=" + payloadVersion + + ", recipientRaftVersion=" + recipientRaftVersion + + ", leaderRaftVersion=" + leaderRaftVersion + + ", leaderAddress=" + leaderAddress + ", entries=" + entries + "]"; } - private Object writeReplace() { - return new Proxy(this); + @Override + Object writeReplace() { + return recipientRaftVersion <= RaftVersions.FLUORINE_VERSION ? new ProxyV2(this) : new AE(this); } - private static class Proxy implements Externalizable { + /** + * Fluorine version that adds the leader address. + */ + private static class ProxyV2 implements Externalizable { + @java.io.Serial private static final long serialVersionUID = 1L; private AppendEntries appendEntries; @@ -113,15 +155,16 @@ public class AppendEntries extends AbstractRaftRPC { // checkstyle flags the public modifier as redundant which really doesn't make sense since it clearly isn't // redundant. It is explicitly needed for Java serialization to be able to create instances via reflection. @SuppressWarnings("checkstyle:RedundantModifier") - public Proxy() { + public ProxyV2() { } - Proxy(AppendEntries appendEntries) { + ProxyV2(final AppendEntries appendEntries) { this.appendEntries = appendEntries; } @Override - public void writeExternal(ObjectOutput out) throws IOException { + public void writeExternal(final ObjectOutput out) throws IOException { + out.writeShort(appendEntries.leaderRaftVersion); out.writeLong(appendEntries.getTerm()); out.writeObject(appendEntries.leaderId); out.writeLong(appendEntries.prevLogTerm); @@ -136,10 +179,13 @@ public class AppendEntries extends AbstractRaftRPC { out.writeLong(e.getTerm()); out.writeObject(e.getData()); } + + out.writeObject(appendEntries.leaderAddress); } @Override - public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException { + public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException { + short leaderRaftVersion = in.readShort(); long term = in.readLong(); String leaderId = (String) in.readObject(); long prevLogTerm = in.readLong(); @@ -149,15 +195,19 @@ public class AppendEntries extends AbstractRaftRPC { short payloadVersion = in.readShort(); int size = in.readInt(); - List entries = new ArrayList<>(size); + var entries = ImmutableList.builderWithExpectedSize(size); for (int i = 0; i < size; i++) { entries.add(new SimpleReplicatedLogEntry(in.readLong(), in.readLong(), (Payload) in.readObject())); } - appendEntries = new AppendEntries(term, leaderId, prevLogIndex, prevLogTerm, entries, leaderCommit, - replicatedToAllIndex, payloadVersion); + String leaderAddress = (String)in.readObject(); + + appendEntries = new AppendEntries(term, leaderId, prevLogIndex, prevLogTerm, entries.build(), leaderCommit, + replicatedToAllIndex, payloadVersion, RaftVersions.CURRENT_VERSION, leaderRaftVersion, + leaderAddress); } + @java.io.Serial private Object readResolve() { return appendEntries; }