Split up transaction chunks
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / persisted / CommitTransactionPayload.java
index ea5fb532557517e568abcf41fb28118b6a0f648f..73bdd6f31baa98539d1c312a648732d4f1dd316e 100644 (file)
@@ -7,22 +7,31 @@
  */
 package org.opendaylight.controller.cluster.datastore.persisted;
 
+import static com.google.common.base.Verify.verifyNotNull;
+import static java.util.Objects.requireNonNull;
+import static org.opendaylight.controller.cluster.datastore.persisted.ChunkedOutputStream.MAX_ARRAY_SIZE;
+
 import com.google.common.annotations.Beta;
 import com.google.common.annotations.VisibleForTesting;
-import com.google.common.base.Preconditions;
-import com.google.common.io.ByteArrayDataOutput;
 import com.google.common.io.ByteStreams;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import java.io.DataInput;
+import java.io.DataInputStream;
+import java.io.DataOutputStream;
 import java.io.Externalizable;
 import java.io.IOException;
 import java.io.ObjectInput;
 import java.io.ObjectOutput;
 import java.io.Serializable;
+import java.io.StreamCorruptedException;
 import java.util.AbstractMap.SimpleImmutableEntry;
 import java.util.Map.Entry;
 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
+import org.opendaylight.yangtools.concepts.Variant;
+import org.opendaylight.yangtools.yang.data.api.schema.stream.ReusableStreamReceiver;
 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
+import org.opendaylight.yangtools.yang.data.impl.schema.ReusableImmutableNormalizedNodeStreamWriter;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -33,81 +42,142 @@ import org.slf4j.LoggerFactory;
  * @author Robert Varga
  */
 @Beta
