Skip to content

Add native fast reset compressors #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yawkat merged 9 commits into from
Apr 9, 2026
Merged

Add native fast reset compressors #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
045b9c8
Add native fast reset compressors
TyomaVader Apr 3, 2026
c01b7f4
Add native fast reset compressor tests
TyomaVader Apr 3, 2026
ad9a637
Simplify byte buffer paths
TyomaVader Apr 3, 2026
3661c7c
Add constructor normalization for compression level and acceleration
TyomaVader Apr 3, 2026
47c6557
Switch to a lock for guarding the statePtr
TyomaVader Apr 8, 2026
976efdf
Add missing HC test
TyomaVader Apr 8, 2026
ac25954
Throw on concurrent close attempt
TyomaVader Apr 9, 2026
8f168ec
Throw on unsupported buffer attempt
TyomaVader Apr 9, 2026
b501546
Move shared logic to an abstract base class
TyomaVader Apr 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 106 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -950,6 +950,112 @@
</configuration>
</execution>

<!-- LZ4CompressorTest fast-reset compressor (array) -->
<execution>
<id>fuzz-net.jpountz.fuzz.LZ4CompressorTest#native_fastReset_array</id>
<goals><goal>test</goal></goals>
<configuration>
<test>net.jpountz.fuzz.LZ4CompressorTest#native_fastReset_array</test>
</configuration>
</execution>
<execution>
<id>fuzz-net.jpountz.fuzz.LZ4CompressorTest#native_fastReset_a9_array</id>
<goals><goal>test</goal></goals>
<configuration>
<test>net.jpountz.fuzz.LZ4CompressorTest#native_fastReset_a9_array</test>
</configuration>
</execution>
<execution>
<id>fuzz-net.jpountz.fuzz.LZ4CompressorTest#native_fastReset_a17_array</id>
<goals><goal>test</goal></goals>
<configuration>
<test>net.jpountz.fuzz.LZ4CompressorTest#native_fastReset_a17_array</test>
</configuration>
</execution>

<!-- LZ4CompressorTest fast-reset compressor (bytebuffer) -->
<execution>
<id>fuzz-net.jpountz.fuzz.LZ4CompressorTest#native_fastReset_bytebuffer</id>
<goals><goal>test</goal></goals>
<configuration>
<test>net.jpountz.fuzz.LZ4CompressorTest#native_fastReset_bytebuffer</test>
</configuration>
</execution>
<execution>
<id>fuzz-net.jpountz.fuzz.LZ4CompressorTest#native_fastReset_a9_bytebuffer</id>
<goals><goal>test</goal></goals>
<configuration>
<test>net.jpountz.fuzz.LZ4CompressorTest#native_fastReset_a9_bytebuffer</test>
</configuration>
</execution>
<execution>
<id>fuzz-net.jpountz.fuzz.LZ4CompressorTest#native_fastReset_a17_bytebuffer</id>
<goals><goal>test</goal></goals>
<configuration>
<test>net.jpountz.fuzz.LZ4CompressorTest#native_fastReset_a17_bytebuffer</test>
</configuration>
</execution>

<!-- LZ4CompressorTest high fast-reset compressor (array) -->
<execution>
<id>fuzz-net.jpountz.fuzz.LZ4CompressorTest#native_highFastReset_array</id>
<goals><goal>test</goal></goals>
<configuration>
<test>net.jpountz.fuzz.LZ4CompressorTest#native_highFastReset_array</test>
</configuration>
</execution>
<execution>
<id>fuzz-net.jpountz.fuzz.LZ4CompressorTest#native_highFastReset_l1_array</id>
<goals><goal>test</goal></goals>
<configuration>
<test>net.jpountz.fuzz.LZ4CompressorTest#native_highFastReset_l1_array</test>
</configuration>
</execution>
<execution>
<id>fuzz-net.jpountz.fuzz.LZ4CompressorTest#native_highFastReset_l9_array</id>
<goals><goal>test</goal></goals>
<configuration>
<test>net.jpountz.fuzz.LZ4CompressorTest#native_highFastReset_l9_array</test>
</configuration>
</execution>
<execution>
<id>fuzz-net.jpountz.fuzz.LZ4CompressorTest#native_highFastReset_l17_array</id>
<goals><goal>test</goal></goals>
<configuration>
<test>net.jpountz.fuzz.LZ4CompressorTest#native_highFastReset_l17_array</test>
</configuration>
</execution>

