[GitHub] [kafka] chia7712 commented on a change in pull request #9563: KAFKA-10684; Avoid additional envelope copies during network transmission
chia7712 commented on a change in pull request #9563:
URL: https://github.com/apache/kafka/pull/9563#discussion_r521762564
##
File path:
clients/src/main/java/org/apache/kafka/common/requests/AbstractResponse.java
##
@@ -88,16 +80,11 @@ protected void updateErrorCounts(Map
errorCounts, Errors error)
protected abstract Struct toStruct(short version);
-public ByteBuffer serializeBody(short version) {
-Struct dataStruct = toStruct(version);
-ByteBuffer buffer = ByteBuffer.allocate(dataStruct.sizeOf());
-dataStruct.writeTo(buffer);
-buffer.flip();
-
-return buffer;
-}
-
-public static AbstractResponse deserializeBody(ByteBuffer byteBuffer,
RequestHeader header) {
+/**
+ * Parse a response from the provided buffer. The buffer is expected to
hold both
+ * the {@link ResponseHeader} as well as the response payload.
+ */
+public static AbstractResponse parseResponse(ByteBuffer byteBuffer,
RequestHeader header) {
Review comment:
sure. Open a jira as follow-up :)
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.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [kafka] chia7712 commented on a change in pull request #9563: KAFKA-10684; Avoid additional envelope copies during network transmission
chia7712 commented on a change in pull request #9563:
URL: https://github.com/apache/kafka/pull/9563#discussion_r521020698
##
File path:
clients/src/main/java/org/apache/kafka/common/protocol/SendBuilder.java
##
@@ -0,0 +1,194 @@
+/*
+ * 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.common.protocol;
+
+import org.apache.kafka.common.network.ByteBufferSend;
+import org.apache.kafka.common.network.Send;
+import org.apache.kafka.common.record.BaseRecords;
+import org.apache.kafka.common.record.MultiRecordsSend;
+import org.apache.kafka.common.requests.RequestHeader;
+import org.apache.kafka.common.requests.ResponseHeader;
+import org.apache.kafka.common.utils.ByteUtils;
+
+import java.nio.ByteBuffer;
+import java.util.ArrayDeque;
+import java.util.Queue;
+
+/**
+ * This class provides a way to build {@link Send} objects for network
transmission
+ * from generated {@link org.apache.kafka.common.protocol.ApiMessage} types
without
+ * allocating new space for "zero-copy" fields (see {@link
#writeByteBuffer(ByteBuffer)}
+ * and {@link #writeRecords(BaseRecords)}).
+ *
+ * See {@link org.apache.kafka.common.requests.EnvelopeRequest#toSend(String,
RequestHeader)}
+ * for example usage.
+ */
+public class SendBuilder implements Writable {
+private final Queue sends = new ArrayDeque<>();
+private final ByteBuffer buffer;
+private final String destinationId;
+
+SendBuilder(String destinationId, int size) {
+this.destinationId = destinationId;
+this.buffer = ByteBuffer.allocate(size);
+this.buffer.mark();
+}
+
+private void flushCurrentBuffer() {
+int latestPosition = buffer.position();
+buffer.reset();
+
+if (latestPosition > buffer.position()) {
+buffer.limit(latestPosition);
+addByteBufferSend(buffer.slice());
+buffer.position(latestPosition);
+buffer.limit(buffer.capacity());
+buffer.mark();
+}
+}
+
+private void addByteBufferSend(ByteBuffer buffer) {
+sends.add(new ByteBufferSend(destinationId, buffer));
+}
+
+@Override
+public void writeByte(byte val) {
+buffer.put(val);
+}
+
+@Override
+public void writeShort(short val) {
+buffer.putShort(val);
+}
+
+@Override
+public void writeInt(int val) {
+buffer.putInt(val);
+}
+
+@Override
+public void writeLong(long val) {
+buffer.putLong(val);
+}
+
+@Override
+public void writeDouble(double val) {
+buffer.putDouble(val);
+}
+
+@Override
+public void writeByteArray(byte[] arr) {
Review comment:
Thanks for your explanation. make sense to me.
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.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [kafka] chia7712 commented on a change in pull request #9563: KAFKA-10684; Avoid additional envelope copies during network transmission
chia7712 commented on a change in pull request #9563:
URL: https://github.com/apache/kafka/pull/9563#discussion_r520530228
##
File path:
generator/src/main/java/org/apache/kafka/message/MessageDataGenerator.java
##
@@ -1529,37 +1516,37 @@ private void generateVariableLengthFieldSize(FieldSpec
field,
if (tagged) {
buffer.printf("int _stringPrefixSize = " +
"ByteUtils.sizeOfUnsignedVarint(_stringBytes.length + 1);%n");
-buffer.printf("_size += _stringBytes.length +
_stringPrefixSize + " +
-
"ByteUtils.sizeOfUnsignedVarint(_stringPrefixSize);%n");
+
buffer.printf("_size.addBytes(_stringBytes.length + _stringPrefixSize + " +
+
"ByteUtils.sizeOfUnsignedVarint(_stringPrefixSize));%n");
} else {
-buffer.printf("_size += _stringBytes.length +
" +
-
"ByteUtils.sizeOfUnsignedVarint(_stringBytes.length + 1);%n");
+
buffer.printf("_size.addBytes(_stringBytes.length + " +
+
"ByteUtils.sizeOfUnsignedVarint(_stringBytes.length + 1));%n");
}
}).
ifNotMember(__ -> {
if (tagged) {
throw new RuntimeException("Tagged field " +
field.name() +
" should not be present in non-flexible
versions.");
}
-buffer.printf("_size += _stringBytes.length +
2;%n");
+buffer.printf("_size.addBytes(_stringBytes.length
+ 2);%n");
}).
generate(buffer);
} else if (field.type().isArray()) {
-buffer.printf("int _arraySize = 0;%n");
+buffer.printf("int _sizeBeforeArray =
_size.totalSize();%n");
Review comment:
```java
if (tagged) {
buffer.printf("int _sizeBeforeArray = _size.totalSize();%n");
}
```
##
File path:
clients/src/main/java/org/apache/kafka/common/requests/AbstractResponse.java
##
@@ -88,16 +80,11 @@ protected void updateErrorCounts(Map
errorCounts, Errors error)
protected abstract Struct toStruct(short version);
-public ByteBuffer serializeBody(short version) {
-Struct dataStruct = toStruct(version);
-ByteBuffer buffer = ByteBuffer.allocate(dataStruct.sizeOf());
-dataStruct.writeTo(buffer);
-buffer.flip();
-
-return buffer;
-}
-
-public static AbstractResponse deserializeBody(ByteBuffer byteBuffer,
RequestHeader header) {
+/**
+ * Parse a response from the provided buffer. The buffer is expected to
hold both
+ * the {@link ResponseHeader} as well as the response payload.
+ */
+public static AbstractResponse parseResponse(ByteBuffer byteBuffer,
RequestHeader header) {
Review comment:
Is this method equal to
https://github.com/apache/kafka/blob/trunk/clients/src/main/java/org/apache/kafka/clients/NetworkClient.java#L727
?
##
File path:
clients/src/main/java/org/apache/kafka/common/protocol/SendBuilder.java
##
@@ -0,0 +1,194 @@
+/*
+ * 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.common.protocol;
+
+import org.apache.kafka.common.network.ByteBufferSend;
+import org.apache.kafka.common.network.Send;
+import org.apache.kafka.common.record.BaseRecords;
+import org.apache.kafka.common.record.MultiRecordsSend;
+import org.apache.kafka.common.requests.RequestHeader;
+import org.apache.kafka.common.requests.ResponseHeader;
+import org.apache.kafka.common.utils.ByteUtils;
+
+import java.nio.ByteBuffer;
+import java.util.ArrayDeque;
+import java.util.Queue;
+
+/**
+ * This class provides a way to build {@link Send} objects for network
transmission
+ * from generated {@link org.apache.kafka.common.protocol.ApiMessage} types
without
+ *
[GitHub] [kafka] chia7712 commented on a change in pull request #9563: KAFKA-10684; Avoid additional envelope copies during network transmission
chia7712 commented on a change in pull request #9563:
URL: https://github.com/apache/kafka/pull/9563#discussion_r519343434
##
File path:
generator/src/main/java/org/apache/kafka/message/MessageDataGenerator.java
##
@@ -1579,58 +1566,58 @@ private void generateVariableLengthFieldSize(FieldSpec
field,
}
if (tagged) {
headerGenerator.addImport(MessageGenerator.BYTE_UTILS_CLASS);
+buffer.printf("int _arraySize = _size.totalSize() -
_sizeBeforeArray;%n");
buffer.printf("_cache.setArraySizeInBytes(%s,
_arraySize);%n",
field.camelCaseName());
-buffer.printf("_size += _arraySize +
ByteUtils.sizeOfUnsignedVarint(_arraySize);%n");
-} else {
-buffer.printf("_size += _arraySize;%n");
+
buffer.printf("_size.addBytes(ByteUtils.sizeOfUnsignedVarint(_arraySize));%n");
}
} else if (field.type().isBytes()) {
+buffer.printf("int _sizeBeforeBytes =
_size.totalSize();%n");
Review comment:
```java
if (tagged) {
buffer.printf("int _sizeBeforeBytes = _size.totalSize();%n");
}
```
##
File path: clients/src/main/java/org/apache/kafka/common/protocol/Message.java
##
@@ -47,7 +47,20 @@
* If the specified version is too new to be supported
* by this software.
*/
-int size(ObjectSerializationCache cache, short version);
+default int size(ObjectSerializationCache cache, short version) {
+MessageSizeAccumulator size = new MessageSizeAccumulator();
+addSize(size, cache, version);
+return size.totalSize();
+}
+
+/**
+ * Add the size of this message to an accumulator.
+ *
+ * @param size The size accumulator to add to
+ * @param cache The serialization size cache to populate.
+ * @param version The version to use.
+ */
+void addSize(MessageSizeAccumulator size, ObjectSerializationCache cache,
short version);
Review comment:
I'm thinking about how to simplify this process.
Could we reuse the method ```void write(Writable writable,
ObjectSerializationCache cache, short version)``` ? Maybe we can create a
```Writable``` instance but it does not write data to any output. Instead, it
calculate the size of buffer according to input data.
##
File path:
clients/src/main/java/org/apache/kafka/common/requests/EnvelopeRequest.java
##
@@ -91,4 +91,14 @@ public AbstractResponse getErrorResponse(int throttleTimeMs,
Throwable e) {
public static EnvelopeRequest parse(ByteBuffer buffer, short version) {
return new EnvelopeRequest(ApiKeys.ENVELOPE.parseRequest(version,
buffer), version);
}
+
+public EnvelopeRequestData data() {
+return data;
+}
+
+@Override
+public Send toSend(String destination, RequestHeader header) {
Review comment:
If all requests are using auto-generated data, should this be default
implementation of ```AbstractRequest```?
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.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [kafka] chia7712 commented on a change in pull request #9563: KAFKA-10684; Avoid additional envelope copies during network transmission
chia7712 commented on a change in pull request #9563:
URL: https://github.com/apache/kafka/pull/9563#discussion_r518564543
##
File path:
clients/src/main/java/org/apache/kafka/common/requests/EnvelopeRequest.java
##
@@ -91,4 +91,14 @@ public AbstractResponse getErrorResponse(int throttleTimeMs,
Throwable e) {
public static EnvelopeRequest parse(ByteBuffer buffer, short version) {
return new EnvelopeRequest(ApiKeys.ENVELOPE.parseRequest(version,
buffer), version);
}
+
+public EnvelopeRequestData data() {
+return data;
+}
+
+@Override
+public Send toSend(String destination, RequestHeader header) {
+return SendBuilder.buildRequestSend(destination, header, this.data);
Review comment:
not sure whether it is ok to ignore the version of EnvelopeRequest.
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.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [kafka] chia7712 commented on a change in pull request #9563: KAFKA-10684; Avoid additional envelope copies during network transmission
chia7712 commented on a change in pull request #9563:
URL: https://github.com/apache/kafka/pull/9563#discussion_r518513351
##
File path: clients/src/main/java/org/apache/kafka/common/protocol/Writable.java
##
@@ -33,6 +35,23 @@
void writeVarint(int i);
void writeVarlong(long i);
+default void writeApiMessage(
Review comment:
It is used by only ```SendBuilder```. How about moving it to
```SendBuilder```?
##
File path: clients/src/main/java/org/apache/kafka/common/protocol/Writable.java
##
@@ -33,6 +35,23 @@
void writeVarint(int i);
void writeVarlong(long i);
+default void writeApiMessage(
+ApiMessage message,
+ObjectSerializationCache serializationCache,
+short version
+) {
+message.write(this, serializationCache, version);
+}
+
+default void writeRecords(BaseRecords records) {
Review comment:
Does it need null check (maybe no-op)?
##
File path:
generator/src/main/java/org/apache/kafka/message/MessageDataGenerator.java
##
@@ -1581,56 +1570,56 @@ private void generateVariableLengthFieldSize(FieldSpec
field,
headerGenerator.addImport(MessageGenerator.BYTE_UTILS_CLASS);
buffer.printf("_cache.setArraySizeInBytes(%s,
_arraySize);%n",
field.camelCaseName());
-buffer.printf("_size += _arraySize +
ByteUtils.sizeOfUnsignedVarint(_arraySize);%n");
+
buffer.printf("_size.addBytes(ByteUtils.sizeOfUnsignedVarint(_arraySize.totalSize()));%n");
+buffer.printf("_size.add(_arraySize);%n");
} else {
-buffer.printf("_size += _arraySize;%n");
+buffer.printf("_size.add(_arraySize);%n");
}
} else if (field.type().isBytes()) {
+buffer.printf("MessageSize _bytesSize = new
MessageSize();%n");
if (field.zeroCopy()) {
-buffer.printf("int _bytesSize = %s.remaining();%n",
field.camelCaseName());
+
buffer.printf("_bytesSize.addZeroCopyBytes(%s.remaining());%n",
field.camelCaseName());
} else {
-buffer.printf("int _bytesSize = %s.length;%n",
field.camelCaseName());
+buffer.printf("_bytesSize.addBytes(%s.length);%n",
field.camelCaseName());
}
VersionConditional.forVersions(fieldFlexibleVersions(field), possibleVersions).
ifMember(__ -> {
headerGenerator.addImport(MessageGenerator.BYTE_UTILS_CLASS);
if (field.zeroCopy()) {
-buffer.printf("_bytesSize += " +
-
"ByteUtils.sizeOfUnsignedVarint(%s.remaining() + 1);%n", field.camelCaseName());
+buffer.printf("_bytesSize.addBytes(" +
+
"ByteUtils.sizeOfUnsignedVarint(%s.remaining() + 1));%n",
field.camelCaseName());
} else {
-buffer.printf("_bytesSize +=
ByteUtils.sizeOfUnsignedVarint(%s.length + 1);%n",
+
buffer.printf("_bytesSize.addBytes(ByteUtils.sizeOfUnsignedVarint(%s.length +
1));%n",
field.camelCaseName());
}
}).
ifNotMember(__ -> {
-buffer.printf("_bytesSize += 4;%n");
+buffer.printf("_bytesSize.addBytes(4);%n");
}).
generate(buffer);
if (tagged) {
headerGenerator.addImport(MessageGenerator.BYTE_UTILS_CLASS);
-buffer.printf("_size += _bytesSize +
ByteUtils.sizeOfUnsignedVarint(_bytesSize);%n");
-} else {
-buffer.printf("_size += _bytesSize;%n");
+
buffer.printf("_size.addBytes(ByteUtils.sizeOfUnsignedVarint(_bytesSize.totalSize()));%n");
}
+buffer.printf("_size.add(_bytesSize);%n");
} else if (field.type().isRecords()) {
-buffer.printf("int _recordsSize = %s.sizeInBytes();%n",
field.camelCaseName());
+buffer.printf("_size.addBytes(%s.sizeInBytes());%n",
field.camelCaseName());
Review comment:
Why it is not ```addZeroCopyBytes```?
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.
For queries about this service, please
[GitHub] [kafka] chia7712 commented on a change in pull request #9563: KAFKA-10684; Avoid additional envelope copies during network transmission
chia7712 commented on a change in pull request #9563:
URL: https://github.com/apache/kafka/pull/9563#discussion_r517824324
##
File path:
clients/src/main/java/org/apache/kafka/common/network/SendBuilder.java
##
@@ -0,0 +1,119 @@
+/*
+ * 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.common.network;
+
+import org.apache.kafka.common.protocol.ObjectSerializationCache;
+import org.apache.kafka.common.protocol.Writable;
+import org.apache.kafka.common.requests.RequestHeader;
+import org.apache.kafka.common.utils.ByteUtils;
+
+import java.nio.ByteBuffer;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * This class provides a way to build {@link Send} objects for network
+ * transmission from generated {@link
org.apache.kafka.common.protocol.ApiMessage}
+ * types. Its main advantage over direct {@link ByteBuffer} allocation based on
+ * {@link
org.apache.kafka.common.protocol.ApiMessage#size(ObjectSerializationCache,
short)}
+ * is that it avoids copying "bytes" fields. The downside is that it is up to
the caller
+ * to allocate a buffer which accounts only for the additional request
overhead.
+ *
+ * See {@link org.apache.kafka.common.requests.EnvelopeRequest#toSend(String,
RequestHeader)}
+ * for example usage.
+ */
+public class SendBuilder implements Writable {
+private final List buffers = new ArrayList<>();
+private final ByteBuffer buffer;
+
+public SendBuilder(ByteBuffer buffer) {
Review comment:
The ```buffer``` is used/owned by ```SendBuilder`` only. It seems to me
this constructor should accept ```capacity(int type)``` rather than
```ByteBuffer```. (SendBuilder should create ```ByteBuffer``` in construction)
##
File path:
clients/src/main/java/org/apache/kafka/common/network/SendBuilder.java
##
@@ -0,0 +1,119 @@
+/*
+ * 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.common.network;
+
+import org.apache.kafka.common.protocol.ObjectSerializationCache;
+import org.apache.kafka.common.protocol.Writable;
+import org.apache.kafka.common.requests.RequestHeader;
+import org.apache.kafka.common.utils.ByteUtils;
+
+import java.nio.ByteBuffer;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * This class provides a way to build {@link Send} objects for network
+ * transmission from generated {@link
org.apache.kafka.common.protocol.ApiMessage}
+ * types. Its main advantage over direct {@link ByteBuffer} allocation based on
+ * {@link
org.apache.kafka.common.protocol.ApiMessage#size(ObjectSerializationCache,
short)}
+ * is that it avoids copying "bytes" fields. The downside is that it is up to
the caller
+ * to allocate a buffer which accounts only for the additional request
overhead.
+ *
+ * See {@link org.apache.kafka.common.requests.EnvelopeRequest#toSend(String,
RequestHeader)}
+ * for example usage.
+ */
+public class SendBuilder implements Writable {
+private final List buffers = new ArrayList<>();
+private final ByteBuffer buffer;
+
+public SendBuilder(ByteBuffer buffer) {
Review comment:
The ```buffer``` is used/owned by ```SendBuilder``` only. It seems to me
this constructor should accept ```capacity(int type)``` rather than
```ByteBuffer```. (SendBuilder should create ```ByteBuffer``` in construction)
This is an automated message from the Apache Git Service.
To respond to
[GitHub] [kafka] chia7712 commented on a change in pull request #9563: KAFKA-10684; Avoid additional envelope copies during network transmission
chia7712 commented on a change in pull request #9563:
URL: https://github.com/apache/kafka/pull/9563#discussion_r517822478
##
File path: clients/src/main/resources/common/message/EnvelopeRequest.json
##
@@ -23,7 +23,7 @@
"fields": [
{ "name": "RequestData", "type": "bytes", "versions": "0+", "zeroCopy":
true,
"about": "The embedded request header and data."},
-{ "name": "RequestPrincipal", "type": "bytes", "versions": "0+",
"zeroCopy": true, "nullableVersions": "0+",
+{ "name": "RequestPrincipal", "type": "bytes", "versions": "0+",
"nullableVersions": "0+",
Review comment:
Is ```nullableVersions`` required? It seems there is no null
handle/check in production for this field.
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.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
