diff --git a/NOTICE.txt b/NOTICE.txt index 19ac33c57a..9b71e46658 100644 --- a/NOTICE.txt +++ b/NOTICE.txt @@ -122,6 +122,14 @@ and decompression library written by Adrien Grand. It can be obtained at: * HOMEPAGE: * https://github.com/jpountz/lz4-java +This product optionally depends on 'lzma-java', a LZMA Java compression +and decompression library, which can be obtained at: + + * LICENSE: + * license/LICENSE.lzma-java.txt (Apache License 2.0) + * HOMEPAGE: + * https://github.com/jponge/lzma-java + This product contains a modified portion of 'jfastlz', a Java port of FastLZ compression and decompression library written by William Kinney. It can be obtained at: diff --git a/codec/pom.xml b/codec/pom.xml index 7d96f7dc47..bb3501e136 100644 --- a/codec/pom.xml +++ b/codec/pom.xml @@ -59,6 +59,11 @@ lz4 true + + com.github.jponge + lzma-java + true + diff --git a/codec/src/main/java/io/netty/handler/codec/compression/LzmaFrameEncoder.java b/codec/src/main/java/io/netty/handler/codec/compression/LzmaFrameEncoder.java new file mode 100644 index 0000000000..f502983517 --- /dev/null +++ b/codec/src/main/java/io/netty/handler/codec/compression/LzmaFrameEncoder.java @@ -0,0 +1,215 @@ +/* + * Copyright 2014 The Netty Project + * + * The Netty Project 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 io.netty.handler.codec.compression; + +import io.netty.buffer.ByteBuf; +import io.netty.buffer.ByteBufInputStream; +import io.netty.buffer.ByteBufOutputStream; +import io.netty.channel.ChannelHandlerContext; +import io.netty.handler.codec.MessageToByteEncoder; +import io.netty.util.internal.logging.InternalLogger; +import io.netty.util.internal.logging.InternalLoggerFactory; +import lzma.sdk.lzma.Base; +import lzma.sdk.lzma.Encoder; + +import java.io.InputStream; + +import static lzma.sdk.lzma.Encoder.*; + +/** + * Compresses a {@link ByteBuf} using the LZMA algorithm. + * + * See LZMA + * and LZMA format + * or documents in LZMA SDK archive. + */ +public class LzmaFrameEncoder extends MessageToByteEncoder { + + private static final InternalLogger logger = InternalLoggerFactory.getInstance(LzmaFrameEncoder.class); + + private static final int MEDIUM_DICTIONARY_SIZE = 1 << 16; + + private static final int MIN_FAST_BYTES = 5; + private static final int MEDIUM_FAST_BYTES = 0x20; + private static final int MAX_FAST_BYTES = Base.kMatchMaxLen; + + private static final int DEFAULT_MATCH_FINDER = EMatchFinderTypeBT4; + + private static final int DEFAULT_LC = 3; + private static final int DEFAULT_LP = 0; + private static final int DEFAULT_PB = 2; + + /** + * Underlying LZMA encoder in use. + */ + private final Encoder encoder; + + /** + * The Properties field contains three properties which are encoded using the following formula: + * + *

{@code Properties = (pb * 5 + lp) * 9 + lc}

+ * + * The field consists of + *
    + *
  1. the number of literal context bits (lc, [0, 8]);
    2. + *
  2. the number of literal position bits (lp, [0, 4]);
    3. + *
  3. the number of position bits (pb, [0, 4]).
    4. + *