<!-- LZ4CompressorTest high fast-reset compressor (bytebuffer) -->
<execution>
<id>fuzz-net.jpountz.fuzz.LZ4CompressorTest#native_highFastReset_bytebuffer</id>
<goals><goal>test</goal></goals>
<configuration>
<test>net.jpountz.fuzz.LZ4CompressorTest#native_highFastReset_bytebuffer</test>
</configuration>
</execution>
<execution>
<id>fuzz-net.jpountz.fuzz.LZ4CompressorTest#native_highFastReset_l1_bytebuffer</id>
<goals><goal>test</goal></goals>
<configuration>
<test>net.jpountz.fuzz.LZ4CompressorTest#native_highFastReset_l1_bytebuffer</test>
</configuration>
</execution>
<execution>
<id>fuzz-net.jpountz.fuzz.LZ4CompressorTest#native_highFastReset_l9_bytebuffer</id>
<goals><goal>test</goal></goals>
<configuration>
<test>net.jpountz.fuzz.LZ4CompressorTest#native_highFastReset_l9_bytebuffer</test>
</configuration>
</execution>
<execution>
<id>fuzz-net.jpountz.fuzz.LZ4CompressorTest#native_highFastReset_l17_bytebuffer</id>
<goals><goal>test</goal></goals>
<configuration>
<test>net.jpountz.fuzz.LZ4CompressorTest#native_highFastReset_l17_bytebuffer</test>
</configuration>
</execution>

<!-- XXHash32Test (array) -->
<execution>
<id>fuzz-net.jpountz.fuzz.XXHash32Test#safe_array</id>
Expand Down
182 changes: 182 additions & 0 deletions src/java/net/jpountz/lz4/AbstractLZ4JNIFastResetCompressor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
package net.jpountz.lz4;

/*
* Copyright 2020 Adrien Grand and the lz4-java contributors.
*
* 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.
*/

import net.jpountz.util.ByteBufferUtils;
import net.jpountz.util.SafeUtils;

import java.nio.ByteBuffer;
import java.util.concurrent.locks.ReentrantLock;

