lianetm commented on code in PR #22654:
URL: https://github.com/apache/kafka/pull/22654#discussion_r3616213667
##########
clients/src/main/java/org/apache/kafka/clients/producer/internals/RecordAccumulator.java:
##########
@@ -375,46 +379,60 @@ public RecordAppendResult append(String topic,
* @param value The value for the record
* @param headers the Headers for the record
* @param callbacks The callbacks to execute
- * @param buffer The buffer for the new batch
+ * @param recordsBuilderSupplier Supplies the {@link MemoryRecordsBuilder}
for the new
+ * batch. Invoked lazily, only when a new batch is actually
created. The chunked
+ * subclass passes a supplier that produces a builder backed by a
+ * {@link ChunkedByteBufferOutputStream}.
* @param nowMs The current time, in milliseconds
+ * @return the append result, which never has {@code needsNewBatch=true}:
the method either
+ * propagates a non-{@code needsNewBatch} result from an open
batch created concurrently
+ * (a success, or — incremental strategy — a {@code
needsBufferExtension} signal), or it
Review Comment:
yes, that was the intention on the comment: success (appended) OR
needsBufferExtension. Updated it to make it clearer.
##########
clients/src/main/java/org/apache/kafka/clients/producer/internals/ChunkedByteBufferOutputStream.java:
##########
@@ -0,0 +1,328 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.clients.producer.internals;
+
+import org.apache.kafka.common.utils.internals.ByteBufferOutputStream;
+
+import java.nio.ByteBuffer;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * A {@link ByteBufferOutputStream} backed by a linked list of fixed-size
chunks instead of a single
+ * re-allocated buffer. Chunks are supplied by the caller (initial chunks via
the constructor,
+ * additional chunks via {@link #addBuffers(List)}).
+ * <p>
+ * Current/temporary behavior:
+ * <ul>
+ * <li>The stream does not grow on its own: a write whose size exceeds the
remaining free bytes
+ * across all attached chunks throws {@link IllegalStateException}, so the
caller must attach
+ * enough chunks before any such write.
+ * TODO: KAFKA-20579 (automatic mid-write growth for compression
support).</li>
+ * <li>{@link #buffer()} returns the written bytes as a single contiguous
{@link ByteBuffer},
+ * flattening all chunks into a new buffer with an extra copy.
+ * TODO: KAFKA-20580 (remove the extra copy on send, scatter-gather
send).</li>
+ * </ul>
+ */
+public class ChunkedByteBufferOutputStream extends ByteBufferOutputStream {
+
+ private final List<ByteBuffer> chunks;
+ private final int chunkSize;
+ private final BufferPool pool;
+ private ByteBuffer currentChunk;
+ private int currentChunkIndex;
+ // Set once the content has been read for send via buffer().
+ private boolean finalized;
+ // Single-buffer view produced by flatten() and cached here so repeat
buffer() calls
+ // return the same instance. To be removed once scatter-gather
(KAFKA-20580) is implemented.
+ private ByteBuffer flattenedBuffer;
+
+ /**
+ * Constructs a chunked output stream backed by the given pre-allocated
chunks. Ownership of
+ * {@code initialChunks} transfers to this stream (they will be returned
to the pool via
+ * {@link #deallocate()}).
+ *
+ * @param initialChunks pre-allocated chunks. Must be non-empty and each
chunk's capacity must
+ * equal {@code chunkSize}
+ * @param chunkSize the size of each chunk in bytes
+ * @param pool the buffer pool used for deallocation
+ */
+ public ChunkedByteBufferOutputStream(List<ByteBuffer> initialChunks, int
chunkSize, BufferPool pool) {
+ super(validatedFirstChunk(initialChunks, chunkSize));
+ this.chunkSize = chunkSize;
+ this.pool = pool;
+ this.chunks = new ArrayList<>(initialChunks);
+ this.currentChunk = this.chunks.get(0);
+ this.currentChunkIndex = 0;
+ }
+
+ /**
+ * Validates the chunk contract: {@code initialChunks} non-empty, each
chunk's capacity equal to
+ * {@code chunkSize}. Returns the first chunk.
+ */
+ private static ByteBuffer validatedFirstChunk(List<ByteBuffer>
initialChunks, int chunkSize) {
+ if (initialChunks == null || initialChunks.isEmpty())
+ throw new IllegalArgumentException("initialChunks must be
non-empty");
+ for (ByteBuffer chunk : initialChunks) {
+ if (chunk.capacity() != chunkSize)
+ throw new IllegalArgumentException("each chunk must have
capacity " + chunkSize
+ + ", but found a chunk of capacity " + chunk.capacity());
+ }
+ return initialChunks.get(0);
+ }
+
+ @Override
+ public void write(int b) {
+ ensureNotDeallocated();
+ ensureWritable();
+ ensureChunkCapacity(1);
+ currentChunk.put((byte) b);
+ }
+
+ @Override
+ public void write(byte[] bytes, int off, int len) {
+ ensureNotDeallocated();
+ ensureWritable();
+ while (len > 0) {
+ ensureChunkCapacity(1);
+ int toWrite = Math.min(len, currentChunk.remaining());
+ currentChunk.put(bytes, off, toWrite);
+ off += toWrite;
+ len -= toWrite;
+ }
+ }
+
+ @Override
+ public void write(ByteBuffer sourceBuffer) {
+ ensureNotDeallocated();
+ ensureWritable();
+ while (sourceBuffer.hasRemaining()) {
+ ensureChunkCapacity(1);
+ int toWrite = Math.min(sourceBuffer.remaining(),
currentChunk.remaining());
+ int oldLimit = sourceBuffer.limit();
+ sourceBuffer.limit(sourceBuffer.position() + toWrite);
+ currentChunk.put(sourceBuffer);
+ sourceBuffer.limit(oldLimit);
+ }
+ }
+
+ /**
+ * Guards against writes after the stream has been finalized with a call
to {@link #buffer()}.
+ */
+ private void ensureWritable() {
+ if (finalized)
+ throw new IllegalStateException("cannot write after buffer() has
been called");
+ }
+
+ /**
+ * Guards against any use after {@link #deallocate()} has returned the
chunks.
+ */
+ private void ensureNotDeallocated() {
+ if (currentChunk == null)
+ throw new IllegalStateException("operation not allowed after the
stream has been deallocated");
+ }
+
+ private void ensureChunkCapacity(int needed) {
+ while (currentChunk.remaining() < needed) {
+ advanceToNextChunk();
+ }
+ }
+
+ /**
+ * Advances {@code currentChunk} to the next pre-supplied chunk.
+ */
+ private void advanceToNextChunk() {
+ if (currentChunkIndex + 1 >= chunks.size()) {
+ // TODO: KAFKA-20579. With compression support, grow here instead
of throwing.
+ throw new IllegalStateException("write exceeded the stream's
remaining chunk capacity");
+ }
+ currentChunkIndex++;
+ currentChunk = chunks.get(currentChunkIndex);
+ }
+
+ /**
+ * Appends pre-allocated chunks to this stream. Ownership of {@code
newChunks} transfers to
+ * the stream; they will be returned to the pool via {@link #deallocate()}.
+ */
+ public void addBuffers(List<ByteBuffer> newChunks) {
+ ensureNotDeallocated();
+ chunks.addAll(newChunks);
Review Comment:
yes, done
##########
clients/src/main/java/org/apache/kafka/clients/producer/internals/ChunkedByteBufferOutputStream.java:
##########
@@ -0,0 +1,328 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.kafka.clients.producer.internals;
+
+import org.apache.kafka.common.utils.internals.ByteBufferOutputStream;
+
+import java.nio.ByteBuffer;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * A {@link ByteBufferOutputStream} backed by a linked list of fixed-size
chunks instead of a single
+ * re-allocated buffer. Chunks are supplied by the caller (initial chunks via
the constructor,
+ * additional chunks via {@link #addBuffers(List)}).
+ * <p>
+ * Current/temporary behavior:
+ * <ul>
+ * <li>The stream does not grow on its own: a write whose size exceeds the
remaining free bytes
+ * across all attached chunks throws {@link IllegalStateException}, so the
caller must attach
+ * enough chunks before any such write.
+ * TODO: KAFKA-20579 (automatic mid-write growth for compression
support).</li>
+ * <li>{@link #buffer()} returns the written bytes as a single contiguous
{@link ByteBuffer},
+ * flattening all chunks into a new buffer with an extra copy.
+ * TODO: KAFKA-20580 (remove the extra copy on send, scatter-gather
send).</li>
+ * </ul>
+ */
+public class ChunkedByteBufferOutputStream extends ByteBufferOutputStream {
+
+ private final List<ByteBuffer> chunks;
+ private final int chunkSize;
+ private final BufferPool pool;
+ private ByteBuffer currentChunk;
+ private int currentChunkIndex;
+ // Set once the content has been read for send via buffer().
+ private boolean finalized;
+ // Single-buffer view produced by flatten() and cached here so repeat
buffer() calls
+ // return the same instance. To be removed once scatter-gather
(KAFKA-20580) is implemented.
+ private ByteBuffer flattenedBuffer;
+
+ /**
+ * Constructs a chunked output stream backed by the given pre-allocated
chunks. Ownership of
+ * {@code initialChunks} transfers to this stream (they will be returned
to the pool via
+ * {@link #deallocate()}).
+ *
+ * @param initialChunks pre-allocated chunks. Must be non-empty and each
chunk's capacity must
+ * equal {@code chunkSize}
+ * @param chunkSize the size of each chunk in bytes
+ * @param pool the buffer pool used for deallocation
+ */
+ public ChunkedByteBufferOutputStream(List<ByteBuffer> initialChunks, int
chunkSize, BufferPool pool) {
+ super(validatedFirstChunk(initialChunks, chunkSize));
+ this.chunkSize = chunkSize;
+ this.pool = pool;
+ this.chunks = new ArrayList<>(initialChunks);
+ this.currentChunk = this.chunks.get(0);
+ this.currentChunkIndex = 0;
+ }
+
+ /**
+ * Validates the chunk contract: {@code initialChunks} non-empty, each
chunk's capacity equal to
+ * {@code chunkSize}. Returns the first chunk.
+ */
+ private static ByteBuffer validatedFirstChunk(List<ByteBuffer>
initialChunks, int chunkSize) {
+ if (initialChunks == null || initialChunks.isEmpty())
+ throw new IllegalArgumentException("initialChunks must be
non-empty");
+ for (ByteBuffer chunk : initialChunks) {
+ if (chunk.capacity() != chunkSize)
+ throw new IllegalArgumentException("each chunk must have
capacity " + chunkSize
+ + ", but found a chunk of capacity " + chunk.capacity());
+ }
+ return initialChunks.get(0);
+ }
+
+ @Override
+ public void write(int b) {
+ ensureNotDeallocated();
+ ensureWritable();
+ ensureChunkCapacity(1);
+ currentChunk.put((byte) b);
+ }
+
+ @Override
+ public void write(byte[] bytes, int off, int len) {
+ ensureNotDeallocated();
+ ensureWritable();
+ while (len > 0) {
+ ensureChunkCapacity(1);
+ int toWrite = Math.min(len, currentChunk.remaining());
+ currentChunk.put(bytes, off, toWrite);
+ off += toWrite;
+ len -= toWrite;
+ }
+ }
+
+ @Override
+ public void write(ByteBuffer sourceBuffer) {
+ ensureNotDeallocated();
+ ensureWritable();
+ while (sourceBuffer.hasRemaining()) {
+ ensureChunkCapacity(1);
+ int toWrite = Math.min(sourceBuffer.remaining(),
currentChunk.remaining());
+ int oldLimit = sourceBuffer.limit();
+ sourceBuffer.limit(sourceBuffer.position() + toWrite);
+ currentChunk.put(sourceBuffer);
+ sourceBuffer.limit(oldLimit);
+ }
+ }
+
+ /**
+ * Guards against writes after the stream has been finalized with a call
to {@link #buffer()}.
+ */
+ private void ensureWritable() {
+ if (finalized)
+ throw new IllegalStateException("cannot write after buffer() has
been called");
+ }
+
+ /**
+ * Guards against any use after {@link #deallocate()} has returned the
chunks.
+ */
+ private void ensureNotDeallocated() {
+ if (currentChunk == null)
+ throw new IllegalStateException("operation not allowed after the
stream has been deallocated");
+ }
+
+ private void ensureChunkCapacity(int needed) {
+ while (currentChunk.remaining() < needed) {
+ advanceToNextChunk();
+ }
+ }
+
+ /**
+ * Advances {@code currentChunk} to the next pre-supplied chunk.
+ */
+ private void advanceToNextChunk() {
+ if (currentChunkIndex + 1 >= chunks.size()) {
+ // TODO: KAFKA-20579. With compression support, grow here instead
of throwing.
+ throw new IllegalStateException("write exceeded the stream's
remaining chunk capacity");
+ }
+ currentChunkIndex++;
+ currentChunk = chunks.get(currentChunkIndex);
+ }
+
+ /**
+ * Appends pre-allocated chunks to this stream. Ownership of {@code
newChunks} transfers to
+ * the stream; they will be returned to the pool via {@link #deallocate()}.
+ */
+ public void addBuffers(List<ByteBuffer> newChunks) {
+ ensureNotDeallocated();
+ chunks.addAll(newChunks);
+ }
+
+ /**
+ * Returns the written bytes as a single contiguous buffer. Calling this
finalizes the stream: no
+ * further writes are allowed (see {@link #ensureWritable()}) and later
calls return the same
+ * instance, which callers such as {@code
MemoryRecordsBuilder#writeDefaultBatchHeader} rely on
+ * when they write the batch header directly into the returned buffer.
+ */
+ @Override
+ public ByteBuffer buffer() {
+ ensureNotDeallocated();
+ finalized = true;
+ if (flattenedBuffer == null)
+ flattenedBuffer = flatten();
+ return flattenedBuffer;
+ }
+
+ /**
+ * Flattens the written bytes across the data-bearing chunks into a single
new buffer (an extra
+ * copy). This will be removed once scatter-gather send (KAFKA-20580) is
implemented.
+ */
+ private ByteBuffer flatten() {
+ // Written bytes only live in chunks up to currentChunk, later chunks
are untouched.
+ int totalSize = 0;
+ for (int i = 0; i <= currentChunkIndex; i++) {
+ totalSize += chunks.get(i).position();
+ }
+ ByteBuffer flattened = ByteBuffer.allocate(totalSize);
+ for (int i = 0; i <= currentChunkIndex; i++) {
+ ByteBuffer chunk = chunks.get(i);
+ int chunkPos = chunk.position();
+ chunk.flip();
+ flattened.put(chunk);
+ chunk.limit(chunk.capacity());
+ chunk.position(chunkPos);
+ }
+ return flattened;
+ }
+
+ /**
+ * Releases the fully-unused chunks, given that the stream is closed for
appends.
+ */
+ @Override
+ public void close() {
+ releaseUnusedChunks();
+ }
+
+ /**
+ * Return the fully-unused chunks to the pool. The data-bearing chunks are
+ * kept until batch completion ({@link #deallocate()}), as they hold the
in-flight data.
+ */
+ private void releaseUnusedChunks() {
+ if (currentChunk == null) // already deallocated; nothing attached
+ return;
+ List<ByteBuffer> unused = chunks.subList(currentChunkIndex + 1,
chunks.size());
+ if (pool != null) {
+ for (ByteBuffer chunk : unused)
+ pool.deallocate(chunk);
+ }
+ // Remove the released chunks from `chunks`, so they are
+ // not deallocated again on batch completion.
+ unused.clear();
+ }
+
+ /**
+ * Total bytes written across all chunks.
+ */
+ @Override
+ public int position() {
+ ensureNotDeallocated();
+ // Written bytes only live in chunks up to currentChunk, later chunks
are untouched.
+ int total = 0;
+ for (int i = 0; i <= currentChunkIndex; i++) {
+ total += chunks.get(i).position();
+ }
+ return total;
+ }
+
+ /**
+ * Sets the write position, walking across pre-supplied chunks if the
requested position
+ * exceeds the first chunk's capacity. Only valid before any write.
+ */
+ @Override
+ public void position(int position) {
+ ensureNotDeallocated();
+ if (currentChunkIndex != 0 || currentChunk.position() != 0) {
+ throw new IllegalStateException("position() can only be called
before any writes");
+ }
+ int remaining = position;
+ int idx = 0;
+ while (remaining > 0 && idx < chunks.size()) {
+ ByteBuffer chunk = chunks.get(idx);
+ int take = Math.min(remaining, chunk.capacity());
+ chunk.position(take);
+ remaining -= take;
+ if (remaining > 0)
+ idx++;
+ }
+ if (remaining > 0) {
+ throw new IllegalArgumentException("position " + position
+ + " exceeds total pre-allocated capacity");
+ }
+ currentChunkIndex = idx;
+ currentChunk = chunks.get(idx);
+ }
+
+ /**
+ * Total capacity across all attached chunks (written + free).
+ * Every chunk has the same size, so this equals {@code position() +
remaining()} without walking the list.
+ */
+ int attachedCapacity() {
+ ensureNotDeallocated();
+ return chunks.size() * chunkSize;
+ }
+
+ /**
+ * Total bytes available across the current chunk and every queued
(not-yet-active) chunk.
+ */
+ @Override
+ public int remaining() {
+ ensureNotDeallocated();
+ int total = currentChunk.remaining();
+ for (int i = currentChunkIndex + 1; i < chunks.size(); i++)
+ total += chunks.get(i).remaining();
+ return total;
+ }
+
+ @Override
+ public int limit() {
+ return Integer.MAX_VALUE;
+ }
+
+ @Override
+ public int initialCapacity() {
+ return chunkSize;
+ }
+
+ @Override
+ public void ensureRemaining(int remainingBytesRequired) {
+ ensureNotDeallocated();
+ // A single call can guarantee at most `chunkSize` of space (the
stream advances one chunk
+ // at a time). Callers needing more attach chunks via addBuffers
first. write(byte[]) loops
+ // across chunks, so contiguous capacity isn't required.
+ ensureChunkCapacity(Math.min(remainingBytesRequired, chunkSize));
+ }
+
+ /**
+ * Returns all pool-allocated chunks to the buffer pool. Called at batch
completion.
+ */
+ public void deallocate(BufferPool pool) {
+ if (pool != null) {
+ for (ByteBuffer chunk : chunks) {
+ pool.deallocate(chunk);
+ }
+ }
+ chunks.clear();
+ currentChunk = null;
+ currentChunkIndex = 0;
Review Comment:
yes, done
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
