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=81981062177510641c08edb243016075f388ae0f;hpb=3f2221486de63178fbfbb43508ce9466c0b23b73;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 8198106217..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,37 +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.protobuf.GeneratedMessage; +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.ObjectInputStream; -import java.io.ObjectOutputStream; -import java.util.ArrayList; -import java.util.Iterator; +import java.io.ObjectInput; +import java.io.ObjectOutput; import java.util.List; -import java.util.Map; +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.ReplicatedLogImplEntry; -import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload; -import org.opendaylight.controller.protobuff.messages.cluster.raft.AppendEntriesMessages; +import org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry; /** - * 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; - public static final Class LEGACY_SERIALIZABLE_CLASS = - AppendEntriesMessages.AppendEntries.class; - - private static final org.slf4j.Logger LOG = org.slf4j.LoggerFactory.getLogger(AppendEntries.class); - // 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; @@ -43,46 +38,57 @@ public class AppendEntries extends AbstractRaftRPC { // term of prevLogIndex entry private final long prevLogTerm; - // log entries to store (empty for heartbeat; - // may send more than one for efficiency) - private transient List entries; + // log entries to store (empty for heart beat - may send more than one for efficiency) + private final @NonNull List entries; // leader's commitIndex private final long leaderCommit; - public AppendEntries(long term, String leaderId, long prevLogIndex, - long prevLogTerm, List entries, long leaderCommit) { + // index which has been replicated successfully to all followers, -1 if none + private final long replicatedToAllIndex; + + private final 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 = leaderId; + this.leaderId = requireNonNull(leaderId); this.prevLogIndex = prevLogIndex; this.prevLogTerm = prevLogTerm; - this.entries = entries; + this.entries = requireNonNull(entries); this.leaderCommit = leaderCommit; + this.replicatedToAllIndex = replicatedToAllIndex; + this.payloadVersion = payloadVersion; + this.recipientRaftVersion = recipientRaftVersion; + this.leaderRaftVersion = leaderRaftVersion; + this.leaderAddress = leaderAddress; } - private void writeObject(ObjectOutputStream out) throws IOException { - out.writeShort(RaftVersions.CURRENT_VERSION); - out.defaultWriteObject(); - - out.writeInt(entries.size()); - for(ReplicatedLogEntry e: entries) { - out.writeObject(e); - } + 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); } - private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException { - in.readShort(); // version - - in.defaultReadObject(); - - int size = in.readInt(); - entries = new ArrayList<>(size); - for(int i = 0; i < size; i++) { - entries.add((ReplicatedLogEntry) in.readObject()); - } + @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); } - public String getLeaderId() { + public @NonNull String getLeaderId() { return leaderId; } @@ -94,7 +100,7 @@ public class AppendEntries extends AbstractRaftRPC { return prevLogTerm; } - public List getEntries() { + public @NonNull List getEntries() { return entries; } @@ -102,113 +108,108 @@ public class AppendEntries extends AbstractRaftRPC { return leaderCommit; } - @Override - public String toString() { - final StringBuilder sb = - new StringBuilder("AppendEntries{"); - sb.append("term=").append(getTerm()); - sb.append("leaderId='").append(leaderId).append('\''); - sb.append(", prevLogIndex=").append(prevLogIndex); - sb.append(", prevLogTerm=").append(prevLogTerm); - sb.append(", entries=").append(entries); - sb.append(", leaderCommit=").append(leaderCommit); - sb.append('}'); - return sb.toString(); + public long getReplicatedToAllIndex() { + return replicatedToAllIndex; } - public Object toSerializable() { - return toSerializable(RaftVersions.CURRENT_VERSION); + public short getPayloadVersion() { + return payloadVersion; } - public Object toSerializable(short version) { - if(version < RaftVersions.LITHIUM_VERSION) { - return toLegacySerializable(); - } else { - return this; - } + public @Nullable String leaderAddress() { + return leaderAddress; } - @SuppressWarnings({ "rawtypes", "unchecked" }) - private Object toLegacySerializable() { - AppendEntriesMessages.AppendEntries.Builder to = AppendEntriesMessages.AppendEntries.newBuilder(); - to.setTerm(this.getTerm()) - .setLeaderId(this.getLeaderId()) - .setPrevLogTerm(this.getPrevLogTerm()) - .setPrevLogIndex(this.getPrevLogIndex()) - .setLeaderCommit(this.getLeaderCommit()); - - for (ReplicatedLogEntry logEntry : this.getEntries()) { + public short getLeaderRaftVersion() { + return leaderRaftVersion; + } - AppendEntriesMessages.AppendEntries.ReplicatedLogEntry.Builder arBuilder = - AppendEntriesMessages.AppendEntries.ReplicatedLogEntry.newBuilder(); + @Override + public String toString() { + return "AppendEntries [leaderId=" + leaderId + + ", prevLogIndex=" + prevLogIndex + + ", prevLogTerm=" + prevLogTerm + + ", leaderCommit=" + leaderCommit + + ", replicatedToAllIndex=" + replicatedToAllIndex + + ", payloadVersion=" + payloadVersion + + ", recipientRaftVersion=" + recipientRaftVersion + + ", leaderRaftVersion=" + leaderRaftVersion + + ", leaderAddress=" + leaderAddress + + ", entries=" + entries + "]"; + } - AppendEntriesMessages.AppendEntries.ReplicatedLogEntry.Payload.Builder arpBuilder = - AppendEntriesMessages.AppendEntries.ReplicatedLogEntry.Payload.newBuilder(); + @Override + Object writeReplace() { + return recipientRaftVersion <= RaftVersions.FLUORINE_VERSION ? new ProxyV2(this) : new AE(this); + } - //get the client specific payload extensions and add them to the payload builder - Map map = logEntry.getData().encode(); - Iterator> iter = map.entrySet().iterator(); + /** + * Fluorine version that adds the leader address. + */ + private static class ProxyV2 implements Externalizable { + @java.io.Serial + private static final long serialVersionUID = 1L; - while (iter.hasNext()) { - Map.Entry entry = iter.next(); - arpBuilder.setExtension(entry.getKey(), entry.getValue()); - } + private AppendEntries appendEntries; - arpBuilder.setClientPayloadClassName(logEntry.getData().getClientPayloadClassName()); + // 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 ProxyV2() { + } - arBuilder.setData(arpBuilder).setIndex(logEntry.getIndex()).setTerm(logEntry.getTerm()); - to.addLogEntries(arBuilder); + ProxyV2(final AppendEntries appendEntries) { + this.appendEntries = appendEntries; } - return to.build(); - } + @Override + public void writeExternal(final ObjectOutput out) throws IOException { + out.writeShort(appendEntries.leaderRaftVersion); + out.writeLong(appendEntries.getTerm()); + out.writeObject(appendEntries.leaderId); + out.writeLong(appendEntries.prevLogTerm); + out.writeLong(appendEntries.prevLogIndex); + out.writeLong(appendEntries.leaderCommit); + out.writeLong(appendEntries.replicatedToAllIndex); + out.writeShort(appendEntries.payloadVersion); + + out.writeInt(appendEntries.entries.size()); + for (ReplicatedLogEntry e: appendEntries.entries) { + out.writeLong(e.getIndex()); + out.writeLong(e.getTerm()); + out.writeObject(e.getData()); + } - public static AppendEntries fromSerializable(Object serialized) { - if(serialized instanceof AppendEntries) { - return (AppendEntries)serialized; + out.writeObject(appendEntries.leaderAddress); } - else { - return fromLegacySerializable((AppendEntriesMessages.AppendEntries) serialized); - } - } - private static AppendEntries fromLegacySerializable(AppendEntriesMessages.AppendEntries from) { - List logEntryList = new ArrayList<>(); - for (AppendEntriesMessages.AppendEntries.ReplicatedLogEntry leProtoBuff : from.getLogEntriesList()) { - - Payload payload = null ; - try { - if(leProtoBuff.getData() != null && leProtoBuff.getData().getClientPayloadClassName() != null) { - String clientPayloadClassName = leProtoBuff.getData().getClientPayloadClassName(); - payload = (Payload) Class.forName(clientPayloadClassName).newInstance(); - payload = payload.decode(leProtoBuff.getData()); - } else { - LOG.error("Payload is null or payload does not have client payload class name"); - } - - } catch (InstantiationException e) { - LOG.error("InstantiationException when instantiating "+leProtoBuff.getData().getClientPayloadClassName(), e); - } catch (IllegalAccessException e) { - LOG.error("IllegalAccessException when accessing "+leProtoBuff.getData().getClientPayloadClassName(), e); - } catch (ClassNotFoundException e) { - LOG.error("ClassNotFoundException when loading "+leProtoBuff.getData().getClientPayloadClassName(), e); + @Override + 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(); + long prevLogIndex = in.readLong(); + long leaderCommit = in.readLong(); + long replicatedToAllIndex = in.readLong(); + short payloadVersion = in.readShort(); + + int size = in.readInt(); + var entries = ImmutableList.builderWithExpectedSize(size); + for (int i = 0; i < size; i++) { + entries.add(new SimpleReplicatedLogEntry(in.readLong(), in.readLong(), (Payload) in.readObject())); } - ReplicatedLogEntry logEntry = new ReplicatedLogImplEntry( - leProtoBuff.getIndex(), leProtoBuff.getTerm(), payload); - logEntryList.add(logEntry); - } - AppendEntries to = new AppendEntries(from.getTerm(), - from.getLeaderId(), - from.getPrevLogIndex(), - from.getPrevLogTerm(), - logEntryList, - from.getLeaderCommit()); + String leaderAddress = (String)in.readObject(); - return to; - } + appendEntries = new AppendEntries(term, leaderId, prevLogIndex, prevLogTerm, entries.build(), leaderCommit, + replicatedToAllIndex, payloadVersion, RaftVersions.CURRENT_VERSION, leaderRaftVersion, + leaderAddress); + } - public static boolean isSerializedType(Object message) { - return message instanceof AppendEntries || LEGACY_SERIALIZABLE_CLASS.isInstance(message); + @java.io.Serial + private Object readResolve() { + return appendEntries; + } } }