abstract class AbstractLZ4JNIFastResetCompressor extends LZ4Compressor implements AutoCloseable {

private static final String IN_USE_ERROR = "This compressor is not thread-safe and is already in use";
private static final String CLOSED_ERROR = "Compressor has been closed";
private static final String UNSUPPORTED_BUFFER_ERROR = "ByteBuffer must be direct or array-backed";

private final ReentrantLock lock = new ReentrantLock();
private long statePtr;

AbstractLZ4JNIFastResetCompressor(long statePtr, String allocationFailureMessage) {
if (statePtr == 0) {
throw new LZ4Exception(allocationFailureMessage);
}
this.statePtr = statePtr;
}

/**
* Compresses {@code src[srcOff:srcOff+srcLen]} into
* {@code dest[destOff:destOff+maxDestLen]}.
*
* @param src source data
* @param srcOff the start offset in src
* @param srcLen the number of bytes to compress
* @param dest destination buffer
* @param destOff the start offset in dest
* @param maxDestLen the maximum number of bytes to write in dest
* @return the compressed size
* @throws LZ4Exception if maxDestLen is too small
* @throws IllegalStateException if the compressor has been closed or is already in use
*/
@Override
public final int compress(byte[] src, int srcOff, int srcLen, byte[] dest, int destOff, int maxDestLen) {
if (!lock.tryLock()) {
throw new IllegalStateException(IN_USE_ERROR);
}

try {
long ptr = checkOpen();
SafeUtils.checkRange(src, srcOff, srcLen);
SafeUtils.checkRange(dest, destOff, maxDestLen);

final int result = compressNative(
ptr, src, null, srcOff, srcLen,
dest, null, destOff, maxDestLen);
return checkResult(result);
} finally {
lock.unlock();
}
}

/**
* Compresses {@code src[srcOff:srcOff+srcLen]} into
* {@code dest[destOff:destOff+maxDestLen]}.
* <p>
* Both buffers must be either direct or array-backed.
* {@link ByteBuffer} positions remain unchanged.
*
* @param src source data
* @param srcOff the start offset in src
* @param srcLen the number of bytes to compress
* @param dest destination buffer
* @param destOff the start offset in dest
* @param maxDestLen the maximum number of bytes to write in dest
* @return the compressed size
* @throws LZ4Exception if maxDestLen is too small
* @throws IllegalArgumentException if src or dest is neither array-backed nor direct
* @throws IllegalStateException if the compressor has been closed or is already in use
*/
@Override
public final int compress(ByteBuffer src, int srcOff, int srcLen, ByteBuffer dest, int destOff, int maxDestLen) {
if (!lock.tryLock()) {
throw new IllegalStateException(IN_USE_ERROR);
}

try {
long ptr = checkOpen();
checkByteBuffer(src);
checkByteBuffer(dest);
ByteBufferUtils.checkNotReadOnly(dest);
ByteBufferUtils.checkRange(src, srcOff, srcLen);
ByteBufferUtils.checkRange(dest, destOff, maxDestLen);

byte[] srcArr = src.hasArray() ? src.array() : null;
byte[] destArr = dest.hasArray() ? dest.array() : null;
ByteBuffer srcBuf = srcArr == null ? src : null;
ByteBuffer destBuf = destArr == null ? dest : null;
int srcBufferOff = srcOff + (srcArr != null ? src.arrayOffset() : 0);
int destBufferOff = destOff + (destArr != null ? dest.arrayOffset() : 0);

final int result = compressNative(
ptr, srcArr, srcBuf, srcBufferOff, srcLen,
destArr, destBuf, destBufferOff, maxDestLen);
return checkResult(result);
} finally {
lock.unlock();
}
}

public final boolean isClosed() {
lock.lock();
try {
return statePtr == 0;
} finally {
lock.unlock();
}
}

/**
* Closes this compressor and releases native resources.
* After calling this method, all compress methods will throw {@link IllegalStateException}.
*
* @throws IllegalStateException if the compressor is in use by another thread
*/
@Override
public final void close() {
if (!lock.tryLock()) {
throw new IllegalStateException(IN_USE_ERROR);
}

try {
long ptr = statePtr;
statePtr = 0;
if (ptr != 0) {
freeState(ptr);
}
} finally {
lock.unlock();
}
}

private long checkOpen() {
if (statePtr == 0) {
throw new IllegalStateException(CLOSED_ERROR);
}
return statePtr;
}

private static int checkResult(int result) {
if (result <= 0) {
throw new LZ4Exception("maxDestLen is too small");
}
return result;
}

private static void checkByteBuffer(ByteBuffer buffer) {
if (!(buffer.hasArray() || buffer.isDirect())) {
throw new IllegalArgumentException(UNSUPPORTED_BUFFER_ERROR);
}
}

protected abstract int compressNative(long ptr, byte[] srcArr, ByteBuffer srcBuf, int srcOff, int srcLen,
byte[] destArr, ByteBuffer destBuf, int destOff, int maxDestLen);

protected abstract void freeState(long ptr);
}



3 changes: 3 additions & 0 deletions src/java/net/jpountz/lz4/LZ4Constants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ enum LZ4Constants {

static final int DEFAULT_COMPRESSION_LEVEL = 8 + 1;
static final int MAX_COMPRESSION_LEVEL = 16 + 1;
static final int DEFAULT_ACCELERATION = 1;
static final int MIN_ACCELERATION = 1;
static final int MAX_ACCELERATION = 65537;

static final int MEMORY_USAGE = 14;
static final int NOT_COMPRESSIBLE_DETECTION_LEVEL = 6;
Expand Down
Loading