You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@orc.apache.org by GitBox <gi...@apache.org> on 2021/09/16 00:48:55 UTC
[GitHub] [orc] autumnust opened a new pull request #909: Sharing compression output buffer among treeWriter: Refactoring within OutStream for portability
autumnust opened a new pull request #909:
URL: https://github.com/apache/orc/pull/909
<!--
Thanks for sending a pull request! Here are some tips for you:
1. File a JIRA issue first and use it as a prefix of your PR title, e.g., `ORC-001: Fix ABC`.
2. Use your PR title to summarize what this PR proposes instead of describing the problem.
3. Make PR title and description complete because these will be the permanent commit log.
4. If possible, provide a concise and reproducible example to reproduce the issue for a faster review.
5. If the PR is unfinished, use GitHub PR Draft feature.
-->
### What changes were proposed in this pull request?
<!--
Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue.
If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
2. If there is a discussion in the mailing list, please add the link.
-->
There's individual instance of `OutStream` within each TreeWriter created by `WriterContext#createStream` method. Within `OutStream`, there are totally 3 buffers:
- current: the regular input buffer holding uncompressed, unencrypted bytes.
- compress: the output buffer holding compressed bytes
- overflow: same as "compress" but only used when the last compression output is larger than remaining capacity of compress buffer.
Potentially the compress and overflow buffer don't have to be allocated individually within each `OutStream` object, but shared across all of them so to save memory allocation.
This PR is the first step for sharing the compression output buffer, which refactors internal of `OutStream` and make the relevant object bundled together since they are logically related(and details of dealing with overflow doesn't have to be visible). This refactoring makes it easier to share the compression output buffer as a pass-in arguments in the follow-up PR.
### Why are the changes needed?
<!--
Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
-->
For the context of ORC-997, this change makes the compression output buffer, as a single entity, easier to be shared and passed in from caller.
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why it was difficult to add.
-->
There's no functional changes from this PR so passing all existed unit tests. Also added a new test in `TestOutStream` to make sure that, the scenario where `codec.compress()` returns false (meaning the compression output is larger than original input) is also covered in the unit test.
--
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: dev-unsubscribe@orc.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [orc] autumnust commented on a change in pull request #909: ORC-998: Sharing compression output buffer among treeWriter: Refactoring within OutStream for portability
Posted by GitBox <gi...@apache.org>.
autumnust commented on a change in pull request #909:
URL: https://github.com/apache/orc/pull/909#discussion_r743901933
##########
File path: java/core/src/test/org/apache/orc/impl/TestOutStream.java
##########
@@ -59,6 +60,56 @@ public void testFlush() throws Exception {
}
}
+ /**
+ * Creates randomness into whether a compression should be committed or aborted (so that
+ * the isOriginal bits is set to true and data being flushed as uncompressed).
+ * This class should be used for testing purpose only.
+ */
+ private static class TestZlibCodec extends ZlibCodec {
+ private Random rand = new Random();
+
+ @Override
+ public boolean compress(ByteBuffer in, ByteBuffer out, ByteBuffer overflow, Options options) {
+ super.compress(in, out, overflow, options);
+ return rand.nextBoolean();
+ }
+ }
+
+ @Test
+ public void testCompressWithoutEncryption() throws Exception {
+ TestInStream.OutputCollector receiver = new TestInStream.OutputCollector();
+ CompressionCodec codec = new TestZlibCodec();
+ StreamOptions options = new StreamOptions( 1024)
Review comment:
Thanks for reviewing ! Will address.
--
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: dev-unsubscribe@orc.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [orc] guiyanakuang commented on a change in pull request #909: ORC-998: Sharing compression output buffer among treeWriter: Refactoring within OutStream for portability
Posted by GitBox <gi...@apache.org>.
guiyanakuang commented on a change in pull request #909:
URL: https://github.com/apache/orc/pull/909#discussion_r709701898
##########
File path: java/core/src/test/org/apache/orc/impl/TestOutStream.java
##########
@@ -59,6 +60,56 @@ public void testFlush() throws Exception {
}
}
+ /**
+ * Creates randomness into whether a compression should be committed or aborted (so that
+ * the isOriginal bits is set to true and data being flushed as uncompressed).
+ * This class should be used for testing purpose only.
+ */
+ private static class TestZlibCodec extends ZlibCodec {
+ private Random rand = new Random();
+
+ @Override
+ public boolean compress(ByteBuffer in, ByteBuffer out, ByteBuffer overflow, Options options) {
+ super.compress(in, out, overflow, options);
+ return rand.nextBoolean();
+ }
+ }
+
+ @Test
+ public void testCompressWithoutEncryption() throws Exception {
+ TestInStream.OutputCollector receiver = new TestInStream.OutputCollector();
+ CompressionCodec codec = new TestZlibCodec();
+ StreamOptions options = new StreamOptions( 1024)
Review comment:
Extra space. 😄
##########
File path: java/core/src/java/org/apache/orc/impl/OutStream.java
##########
@@ -280,56 +385,24 @@ private void spill() throws java.io.IOException {
outputBuffer(current);
getNewInputBuffer();
} else {
- if (compressed == null) {
- compressed = getNewOutputBuffer();
- } else if (overflow == null) {
- overflow = getNewOutputBuffer();
- }
- int sizePosn = compressed.position();
- compressed.position(compressed.position() + HEADER_SIZE);
- if (codec.compress(current, compressed, overflow, options)) {
- uncompressedBytes = 0;
+ compressedBuffer.init();
+ int currentPosn = compressedBuffer.getCurrentPosn();
+ compressedBuffer.advanceTo(currentPosn + HEADER_SIZE);
+
+ // Worth compression
+ if (codec.compress(current, compressedBuffer.compressed, compressedBuffer.overflow, options)) {
Review comment:
This line exceeds 100 characters.
--
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: dev-unsubscribe@orc.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [orc] autumnust commented on a change in pull request #909: ORC-998: Sharing compression output buffer among treeWriter: Refactoring within OutStream for portability
Posted by GitBox <gi...@apache.org>.
autumnust commented on a change in pull request #909:
URL: https://github.com/apache/orc/pull/909#discussion_r743901933
##########
File path: java/core/src/test/org/apache/orc/impl/TestOutStream.java
##########
@@ -59,6 +60,56 @@ public void testFlush() throws Exception {
}
}
+ /**
+ * Creates randomness into whether a compression should be committed or aborted (so that
+ * the isOriginal bits is set to true and data being flushed as uncompressed).
+ * This class should be used for testing purpose only.
+ */
+ private static class TestZlibCodec extends ZlibCodec {
+ private Random rand = new Random();
+
+ @Override
+ public boolean compress(ByteBuffer in, ByteBuffer out, ByteBuffer overflow, Options options) {
+ super.compress(in, out, overflow, options);
+ return rand.nextBoolean();
+ }
+ }
+
+ @Test
+ public void testCompressWithoutEncryption() throws Exception {
+ TestInStream.OutputCollector receiver = new TestInStream.OutputCollector();
+ CompressionCodec codec = new TestZlibCodec();
+ StreamOptions options = new StreamOptions( 1024)
Review comment:
Thanks for reviewing ! Will address.
--
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: dev-unsubscribe@orc.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [orc] guiyanakuang commented on pull request #909: ORC-998: Sharing compression output buffer among treeWriter: Refactoring within OutStream for portability
Posted by GitBox <gi...@apache.org>.
guiyanakuang commented on pull request #909:
URL: https://github.com/apache/orc/pull/909#issuecomment-954441854
LGTM, Nit: TestOutStream.java line 82 has an extra space
--
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: dev-unsubscribe@orc.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [orc] dongjoon-hyun commented on pull request #909: ORC-998: Sharing compression output buffer among treeWriter: Refactoring within OutStream for portability
Posted by GitBox <gi...@apache.org>.
dongjoon-hyun commented on pull request #909:
URL: https://github.com/apache/orc/pull/909#issuecomment-921060645
Thank you for making a PR, @autumnust .
--
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: dev-unsubscribe@orc.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [orc] autumnust commented on a change in pull request #909: ORC-998: Sharing compression output buffer among treeWriter: Refactoring within OutStream for portability
Posted by GitBox <gi...@apache.org>.
autumnust commented on a change in pull request #909:
URL: https://github.com/apache/orc/pull/909#discussion_r743901933
##########
File path: java/core/src/test/org/apache/orc/impl/TestOutStream.java
##########
@@ -59,6 +60,56 @@ public void testFlush() throws Exception {
}
}
+ /**
+ * Creates randomness into whether a compression should be committed or aborted (so that
+ * the isOriginal bits is set to true and data being flushed as uncompressed).
+ * This class should be used for testing purpose only.
+ */
+ private static class TestZlibCodec extends ZlibCodec {
+ private Random rand = new Random();
+
+ @Override
+ public boolean compress(ByteBuffer in, ByteBuffer out, ByteBuffer overflow, Options options) {
+ super.compress(in, out, overflow, options);
+ return rand.nextBoolean();
+ }
+ }
+
+ @Test
+ public void testCompressWithoutEncryption() throws Exception {
+ TestInStream.OutputCollector receiver = new TestInStream.OutputCollector();
+ CompressionCodec codec = new TestZlibCodec();
+ StreamOptions options = new StreamOptions( 1024)
Review comment:
Thanks for reviewing ! Will address.
--
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: dev-unsubscribe@orc.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org