Bug 8206: Fix IOException from initiateCaptureSnapshot
[controller.git] / opendaylight / md-sal / sal-akka-raft / src / main / java / org / opendaylight / controller / cluster / raft / behaviors / LeaderInstallSnapshotState.java
index 81c3eff45180b70b6c5001563bfba394dbc87c4e..3b4c7d813309a3ddb0b03520ebf1254623578339 100644 (file)
@@ -7,7 +7,10 @@
  */
 package org.opendaylight.controller.cluster.raft.behaviors;
 
-import com.google.protobuf.ByteString;
+import com.google.common.base.Throwables;
+import com.google.common.io.ByteSource;
+import java.io.IOException;
+import java.io.InputStream;
 import java.util.Arrays;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -15,7 +18,7 @@ import org.slf4j.LoggerFactory;
 /**
  * Encapsulates the leader state and logic for sending snapshot chunks to a follower.
  */
-public final class LeaderInstallSnapshotState {
+public final class LeaderInstallSnapshotState implements AutoCloseable {
     private static final Logger LOG = LoggerFactory.getLogger(LeaderInstallSnapshotState.class);
 
     // The index of the first chunk that is sent when installing a snapshot
@@ -27,39 +30,46 @@ public final class LeaderInstallSnapshotState {
     // This would be passed as the hash code of the last chunk when sending the first chunk
     static final int INITIAL_LAST_CHUNK_HASH_CODE = -1;
 
-    private int snapshotChunkSize;
-    private final ByteString snapshotBytes;
+    private final int snapshotChunkSize;
     private final String logName;
+    private ByteSource snapshotBytes;
     private int offset = 0;
     // the next snapshot chunk is sent only if the replyReceivedForOffset matches offset
-    private int replyReceivedForOffset;
+    private int replyReceivedForOffset = -1;
     // if replyStatus is false, the previous chunk is attempted
     private boolean replyStatus = false;
-    private int chunkIndex;
-    private final int totalChunks;
+    private int chunkIndex = FIRST_CHUNK_INDEX;
+    private int totalChunks;
     private int lastChunkHashCode = INITIAL_LAST_CHUNK_HASH_CODE;
     private int nextChunkHashCode = INITIAL_LAST_CHUNK_HASH_CODE;
+    private long snapshotSize;
+    private InputStream snapshotInputStream;
 
-    LeaderInstallSnapshotState(ByteString snapshotBytes, int snapshotChunkSize, String logName) {
+    LeaderInstallSnapshotState(int snapshotChunkSize, String logName) {
         this.snapshotChunkSize = snapshotChunkSize;
-        this.snapshotBytes = snapshotBytes;
         this.logName = logName;
-        int size = snapshotBytes.size();
-        totalChunks = size / snapshotChunkSize +
-                (size % snapshotChunkSize > 0 ? 1 : 0);
+    }
+
+    void setSnapshotBytes(ByteSource snapshotBytes) throws IOException {
+        if (this.snapshotBytes != null) {
+            return;
+        }
+
+        snapshotSize = snapshotBytes.size();
+        snapshotInputStream = snapshotBytes.openStream();
 
-        LOG.debug("{}: Snapshot {} bytes, total chunks to send: {}", logName, size, totalChunks);
+        this.snapshotBytes = snapshotBytes;
+
+        totalChunks = (int) (snapshotSize / snapshotChunkSize + (snapshotSize % snapshotChunkSize > 0 ? 1 : 0));
+
+        LOG.debug("{}: Snapshot {} bytes, total chunks to send: {}", logName, snapshotSize, totalChunks);
 
         replyReceivedForOffset = -1;
         chunkIndex = FIRST_CHUNK_INDEX;
     }
 
-    ByteString getSnapshotBytes() {
-        return snapshotBytes;
-    }
-
     int incrementOffset() {
-        if(replyStatus) {
+        if (replyStatus) {
             // if prev chunk failed, we would want to sent the same chunk again
             offset = offset + snapshotChunkSize;
         }
@@ -84,7 +94,8 @@ public final class LeaderInstallSnapshotState {
 
     boolean canSendNextChunk() {
         // we only send a false if a chunk is sent but we have not received a reply yet
-        return replyReceivedForOffset == offset;
+        return snapshotBytes != null && (nextChunkHashCode == INITIAL_LAST_CHUNK_HASH_CODE
+                || replyReceivedForOffset == offset);
     }
 
     boolean isLastChunk(int index) {
@@ -104,34 +115,64 @@ public final class LeaderInstallSnapshotState {
         }
     }
 
-    byte[] getNextChunk() {
-        int snapshotLength = getSnapshotBytes().size();
+    byte[] getNextChunk() throws IOException {
         int start = incrementOffset();
         int size = snapshotChunkSize;
-        if (snapshotChunkSize > snapshotLength) {
-            size = snapshotLength;
-        } else if (start + snapshotChunkSize > snapshotLength) {
-            size = snapshotLength - start;
+        if (snapshotChunkSize > snapshotSize) {
+            size = (int) snapshotSize;
+        } else if (start + snapshotChunkSize > snapshotSize) {
+            size = (int) (snapshotSize - start);
         }
 
         byte[] nextChunk = new byte[size];
-        getSnapshotBytes().copyTo(nextChunk, start, 0, size);
+        int numRead = snapshotInputStream.read(nextChunk);
+        if (numRead != size) {
+            throw new IOException(String.format(
+                    "The # of bytes read from the input stream, %d, does not match the expected # %d", numRead, size));
+        }
+
         nextChunkHashCode = Arrays.hashCode(nextChunk);
 
         LOG.debug("{}: Next chunk: total length={}, offset={}, size={}, hashCode={}", logName,
-                snapshotLength, start, size, nextChunkHashCode);
+                snapshotSize, start, size, nextChunkHashCode);
         return nextChunk;
     }
 
     /**
-     * reset should be called when the Follower needs to be sent the snapshot from the beginning
+     * Reset should be called when the Follower needs to be sent the snapshot from the beginning.
      */
-    void reset(){
+    void reset() {
+        closeStream();
+
         offset = 0;
         replyStatus = false;
         replyReceivedForOffset = offset;
         chunkIndex = FIRST_CHUNK_INDEX;
         lastChunkHashCode = INITIAL_LAST_CHUNK_HASH_CODE;
+
+        try {
+            snapshotInputStream = snapshotBytes.openStream();
+        } catch (IOException e) {
+            throw Throwables.propagate(e);
+        }
+    }
+
+    @Override
+    public void close() {
+        closeStream();
+        snapshotBytes = null;
+    }
+
+    private void closeStream() {
+        if (snapshotInputStream != null) {
+            try {
+                snapshotInputStream.close();
+            } catch (IOException e) {
+                LOG.warn("{}: Error closing snapshot stream", logName);
+            }
+
+            snapshotInputStream = null;
+        }
     }
 
     int getLastChunkHashCode() {