Add support for LZ4 compression patch by Adrien Grand; reviewed by tjake for CASSANDRA-5038
Project: http://git-wip-us.apache.org/repos/asf/cassandra/repo Commit: http://git-wip-us.apache.org/repos/asf/cassandra/commit/aa7c7d9c Tree: http://git-wip-us.apache.org/repos/asf/cassandra/tree/aa7c7d9c Diff: http://git-wip-us.apache.org/repos/asf/cassandra/diff/aa7c7d9c Branch: refs/heads/cassandra-1.2 Commit: aa7c7d9cd74a8626cfac95c01a9f6ff9801bf45f Parents: d0f7e9e Author: Jonathan Ellis <jbel...@apache.org> Authored: Sun Feb 10 23:58:42 2013 -0600 Committer: Jonathan Ellis <jbel...@apache.org> Committed: Tue Feb 12 12:25:32 2013 -0600 ---------------------------------------------------------------------- CHANGES.txt | 1 + NOTICE.txt | 5 + build.xml | 2 + lib/licenses/lz4-1.1.0.txt | 235 +++++++++++++++ lib/lz4-1.1.0.jar | Bin 0 -> 134748 bytes .../cassandra/io/compress/LZ4Compressor.java | 104 +++++++ .../cassandra/io/compress/LZ4CompressorTest.java | 84 +++++ 7 files changed, 431 insertions(+), 0 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cassandra/blob/aa7c7d9c/CHANGES.txt ---------------------------------------------------------------------- diff --git a/CHANGES.txt b/CHANGES.txt index 466dca6..0621c79 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -16,6 +16,7 @@ * CQL3 refactor to allow conversion function (CASSANDRA-5226) * Fix drop of sstables in some circumstance (CASSANDRA-5232) * Implement caching of authorization results (CASSANDRA-4295) + * Add support for LZ4 compression (CASSANDRA-5038) 1.2.1 http://git-wip-us.apache.org/repos/asf/cassandra/blob/aa7c7d9c/NOTICE.txt ---------------------------------------------------------------------- diff --git a/NOTICE.txt b/NOTICE.txt index 71f38fe..9826990 100644 --- a/NOTICE.txt +++ b/NOTICE.txt @@ -44,3 +44,8 @@ Written by Nathan G. Bronson et al. CQL Native transport uses Netty (https://netty.io/) Copyright (C) 2011 The Netty Project + +LZ4 compression support provided by lz4-java (http://github.com/jpountz/lz4-java) +Written by Adrien Grand. +Contains bindings to the C LZ4 implementation (http://code.google.com/p/lz4/) +Copyright (C) 2011-2012, Yann Collet. http://git-wip-us.apache.org/repos/asf/cassandra/blob/aa7c7d9c/build.xml ---------------------------------------------------------------------- diff --git a/build.xml b/build.xml index 421c8f3..ea0bbd7 100644 --- a/build.xml +++ b/build.xml @@ -329,6 +329,7 @@ <scm connection="${scm.connection}" developerConnection="${scm.developerConnection}" url="${scm.url}"/> <dependencyManagement> <dependency groupId="org.xerial.snappy" artifactId="snappy-java" version="1.0.4.1"/> + <dependency groupId="net.jpountz.lz4" artifactId="lz4" version="1.1.0"/> <dependency groupId="com.ning" artifactId="compress-lzf" version="0.8.4"/> <dependency groupId="com.google.guava" artifactId="guava" version="12.0"/> <dependency groupId="commons-cli" artifactId="commons-cli" version="1.1"/> @@ -443,6 +444,7 @@ version="${version}"/> <scm connection="${scm.connection}" developerConnection="${scm.developerConnection}" url="${scm.url}"/> <dependency groupId="org.xerial.snappy" artifactId="snappy-java"/> + <dependency groupId="net.jpountz.lz4" artifactId="lz4"/> <dependency groupId="com.ning" artifactId="compress-lzf"/> <dependency groupId="com.google.guava" artifactId="guava"/> <dependency groupId="commons-cli" artifactId="commons-cli"/> http://git-wip-us.apache.org/repos/asf/cassandra/blob/aa7c7d9c/lib/licenses/lz4-1.1.0.txt ---------------------------------------------------------------------- diff --git a/lib/licenses/lz4-1.1.0.txt b/lib/licenses/lz4-1.1.0.txt new file mode 100644 index 0000000..7f3ef36 --- /dev/null +++ b/lib/licenses/lz4-1.1.0.txt @@ -0,0 +1,235 @@ + + 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. + +------------------------------------------------------------------------------- + +Copyright (C) 2011-2012, Yann Collet. +BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php) + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following disclaimer + in the documentation and/or other materials provided with the + distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +You can contact the author at : +- LZ4 homepage : http://fastcompression.blogspot.com/p/lz4.html +- LZ4 source repository : http://code.google.com/p/lz4/ http://git-wip-us.apache.org/repos/asf/cassandra/blob/aa7c7d9c/lib/lz4-1.1.0.jar ---------------------------------------------------------------------- diff --git a/lib/lz4-1.1.0.jar b/lib/lz4-1.1.0.jar new file mode 100644 index 0000000..fde917a Binary files /dev/null and b/lib/lz4-1.1.0.jar differ http://git-wip-us.apache.org/repos/asf/cassandra/blob/aa7c7d9c/src/java/org/apache/cassandra/io/compress/LZ4Compressor.java ---------------------------------------------------------------------- diff --git a/src/java/org/apache/cassandra/io/compress/LZ4Compressor.java b/src/java/org/apache/cassandra/io/compress/LZ4Compressor.java new file mode 100644 index 0000000..0cf36c1 --- /dev/null +++ b/src/java/org/apache/cassandra/io/compress/LZ4Compressor.java @@ -0,0 +1,104 @@ +/* + * 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.cassandra.io.compress; + +import java.io.IOException; +import java.util.Arrays; +import java.util.HashSet; +import java.util.Map; +import java.util.Set; + +import net.jpountz.lz4.LZ4Exception; +import net.jpountz.lz4.LZ4Factory; + +public class LZ4Compressor implements ICompressor +{ + + private static final int INTEGER_BYTES = 4; + private static final LZ4Compressor instance = new LZ4Compressor(); + + public static LZ4Compressor create(Map<String, String> args) + { + return instance; + } + + private final net.jpountz.lz4.LZ4Compressor compressor; + private final net.jpountz.lz4.LZ4Decompressor decompressor; + + private LZ4Compressor() + { + final LZ4Factory lz4Factory = LZ4Factory.fastestInstance(); + compressor = lz4Factory.fastCompressor(); + decompressor = lz4Factory.decompressor(); + } + + public int initialCompressedBufferLength(int chunkLength) + { + return INTEGER_BYTES + compressor.maxCompressedLength(chunkLength); + } + + public int compress(byte[] input, int inputOffset, int inputLength, WrappedArray output, int outputOffset) throws IOException + { + final byte[] dest = output.buffer; + dest[outputOffset] = (byte) inputLength; + dest[outputOffset + 1] = (byte) (inputLength >>> 8); + dest[outputOffset + 2] = (byte) (inputLength >>> 16); + dest[outputOffset + 3] = (byte) (inputLength >>> 24); + final int maxCompressedLength = compressor.maxCompressedLength(inputLength); + try + { + return INTEGER_BYTES + compressor.compress(input, inputOffset, inputLength, + dest, outputOffset + INTEGER_BYTES, maxCompressedLength); + } + catch (LZ4Exception e) + { + throw new IOException(e); + } + } + + public int uncompress(byte[] input, int inputOffset, int inputLength, byte[] output, int outputOffset) throws IOException + { + final int decompressedLength = + (input[inputOffset] & 0xFF) + | ((input[inputOffset + 1] & 0xFF) << 8) + | ((input[inputOffset + 2] & 0xFF) << 16) + | ((input[inputOffset + 3] & 0xFF) << 24); + final int compressedLength; + try + { + compressedLength = decompressor.decompress(input, inputOffset + INTEGER_BYTES, + output, outputOffset, decompressedLength); + } + catch (LZ4Exception e) + { + throw new IOException(e); + } + + if (compressedLength != inputLength - INTEGER_BYTES) + { + throw new IOException("Compressed lengths mismatch"); + } + + return decompressedLength; + } + + public Set<String> supportedOptions() + { + return new HashSet<String>(Arrays.asList(CompressionParameters.CRC_CHECK_CHANCE)); + } +} http://git-wip-us.apache.org/repos/asf/cassandra/blob/aa7c7d9c/test/unit/org/apache/cassandra/io/compress/LZ4CompressorTest.java ---------------------------------------------------------------------- diff --git a/test/unit/org/apache/cassandra/io/compress/LZ4CompressorTest.java b/test/unit/org/apache/cassandra/io/compress/LZ4CompressorTest.java new file mode 100644 index 0000000..56ffdf1 --- /dev/null +++ b/test/unit/org/apache/cassandra/io/compress/LZ4CompressorTest.java @@ -0,0 +1,84 @@ +/* + * 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.cassandra.io.compress; + +import java.io.IOException; +import java.io.UnsupportedEncodingException; +import java.util.Arrays; +import java.util.Collections; +import java.util.Random; + +import org.apache.cassandra.io.compress.ICompressor.WrappedArray; + +import org.junit.Before; +import org.junit.Test; + +import static org.junit.Assert.*; + +public class LZ4CompressorTest +{ + + LZ4Compressor compressor; + + @Before + public void setUp() + { + compressor = LZ4Compressor.create(Collections.<String, String>emptyMap()); + } + + public void test(byte[] data, int off, int len) throws IOException + { + final int outOffset = 3; + final WrappedArray out = new WrappedArray(new byte[outOffset + compressor.initialCompressedBufferLength(len)]); + new Random().nextBytes(out.buffer); + final int compressedLength = compressor.compress(data, off, len, out, outOffset); + final int restoredOffset = 5; + final byte[] restored = new byte[restoredOffset + len]; + new Random().nextBytes(restored); + final int decompressedLength = compressor.uncompress(out.buffer, outOffset, compressedLength, restored, restoredOffset); + assertEquals(decompressedLength, len); + assertArrayEquals(Arrays.copyOfRange(data, off, off + len), + Arrays.copyOfRange(restored, restoredOffset, restoredOffset + decompressedLength)); + } + + public void test(byte[] data) throws IOException + { + test(data, 0, data.length); + } + + @Test + public void testEmptyArray() throws IOException + { + test(new byte[0]); + } + + @Test + public void testShortArray() throws UnsupportedEncodingException, IOException + { + test("Cassandra".getBytes("UTF-8"), 1, 7); + } + + @Test + public void testLongArray() throws UnsupportedEncodingException, IOException + { + byte[] data = new byte[1 << 20]; + test(data, 13, 1 << 19); + new Random(0).nextBytes(data); + test(data, 13, 1 << 19); + } +}