+ */ + private final byte properties; + + /** + * Dictionary Size is stored as an unsigned 32-bit little endian integer. + */ + private final int littleEndianDictionarySize; + + /** + * For log warning only once. + */ + private static boolean warningLogged; + + /** + * Creates LZMA encoder with default settings. + */ + public LzmaFrameEncoder() { + this(MEDIUM_DICTIONARY_SIZE); + } + + /** + * Creates LZMA encoder with specified {@code lc}, {@code lp}, {@code pb} + * values and the medium dictionary size of {@value #MEDIUM_DICTIONARY_SIZE}. + */ + public LzmaFrameEncoder(int lc, int lp, int pb) { + this(lc, lp, pb, MEDIUM_DICTIONARY_SIZE); + } + + /** + * Creates LZMA encoder with specified dictionary size and default values of + * {@code lc} = {@value #DEFAULT_LC}, + * {@code lp} = {@value #DEFAULT_LP}, + * {@code pb} = {@value #DEFAULT_PB}. + */ + public LzmaFrameEncoder(int dictionarySize) { + this(DEFAULT_LC, DEFAULT_LP, DEFAULT_PB, dictionarySize); + } + + /** + * Creates LZMA encoder with specified {@code lc}, {@code lp}, {@code pb} values and custom dictionary size. + */ + public LzmaFrameEncoder(int lc, int lp, int pb, int dictionarySize) { + this(lc, lp, pb, dictionarySize, false, MEDIUM_FAST_BYTES); + } + + /** + * Creates LZMA encoder with specified settings. + * + * @param lc + * the number of "literal context" bits, available values [0, 8], default value {@value #DEFAULT_LC}. + * @param lp + * the number of "literal position" bits, available values [0, 4], default value {@value #DEFAULT_LP}. + * @param pb + * the number of "position" bits, available values [0, 4], default value {@value #DEFAULT_PB}. + * @param dictionarySize + * available values [0, {@link java.lang.Integer#MAX_VALUE}], + * default value is {@value #MEDIUM_DICTIONARY_SIZE}. + * @param endMarkerMode + * indicates should {@link LzmaFrameEncoder} use end of stream marker or not. + * Note, that {@link LzmaFrameEncoder} always sets size of uncompressed data + * in LZMA header, so EOS marker is unnecessary. But you may use it for + * better portability. For full description see "LZMA Decoding modes" section + * of LZMA-Specification.txt in official LZMA SDK. + * @param numFastBytes + * available values [{@value #MIN_FAST_BYTES}, {@value #MAX_FAST_BYTES}]. + */ + public LzmaFrameEncoder(int lc, int lp, int pb, int dictionarySize, boolean endMarkerMode, int numFastBytes) { + if (lc < 0 || lc > 8) { + throw new IllegalArgumentException("lc: " + lc + " (expected: 0-8)"); + } + if (lp < 0 || lp > 4) { + throw new IllegalArgumentException("lp: " + lp + " (expected: 0-4)"); + } + if (pb < 0 || pb > 4) { + throw new IllegalArgumentException("pb: " + pb + " (expected: 0-4)"); + } + if (lc + pb > 4) { + if (!warningLogged) { + logger.warn("The latest versions of LZMA libraries (for example, XZ Utils) " + + "has an additional requirement: lc + lp <= 4. Data which don't follow " + + "this requirement cannot be decompressed with this libraries."); + warningLogged = true; + } + } + if (dictionarySize < 0) { + throw new IllegalArgumentException("dictionarySize: " + dictionarySize + " (expected: 0+)"); + } + if (numFastBytes < MIN_FAST_BYTES || numFastBytes > MAX_FAST_BYTES) { + throw new IllegalArgumentException(String.format( + "numFastBytes: %d (expected: %d-%d)", numFastBytes, MIN_FAST_BYTES, MAX_FAST_BYTES + )); + } + + encoder = new Encoder(); + encoder.setDictionarySize(dictionarySize); + encoder.setEndMarkerMode(endMarkerMode); + encoder.setMatchFinder(DEFAULT_MATCH_FINDER); + encoder.setNumFastBytes(numFastBytes); + encoder.setLcLpPb(lc, lp, pb); + + properties = (byte) ((pb * 5 + lp) * 9 + lc); + littleEndianDictionarySize = Integer.reverseBytes(dictionarySize); + } + + @Override + protected void encode(ChannelHandlerContext ctx, ByteBuf in, ByteBuf out) throws Exception { + final int length = in.readableBytes(); + final InputStream bbIn = new ByteBufInputStream(in); + + final ByteBufOutputStream bbOut = new ByteBufOutputStream(out); + bbOut.writeByte(properties); + bbOut.writeInt(littleEndianDictionarySize); + bbOut.writeLong(Long.reverseBytes(length)); + encoder.code(bbIn, bbOut, -1, -1, null); + + bbIn.close(); + bbOut.close(); + } + + @Override + protected ByteBuf allocateBuffer(ChannelHandlerContext ctx, ByteBuf in, boolean preferDirect) throws Exception { + final int length = in.readableBytes(); + final int maxOutputLength = maxOutputBufferLength(length); + return ctx.alloc().ioBuffer(maxOutputLength); + } + + /** + * Calculates maximum possible size of output buffer for not compressible data. + */ + private static int maxOutputBufferLength(int inputLength) { + double factor; + if (inputLength < 200) { + factor = 1.5; + } else if (inputLength < 500) { + factor = 1.2; + } else if (inputLength < 1000) { + factor = 1.1; + } else if (inputLength < 10000) { + factor = 1.05; + } else { + factor = 1.02; + } + return 13 + (int) (inputLength * factor); + } +} diff --git a/codec/src/main/java/io/netty/handler/codec/compression/package-info.java b/codec/src/main/java/io/netty/handler/codec/compression/package-info.java index faa1772100..866a9ea12d 100644 --- a/codec/src/main/java/io/netty/handler/codec/compression/package-info.java +++ b/codec/src/main/java/io/netty/handler/codec/compression/package-info.java @@ -21,4 +21,3 @@ * Snappy. */ package io.netty.handler.codec.compression; -// TODO Implement lzma handler diff --git a/codec/src/test/java/io/netty/handler/codec/compression/LzmaFrameEncoderTest.java b/codec/src/test/java/io/netty/handler/codec/compression/LzmaFrameEncoderTest.java new file mode 100644 index 0000000000..a1bee8e94b --- /dev/null +++ b/codec/src/test/java/io/netty/handler/codec/compression/LzmaFrameEncoderTest.java @@ -0,0 +1,145 @@ +/* + * Copyright 2014 The Netty Project + * + * The Netty Project 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 io.netty.handler.codec.compression; + +import io.netty.buffer.ByteBuf; +import io.netty.buffer.ByteBufInputStream; +import io.netty.buffer.CompositeByteBuf; +import io.netty.buffer.Unpooled; +import io.netty.channel.embedded.EmbeddedChannel; +import io.netty.util.internal.ThreadLocalRandom; +import lzma.sdk.lzma.Decoder; +import lzma.streams.LzmaInputStream; +import org.junit.Before; +import org.junit.Test; + +import java.io.InputStream; + +import static org.junit.Assert.*; + +public class LzmaFrameEncoderTest { + + private static final ThreadLocalRandom rand; + + private static final byte[] BYTES_SMALL = new byte[256]; + private static final byte[] BYTES_LARGE = new byte[256000]; + + static { + rand = ThreadLocalRandom.current(); + rand.nextBytes(BYTES_SMALL); + rand.nextBytes(BYTES_LARGE); + } + + private EmbeddedChannel channel; + + @Before + public void initChannel() { + channel = new EmbeddedChannel(new LzmaFrameEncoder()); + } + + private static void testCompression(final EmbeddedChannel channel, final byte[] data) throws Exception { + ByteBuf in = Unpooled.wrappedBuffer(data); + assertTrue(channel.writeOutbound(in)); + assertTrue(channel.finish()); + + byte[] uncompressed = uncompress(channel, data.length); + + assertArrayEquals(data, uncompressed); + } + + @Test + public void testCompressionOfSmallChunkOfData() throws Exception { + testCompression(channel, BYTES_SMALL); + } + + @Test + public void testCompressionOfLargeChunkOfData() throws Exception { + testCompression(channel, BYTES_LARGE); + } + + @Test + public void testCompressionOfBatchedFlowOfData() throws Exception { + final byte[] data = BYTES_SMALL; + + int written = 0, length = rand.nextInt(50); + while (written + length < data.length) { + ByteBuf in = Unpooled.wrappedBuffer(data, written, length); + assertTrue(channel.writeOutbound(in)); + written += length; + length = rand.nextInt(50); + } + ByteBuf in = Unpooled.wrappedBuffer(data, written, data.length - written); + assertTrue(channel.writeOutbound(in)); + assertTrue(channel.finish()); + + byte[] uncompressed = new byte[data.length]; + int outOffset = 0; + + ByteBuf msg; + while ((msg = channel.readOutbound()) != null) { + InputStream is = new ByteBufInputStream(msg); + LzmaInputStream lzmaIs = new LzmaInputStream(is, new Decoder()); + for (;;) { + int read = lzmaIs.read(uncompressed, outOffset, data.length - outOffset); + if (read > 0) { + outOffset += read; + } else { + break; + } + } + assertEquals(0, is.available()); + assertEquals(-1, is.read()); + + is.close(); + lzmaIs.close(); + msg.release(); + } + + assertArrayEquals(data, uncompressed); + } + + private static byte[] uncompress(EmbeddedChannel channel, int length) throws Exception { + CompositeByteBuf out = Unpooled.compositeBuffer(); + ByteBuf msg; + while ((msg = channel.readOutbound()) != null) { + out.addComponent(msg); + out.writerIndex(out.writerIndex() + msg.readableBytes()); + } + + InputStream is = new ByteBufInputStream(out); + LzmaInputStream lzmaIs = new LzmaInputStream(is, new Decoder()); + byte[] uncompressed = new byte[length]; + int remaining = length; + while (remaining > 0) { + int read = lzmaIs.read(uncompressed, length - remaining, remaining); + if (read > 0) { + remaining -= read; + } else { + break; + } + } + + assertEquals(0, is.available()); + assertEquals(-1, is.read()); + assertEquals(-1, lzmaIs.read()); + + is.close(); + lzmaIs.close(); + out.release(); + + return uncompressed; + } +} diff --git a/license/lzma-java.txt b/license/lzma-java.txt new file mode 100644 index 0000000000..d645695673 --- /dev/null +++ b/license/lzma-java.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. diff --git a/pom.xml b/pom.xml index e1523bbbb7..a4f942859b 100644 --- a/pom.xml +++ b/pom.xml @@ -430,6 +430,11 @@ lz4 1.2.0 + + com.github.jponge + lzma-java + 1.3 + org.rxtx