perf: avoid copying the temp buffer in ByteStringBuilder.result - #3471
Open
pjfanning wants to merge 1 commit into
Open
perf: avoid copying the temp buffer in ByteStringBuilder.result#3471pjfanning wants to merge 1 commit into
pjfanning wants to merge 1 commit into
Conversation
Motivation: `ByteStringBuilder` accumulates writes from `putByte`/`putBytes`/`putInt`/ `asOutputStream` into a temporary array and flushes it in `clearTemp`, which always does `java.util.Arrays.copyOf(_temp, _tempLength)`. On the final flush performed by `result()` that copy is avoidable: the buffer is not needed for further writes at that point, so every builder result pays a full copy of its tail chunk for nothing. Modification: Add a private `clearTempForResult` used only by `result()`. When more than half of the temp buffer holds data, the buffer is handed over to the resulting `ByteString1` instead of being copied, and `_temp`/`_tempCapacity` are reset so that a later write to the builder allocates a fresh buffer rather than mutating the bytes that were handed over. When only a small part of the buffer is used it is still copied, so a small result does not retain a much larger array. The mid-stream `clearTemp` calls made by `addAll` are unchanged, since the buffer is still reused there. Result: No copy of the tail chunk on `result()` for builders that are at least half full. A result produced by the hand-over path can be a non-compact `ByteString1`; that is copy-neutral, because a consumer calling `toArrayUnsafe` on it pays exactly the copy that used to happen inside `clearTemp`, and `ByteStringUtils.toProtoByteStringUnsafe` still takes its zero-copy `asByteBuffers` path for it. Tests: - `sbt "actor-tests/testOnly org.apache.pekko.util.ByteStringSpec"` - 218 tests succeeded, 0 failed - `ByteStringSpec` gains cases for the mostly-used, exactly-filled and small-write-in-a-large-buffer flush paths, that a returned `ByteString` is unaffected by later writes to the builder, and that the content is correct for every fill level from 0 to 200 bytes - `scalafmt --list --mode diff-ref=upstream/main` - no files reported - `git diff --check` - clean - Broader run of `actor-tests/testOnly org.apache.pekko.util.*`, the stream io/compression/framing suites and `actor/mimaReportBinaryIssues` was started but stopped before completing, so it is not recorded as a pass. MiMa is expected to be unaffected: the change adds one private method and alters no signature. References: None - follows the same no-copy approach as apache/pekko-http#1235
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
ByteStringBuilderaccumulates writes fromputByte/putBytes/putInt/asOutputStreaminto a temporary array and flushes it inclearTemp, which always doesjava.util.Arrays.copyOf(_temp, _tempLength). On the final flush performed byresult()that copy is avoidable: the buffer is not needed for further writes at that point, so every builder result pays a full copy of its tail chunk for nothing.Modification
Add a private
clearTempForResultused only byresult():ByteString1instead of being copied, and_temp/_tempCapacityare reset so that a later write to the builder allocates a fresh buffer rather than mutating the bytes that were handed over (every_tempwrite in the class goes throughensureTempSizefirst, andshouldResizeTempForreturns true on_tempCapacity == 0);The mid-stream
clearTempcalls made byaddAllare unchanged, since the buffer is still reused there.Result
No copy of the tail chunk on
result()for builders that are at least half full.A result produced by the hand-over path can be a non-compact
ByteString1. That is copy-neutral: a consumer callingtoArrayUnsafeon it pays exactly the copy that used to happen insideclearTemp, and it is avoided entirely for consumers that do not need an array.ByteStringUtils.toProtoByteStringUnsafestill takes its zero-copyasByteBufferspath for such a value.Tests
sbt "actor-tests/testOnly org.apache.pekko.util.ByteStringSpec"- 218 tests succeeded, 0 failedByteStringSpecgains cases for the mostly-used, exactly-filled and small-write-in-a-large-buffer flush paths, that a returnedByteStringis unaffected by later writes to the builder, and that the content is correct for every fill level from 0 to 200 bytesscalafmt --list --mode diff-ref=upstream/main- no files reportedgit diff --check- cleanactor-tests/testOnly org.apache.pekko.util.*, the stream io/compression/framing suites andactor/mimaReportBinaryIssueswas started but stopped before completing, so it is not recorded as a pass. MiMa is expected to be unaffected: the change adds one private method and alters no signature.References
None - follows the same no-copy approach as apache/pekko-http#1235