Remove a modify-thread permission requirement.

Signed-off-by: Mulugeta Mammo <[email protected]>

Author: mulugetam

.gitmodules

@@ -6,16 +6,13 @@ For more details on Intel® QAT and installation instructions, refer to the [QAT
 Qat-Java currently supports the following compression algorithms:
 - **DEFLATE**
 - **LZ4**
-- **Zstandard (ZSTD)**
 
 ## Prerequisites
 
 This release was validated with the following tools and libraries:
 
 - [QATlib v24.09.0](https://github.com/intel/qatlib)
 - [QATzip v1.3.0](https://github.com/intel/QATzip/releases) and its dependencies
-- [Zstandard v1.5.4](https://github.com/facebook/zstd)
-- [Zstd-jni v1.5.6-1](https://github.com/luben/zstd-jni) or newer (if you're not building from source)
 - GCC 8.5 or newer
 - JDK 17 or newer
 - Clang (for fuzz testing)
@@ -62,7 +59,7 @@ mvn test -Dfuzzing=true
 To run an example from the `com.intel.qat.examples` package, use the following command:
 
 ```
-java -cp .:./target/classes/:path/to/zstd-jni-1.5.6-1.jar com.intel.qat.examples.<ExampleClass>
+java -cp .:./target/classes/ com.intel.qat.examples.<ExampleClass>
 ```
 
 ## Authors

README.md

@@ -2,9 +2,9 @@
 A set of JMH benchmarks.
 ```
 Name                | Algorithm
---------------------------------------------
-QatJavaBench        | DEFLATE, LZ4, ZSTD
-QatJavaStreamBench  | DEFLATE, LZ4, ZSTD
+----------------------------------
+QatJavaBench        | DEFLATE, LZ4
+QatJavaStreamBench  | DEFLATE, LZ4
 ```
 
 ## Build
@@ -17,8 +17,8 @@ mvn clean package
 To run the benchmark, use the below command:
 
 ```
-java -jar target/benchmarks.jar QatJavaBench -p file=/path/to/a/text-corpus -p algorithm=<"DEFLATE"|"LZ4"|"ZSTD"> -p level=<level> -p blockSize=<size> <jmh-params>
-java -jar target/benchmarks.jar QatJavaStreamBench -p file=/path/to/a/text-corpus -p algorithm=<"DEFLATE"|"LZ4"|"ZSTD"> -p level=<level> -p blockSize=<size> <jmh-params>
+java -jar target/benchmarks.jar QatJavaBench -p file=/path/to/a/text-corpus -p algorithm=<"DEFLATE"|"LZ4""> -p level=<level> -p blockSize=<size> <jmh-params>
+java -jar target/benchmarks.jar QatJavaStreamBench -p file=/path/to/a/text-corpus -p algorithm=<"DEFLATE"|"LZ4"> -p level=<level> -p blockSize=<size> <jmh-params>
 ```
 
 Examples:

jmh/qat-java-bench/README.md

@@ -35,7 +35,7 @@ THE POSSIBILITY OF SUCH DAMAGE.
 
     <groupId>com.intel.qat.jmh</groupId>
     <artifactId>qat-java-bench</artifactId>
-    <version>2.3.2</version>
+    <version>2.2.1</version>
     <packaging>jar</packaging>
 
     <name>JMH benchmark sample: Java</name>
@@ -60,12 +60,7 @@ THE POSSIBILITY OF SUCH DAMAGE.
         <dependency>
             <groupId>com.intel.qat</groupId>
             <artifactId>qat-java</artifactId>
-            <version>2.3.2</version>
-        </dependency>
-        <dependency>
-            <groupId>com.github.luben</groupId>
-            <artifactId>zstd-jni</artifactId>
-            <version>1.5.6-1</version>
+            <version>2.2.1</version>
         </dependency>
     </dependencies>
 

jmh/qat-java-bench/pom.xml

@@ -32,7 +32,7 @@ public class QatJavaBench {
   @Param({"65536"})
   static int blockSize;
 
-  @Param({"DEFLATE", "LZ4", "ZSTD"})
+  @Param({"DEFLATE", "LZ4"})
   static String algorithm;
 
   @State(Scope.Thread)
@@ -52,9 +52,6 @@ public ThreadState() {
           case "LZ4":
             algorithm = Algorithm.LZ4;
             break;
-          case "ZSTD":
-            algorithm = Algorithm.ZSTD;
-            break;
           default:
             throw new IllegalArgumentException("Invalid algorithm. Supported are DEFLATE and LZ4.");
         }

jmh/qat-java-bench/src/main/java/com/intel/qat/jmh/QatJavaBench.java

@@ -34,7 +34,7 @@ public class QatJavaStreamBench {
   @Param({"6"})
   static int level;
 
-  @Param({"DEFLATE", "LZ4", "ZSTD"})
+  @Param({"DEFLATE", "LZ4"})
   static String algorithm;
 
   @State(Scope.Thread)
@@ -52,9 +52,6 @@ public ThreadState() {
           case "LZ4":
             algorithm = Algorithm.LZ4;
             break;
-          case "ZSTD":
-            algorithm = Algorithm.ZSTD;
-            break;
           default:
             throw new IllegalArgumentException("Invalid algorithm. Supported are DEFLATE and LZ4.");
         }

jmh/qat-java-bench/src/main/java/com/intel/qat/jmh/QatJavaStreamBench.java

@@ -5,7 +5,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.intel.qat</groupId>
     <artifactId>qat-java</artifactId>
-    <version>2.3.2</version>
+    <version>2.2.1</version>
     <packaging>jar</packaging>
     <name>qat-java</name>
     <description>Qat-Java is a data compression library that uses Intel® QAT to speed up compression.</description>
@@ -281,11 +281,6 @@
         </plugins>
     </reporting>
     <dependencies>
-        <dependency>
-            <groupId>com.github.luben</groupId>
-            <artifactId>zstd-jni</artifactId>
-            <version>1.5.6-1</version>
-        </dependency>
         <dependency>
             <groupId>org.junit.platform</groupId>
             <artifactId>junit-platform-suite</artifactId>
@@ -332,7 +327,7 @@
                                     <arguments>
                                         <argument>-ea</argument>
                                         <argument>-cp</argument>
-                                        <argument>${project.build.directory}/qat-java-2.3.2.jar</argument>
+                                        <argument>${project.build.directory}/qat-java-2.2.1.jar</argument>
                                         <argument>-cp</argument>
                                         <classpath/>
                                         <argument>com.code_intelligence.jazzer.Jazzer</argument>

pom.xml

@@ -129,11 +129,5 @@ static native int decompressDirectByteBufferDst(
       int dstLen,
       int retryCount);
 
-  static native long zstdGetSeqProdFunction();
-
-  static native long zstdCreateSeqProdState();
-
-  static native void zstdFreeSeqProdState(long sequenceProdState);
-
   static native int teardown(int qzKey);
 }

src/main/java/com/intel/qat/InternalJNI.java

@@ -8,7 +8,6 @@
 
 import static com.intel.qat.QatZipper.Algorithm;
 
-import com.github.luben.zstd.ZstdException;
 import java.io.FilterInputStream;
 import java.io.IOException;
 import java.io.InputStream;
@@ -68,7 +67,6 @@ public QatDecompressorInputStream(InputStream in, int bufferSize, QatZipper.Buil
     super(in);
     if (bufferSize <= 0) throw new IllegalArgumentException();
     Objects.requireNonNull(in);
-    if (builder.getAlgorithm().equals(Algorithm.ZSTD)) MAX_BUFFER_SIZE = Integer.MAX_VALUE - 1;
     int inputBufferSize = 0;
     try {
       inputBufferSize = Math.max(bufferSize, in.available());
@@ -258,7 +256,7 @@ private void fill() throws IOException {
                 outputBufferLimit - outputPosition);
         inputPosition += qzip.getBytesRead();
         outputPosition += decompressed;
-      } catch (ZstdException zstde) {
+      } catch (RuntimeException e) {
         growOutputBuffer();
       }
       if (decompressed == 0 && inputPosition == 0) growOutputBuffer();

src/main/java/com/intel/qat/QatDecompressorInputStream.java

@@ -6,9 +6,6 @@
 
 package com.intel.qat;
 
-import com.github.luben.zstd.Zstd;
-import com.github.luben.zstd.ZstdCompressCtx;
-import com.github.luben.zstd.ZstdDecompressCtx;
 import java.nio.ByteBuffer;
 import java.nio.ReadOnlyBufferException;
 
@@ -116,25 +113,13 @@ public class QatZipper {
   /** Id of this object (set by the JNI code) based on algorithm, etc.. */
   private int qzKey;
 
-  /** Zstd compress context. */
-  private ZstdCompressCtx zstdCompressCtx;
-
-  /** Zstd decompress context. */
-  private ZstdDecompressCtx zstdDecompressCtx;
-
-  /** Checksum flag, currently valid for only ZSTD. */
-  private boolean checksumFlag;
-
   /** The compression algorithm to use. DEFLATE and LZ4 are supported. */
   public static enum Algorithm {
     /** The deflate compression algorithm. */
     DEFLATE,
 
     /** The LZ4 compression algorithm. */
-    LZ4,
-
-    /** The Zstandard compression algorithm. */
-    ZSTD
+    LZ4
   }
 
   /** The mode of execution for QAT. */
@@ -409,11 +394,6 @@ private QatZipper(Builder builder) throws RuntimeException {
 
     if (retryCount < 0) throw new IllegalArgumentException("Invalid value for retry count");
 
-    if (algorithm == Algorithm.ZSTD) {
-      zstdCompressCtx = new ZstdCompressCtx();
-      zstdDecompressCtx = new ZstdDecompressCtx();
-    }
-
     int status =
         InternalJNI.setup(
             this,
@@ -424,15 +404,6 @@ private QatZipper(Builder builder) throws RuntimeException {
             dataFormat.ordinal(),
             hwBufferSize.getValue());
 
-    if (algorithm == Algorithm.ZSTD) {
-      final int QZ_OK = 0; // indicates that ZSTD can start QAT device
-      if (mode == Mode.HARDWARE || (mode == Mode.AUTO && status == QZ_OK)) {
-        zstdCompressCtx.registerSequenceProducer(new QatZstdSequenceProducer());
-        zstdCompressCtx.setSequenceProducerFallback(true);
-      }
-      zstdCompressCtx.setLevel(level);
-    }
-
     isValid = true;
   }
 
@@ -478,11 +449,7 @@ public QatZipper(Algorithm algorithm, int level) {
   public int maxCompressedLength(long len) {
     if (!isValid) throw new IllegalStateException("QAT session has been closed");
 
-    if (algorithm != Algorithm.ZSTD) {
-      return InternalJNI.maxCompressedSize(qzKey, len);
-    }
-
-    return (int) Zstd.compressBound(len);
+    return InternalJNI.maxCompressedSize(qzKey, len);
   }
 
   /**
@@ -524,16 +491,7 @@ public int compress(
     if (dstOffset < 0 || dstLen < 0 || dstOffset > dst.length - dstLen)
       throw new ArrayIndexOutOfBoundsException("Destination offset is out of bound");
 
-    if (algorithm != Algorithm.ZSTD) {
-      return compressByteArray(src, srcOffset, srcLen, dst, dstOffset, dstLen);
-    } else {
-      bytesRead = bytesWritten = 0;
-      int compressedSize =
-          zstdCompressCtx.compressByteArray(dst, dstOffset, dstLen, src, srcOffset, srcLen);
-      bytesWritten = compressedSize;
-      bytesRead = srcLen;
-      return compressedSize;
-    }
+    return compressByteArray(src, srcOffset, srcLen, dst, dstOffset, dstLen);
   }
 
   private int compressByteArray(
@@ -569,12 +527,7 @@ public int compress(ByteBuffer src, ByteBuffer dst) {
 
     if (dst.isReadOnly()) throw new ReadOnlyBufferException();
 
-    if (algorithm != Algorithm.ZSTD) {
-      return compressByteBuffer(src, dst);
-    } else {
-      // ZSTD treats the first parameter as the destination and the second as the source.
-      return zstdCompressCtx.compress(dst, src);
-    }
+    return compressByteBuffer(src, dst);
   }
 
   private int compressByteBuffer(ByteBuffer src, ByteBuffer dst) {
@@ -690,16 +643,7 @@ public int decompress(
     if (dstOffset < 0 || dstLen < 0 || dstOffset > dst.length - dstLen)
       throw new ArrayIndexOutOfBoundsException("Destination offset is out of bound");
 
-    if (algorithm != Algorithm.ZSTD) {
-      return decompressByteArray(src, srcOffset, srcLen, dst, dstOffset, dstLen);
-    } else {
-      bytesRead = bytesWritten = 0;
-      int decompressedSize =
-          zstdDecompressCtx.decompressByteArray(dst, dstOffset, dstLen, src, srcOffset, srcLen);
-      bytesWritten = decompressedSize;
-      bytesRead = srcLen;
-      return decompressedSize;
-    }
+    return decompressByteArray(src, srcOffset, srcLen, dst, dstOffset, dstLen);
   }
 
   private int decompressByteArray(
@@ -737,15 +681,7 @@ public int decompress(ByteBuffer src, ByteBuffer dst) {
 
     if (dst.isReadOnly()) throw new ReadOnlyBufferException();
 
-    if (algorithm != Algorithm.ZSTD) {
-      return decompressByteBuffer(src, dst);
-    } else {
-      // ZSTD treats the first parameter as the destination and the second as the source.
-      if (!src.isDirect())
-        throw new IllegalArgumentException(
-            "Zstd-jni requires source buffers to be direct byte buffers");
-      return zstdDecompressCtx.decompress(dst, src);
-    }
+    return decompressByteBuffer(src, dst);
   }
 
   private int decompressByteBuffer(ByteBuffer src, ByteBuffer dst) {
@@ -845,19 +781,6 @@ public int getBytesWritten() {
     return bytesWritten;
   }
 
-  /**
-   * Sets a checksum flag. Currently valid only for ZSTD.
-   *
-   * @param checksumFlag the checksum flag.
-   * @throws UnsupportedOperationException if called for a compressor algorithm other than ZSTD.
-   */
-  public void setChecksumFlag(boolean checksumFlag) {
-    if (algorithm != Algorithm.ZSTD)
-      throw new UnsupportedOperationException(
-          "Setting a checksum flag is currently valid only for ZSTD compressor");
-    zstdCompressCtx.setChecksum(checksumFlag);
-  }
-
   /**
    * Ends the current QAT session by freeing up resources. A new session must be used after a
    * successful call of this method.