X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-akka-raft%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fraft%2Fmessages%2FInstallSnapshot.java;h=3cd470f6cc6d3c7186dc4fb20324482b216153d7;hp=6337f8f6dce4f9cae5f223c4178f5095fb902c82;hb=HEAD;hpb=0230f37066dfd974accaf36bc712d6f1e60637d0 diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/InstallSnapshot.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/InstallSnapshot.java index 6337f8f6dc..3cd470f6cc 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/InstallSnapshot.java +++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/messages/InstallSnapshot.java @@ -5,28 +5,46 @@ * 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.Optional; -import com.google.protobuf.ByteString; -import org.opendaylight.controller.protobuff.messages.cluster.raft.InstallSnapshotMessages; - -public class InstallSnapshot extends AbstractRaftRPC { - - public static final Class SERIALIZABLE_CLASS = InstallSnapshotMessages.InstallSnapshot.class; +import com.google.common.annotations.VisibleForTesting; +import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; +import java.io.Externalizable; +import java.io.IOException; +import java.io.ObjectInput; +import java.io.ObjectOutput; +import java.util.Optional; +import java.util.OptionalInt; +import org.opendaylight.controller.cluster.raft.RaftVersions; +import org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPayload; + +/** + * Message sent from a leader to install a snapshot chunk on a follower. + */ +public final class InstallSnapshot extends AbstractRaftRPC { + @java.io.Serial private static final long serialVersionUID = 1L; private final String leaderId; private final long lastIncludedIndex; private final long lastIncludedTerm; - private final ByteString data; + private final byte[] data; private final int chunkIndex; private final int totalChunks; - private final Optional lastChunkHashCode; - - public InstallSnapshot(long term, String leaderId, long lastIncludedIndex, - long lastIncludedTerm, ByteString data, int chunkIndex, int totalChunks, Optional lastChunkHashCode) { + @SuppressFBWarnings(value = "SE_BAD_FIELD", justification = "Handled via writeReplace()") + private final OptionalInt lastChunkHashCode; + @SuppressFBWarnings(value = "SE_BAD_FIELD", justification = "Handled via writeReplace()") + private final Optional serverConfig; + private final short recipientRaftVersion; + + @SuppressFBWarnings(value = "EI_EXPOSE_REP2", justification = """ + Stores a reference to an externally mutable byte[] object but this is OK since this class is merely a DTO and \ + does not process byte[] internally. Also it would be inefficient to create a copy as the byte[] could be \ + large.""") + public InstallSnapshot(final long term, final String leaderId, final long lastIncludedIndex, + final long lastIncludedTerm, final byte[] data, final int chunkIndex, final int totalChunks, + final OptionalInt lastChunkHashCode, final Optional serverConfig, + final short recipientRaftVersion) { super(term); this.leaderId = leaderId; this.lastIncludedIndex = lastIncludedIndex; @@ -35,14 +53,18 @@ public class InstallSnapshot extends AbstractRaftRPC { this.chunkIndex = chunkIndex; this.totalChunks = totalChunks; this.lastChunkHashCode = lastChunkHashCode; + this.serverConfig = serverConfig; + this.recipientRaftVersion = recipientRaftVersion; } - public InstallSnapshot(long term, String leaderId, long lastIncludedIndex, - long lastIncludedTerm, ByteString data, int chunkIndex, int totalChunks) { - this(term, leaderId, lastIncludedIndex, lastIncludedTerm, data, chunkIndex, totalChunks, Optional.absent()); + @VisibleForTesting + public InstallSnapshot(final long term, final String leaderId, final long lastIncludedIndex, + final long lastIncludedTerm, final byte[] data, final int chunkIndex, + final int totalChunks) { + this(term, leaderId, lastIncludedIndex, lastIncludedTerm, data, chunkIndex, totalChunks, OptionalInt.empty(), + Optional.empty(), RaftVersions.CURRENT_VERSION); } - public String getLeaderId() { return leaderId; } @@ -55,7 +77,11 @@ public class InstallSnapshot extends AbstractRaftRPC { return lastIncludedTerm; } - public ByteString getData() { + @SuppressFBWarnings(value = "EI_EXPOSE_REP", justification = """ + Exposes a mutable object stored in a field but this is OK since this class is merely a DTO and does not \ + process the byte[] internally. Also it would be inefficient to create a return copy as the byte[] could be \ + large.""") + public byte[] getData() { return data; } @@ -67,39 +93,87 @@ public class InstallSnapshot extends AbstractRaftRPC { return totalChunks; } - public Optional getLastChunkHashCode() { + public OptionalInt getLastChunkHashCode() { return lastChunkHashCode; } - public Object toSerializable(){ - InstallSnapshotMessages.InstallSnapshot.Builder builder = InstallSnapshotMessages.InstallSnapshot.newBuilder() - .setLeaderId(this.getLeaderId()) - .setChunkIndex(this.getChunkIndex()) - .setData(this.getData()) - .setLastIncludedIndex(this.getLastIncludedIndex()) - .setLastIncludedTerm(this.getLastIncludedTerm()) - .setTotalChunks(this.getTotalChunks()); - - if(lastChunkHashCode.isPresent()){ - builder.setLastChunkHashCode(lastChunkHashCode.get()); - } - return builder.build(); + public Optional getServerConfig() { + return serverConfig; + } + + @Override + public String toString() { + return "InstallSnapshot [term=" + getTerm() + ", leaderId=" + leaderId + ", lastIncludedIndex=" + + lastIncludedIndex + ", lastIncludedTerm=" + lastIncludedTerm + ", datasize=" + data.length + + ", Chunk=" + chunkIndex + "/" + totalChunks + ", lastChunkHashCode=" + lastChunkHashCode + + ", serverConfig=" + serverConfig.orElse(null) + "]"; + } + + @Override + Object writeReplace() { + return recipientRaftVersion <= RaftVersions.FLUORINE_VERSION ? new Proxy(this) : new IS(this); } - public static InstallSnapshot fromSerializable (Object o) { - InstallSnapshotMessages.InstallSnapshot from = - (InstallSnapshotMessages.InstallSnapshot) o; + private static class Proxy implements Externalizable { + @java.io.Serial + private static final long serialVersionUID = 1L; - Optional lastChunkHashCode = Optional.absent(); - if(from.hasLastChunkHashCode()){ - lastChunkHashCode = Optional.of(from.getLastChunkHashCode()); + private InstallSnapshot installSnapshot; + + // 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() { + } + + Proxy(final InstallSnapshot installSnapshot) { + this.installSnapshot = installSnapshot; + } + + @Override + public void writeExternal(final ObjectOutput out) throws IOException { + out.writeLong(installSnapshot.getTerm()); + out.writeObject(installSnapshot.leaderId); + out.writeLong(installSnapshot.lastIncludedIndex); + out.writeLong(installSnapshot.lastIncludedTerm); + out.writeInt(installSnapshot.chunkIndex); + out.writeInt(installSnapshot.totalChunks); + + out.writeByte(installSnapshot.lastChunkHashCode.isPresent() ? 1 : 0); + if (installSnapshot.lastChunkHashCode.isPresent()) { + out.writeInt(installSnapshot.lastChunkHashCode.orElseThrow()); + } + + out.writeByte(installSnapshot.serverConfig.isPresent() ? 1 : 0); + if (installSnapshot.serverConfig.isPresent()) { + out.writeObject(installSnapshot.serverConfig.orElseThrow()); + } + + out.writeObject(installSnapshot.data); } - InstallSnapshot installSnapshot = new InstallSnapshot(from.getTerm(), - from.getLeaderId(), from.getLastIncludedIndex(), - from.getLastIncludedTerm(), from.getData(), - from.getChunkIndex(), from.getTotalChunks(), lastChunkHashCode); + @Override + public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException { + long term = in.readLong(); + String leaderId = (String) in.readObject(); + long lastIncludedIndex = in.readLong(); + long lastIncludedTerm = in.readLong(); + int chunkIndex = in.readInt(); + int totalChunks = in.readInt(); - return installSnapshot; + OptionalInt lastChunkHashCode = in.readByte() == 1 ? OptionalInt.of(in.readInt()) : OptionalInt.empty(); + Optional serverConfig = in.readByte() == 1 + ? Optional.of((ServerConfigurationPayload)in.readObject()) : Optional.empty(); + + byte[] data = (byte[])in.readObject(); + + installSnapshot = new InstallSnapshot(term, leaderId, lastIncludedIndex, lastIncludedTerm, data, + chunkIndex, totalChunks, lastChunkHashCode, serverConfig, RaftVersions.CURRENT_VERSION); + } + + @java.io.Serial + private Object readResolve() { + return installSnapshot; + } } }