-public final class CommitTransactionPayload extends Payload implements Serializable {
+public abstract class CommitTransactionPayload extends Payload implements Serializable {
     private static final Logger LOG = LoggerFactory.getLogger(CommitTransactionPayload.class);
+    private static final long serialVersionUID = 1L;
 
-    private static final class Proxy implements Externalizable {
-        private static final long serialVersionUID = 1L;
-        private byte[] serialized;
+    CommitTransactionPayload() {
 
-        // 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() {
-            // For Externalizable
+    }
+
+    public static CommitTransactionPayload create(final TransactionIdentifier transactionId,
+            final DataTreeCandidate candidate, final int initialSerializedBufferCapacity) throws IOException {
+
+        final ChunkedOutputStream cos = new ChunkedOutputStream(initialSerializedBufferCapacity);
+        try (DataOutputStream dos = new DataOutputStream(cos)) {
+            transactionId.writeTo(dos);
+            DataTreeCandidateInputOutput.writeDataTreeCandidate(dos, candidate);
         }
 
-        Proxy(final byte[] serialized) {
-            this.serialized = Preconditions.checkNotNull(serialized);
+        final Variant<byte[], ChunkedByteArray> source = cos.toVariant();
+        LOG.debug("Initial buffer capacity {}, actual serialized size {}", initialSerializedBufferCapacity, cos.size());
+        return source.isFirst() ? new Simple(source.getFirst()) : new Chunked(source.getSecond());
+    }
+
+    @VisibleForTesting
+    public static CommitTransactionPayload create(final TransactionIdentifier transactionId,
+            final DataTreeCandidate candidate) throws IOException {
+        return create(transactionId, candidate, 512);
+    }
+
+    public Entry<TransactionIdentifier, DataTreeCandidate> getCandidate() throws IOException {
+        return getCandidate(ReusableImmutableNormalizedNodeStreamWriter.create());
+    }
+
+    public final Entry<TransactionIdentifier, DataTreeCandidate> getCandidate(
+            final ReusableStreamReceiver receiver) throws IOException {
+        final DataInput in = newDataInput();
+        return new SimpleImmutableEntry<>(TransactionIdentifier.readFrom(in),
+                DataTreeCandidateInputOutput.readDataTreeCandidate(in, receiver));
+    }
+
+    abstract void writeBytes(ObjectOutput out) throws IOException;
+
+    abstract DataInput newDataInput();
+
+    final Object writeReplace() {
+        return new Proxy(this);
+    }
+
+    private static final class Simple extends CommitTransactionPayload {
+        private static final long serialVersionUID = 1L;
+
+        private final byte[] serialized;
+
+        Simple(final byte[] serialized) {
+            this.serialized = requireNonNull(serialized);
         }
 
         @Override
-        public void writeExternal(final ObjectOutput out) throws IOException {
-            out.writeInt(serialized.length);
-            out.write(serialized);
+        public int size() {
+            return serialized.length;
         }
 
         @Override
-        public void readExternal(final ObjectInput in) throws IOException {
-            final int length = in.readInt();
-            serialized = new byte[length];
-            in.readFully(serialized);
+        DataInput newDataInput() {
+            return ByteStreams.newDataInput(serialized);
         }
 
-        private Object readResolve() {
-            return new CommitTransactionPayload(serialized);
+        @Override
+        void writeBytes(final ObjectOutput out) throws IOException {
+            out.write(serialized);
         }
     }
 
-    private static final long serialVersionUID = 1L;
+    private static final class Chunked extends CommitTransactionPayload {
+        private static final long serialVersionUID = 1L;
 
-    private final byte[] serialized;
+        @SuppressFBWarnings(value = "SE_BAD_FIELD", justification = "Handled via serialization proxy")
+        private final ChunkedByteArray source;
 
-    CommitTransactionPayload(final byte[] serialized) {
-        this.serialized = Preconditions.checkNotNull(serialized);
-    }
+        Chunked(final ChunkedByteArray source) {
+            this.source = requireNonNull(source);
+        }
 
-    public static CommitTransactionPayload create(final TransactionIdentifier transactionId,
-            final DataTreeCandidate candidate, final int initialSerializedBufferCapacity) throws IOException {
-        final ByteArrayDataOutput out = ByteStreams.newDataOutput(initialSerializedBufferCapacity);
-        transactionId.writeTo(out);
-        DataTreeCandidateInputOutput.writeDataTreeCandidate(out, candidate);
-        final byte[] serialized = out.toByteArray();
+        @Override
+        void writeBytes(final ObjectOutput out) throws IOException {
+            source.copyTo(out);
+        }
 
-        LOG.debug("Initial buffer capacity {}, actual serialized size {}",
-                initialSerializedBufferCapacity, serialized.length);
+        @Override
+        public int size() {
+            return source.size();
+        }
 
-        return new CommitTransactionPayload(serialized);
+        @Override
+        DataInput newDataInput() {
+            return new DataInputStream(source.openStream());
+        }
     }
 
-    @VisibleForTesting
-    public static CommitTransactionPayload create(final TransactionIdentifier transactionId,
-            final DataTreeCandidate candidate) throws IOException {
-        return create(transactionId, candidate, 512);
-    }
+    private static final class Proxy implements Externalizable {
+        private static final long serialVersionUID = 1L;
 
-    public Entry<TransactionIdentifier, DataTreeCandidate> getCandidate() throws IOException {
-        final DataInput in = ByteStreams.newDataInput(serialized);
-        return new SimpleImmutableEntry<>(TransactionIdentifier.readFrom(in),
-                DataTreeCandidateInputOutput.readDataTreeCandidate(in));
-    }
+        private CommitTransactionPayload payload;
 
-    @Override
-    public int size() {
-        return serialized.length;
-    }
+        // 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() {
+            // For Externalizable
+        }
 
-    private Object writeReplace() {
-        return new Proxy(serialized);
+        Proxy(final CommitTransactionPayload payload) {
+            this.payload = requireNonNull(payload);
+        }
+
+        @Override
+        public void writeExternal(final ObjectOutput out) throws IOException {
+            out.writeInt(payload.size());
+            payload.writeBytes(out);
+        }
+
+        @Override
+        public void readExternal(final ObjectInput in) throws IOException {
+            final int length = in.readInt();
+            if (length < 0) {
+                throw new StreamCorruptedException("Invalid payload length " + length);
+            } else if (length < MAX_ARRAY_SIZE) {
+                final byte[] serialized = new byte[length];
+                in.readFully(serialized);
+                payload = new Simple(serialized);
+            } else {
+                payload = new Chunked(ChunkedByteArray.readFrom(in, length, MAX_ARRAY_SIZE));
+            }
+        }
+
+        private Object readResolve() {
+            return verifyNotNull(payload);
+        }
     }
 }