Java* Native Interface binding for Intel® QuickAssist Technology

Qat-Java library provides accelerated compression and decompression using Intel® QuickAssist Technology (QAT) QATzip library. For more information about Intel® QAT, refer to the QAT Programmer's Guide. Additionally, the online QAT Hardware User Guide is a valuable resource that provides guidance on setting up and optimizing Intel® QAT.

Qat-Java currently supports DEFLATE and LZ4 compression algorithms.

Prerequisite

To use Intel® QAT for compression and decompression, Qat-Java requires the following dependencies to be met.

1. QAT driver — download the Intel® QAT driver for Linux from here and then follow these installation instructions.

2. QATZip — the installation instructions for the QATZip library are available at github.com/intel/QATZip#installation-instructions.

In cases where a QAT hardware is not available, Qat-Java can use a software-only execution mode. The instructions for installing and configuring the dependencies for a software-only execution mode are documented here.

Build

In addition to the prerequisites listed above, building Qat-Java requires the following to be installed:

• Java 11 or above.
• gcc, CMake , Maven, and clang (for fuzz testing).

To build qat-java, run the below command:

mvn clean package

Other Maven targets include:

• compile — builds sources.
• test — builds and runs tests.
• package — builds and writes jar files into target directory.
• javadoc:javadoc — generates javadocs.
• spotless:check — check if source code is formatted well.
• spotless:apply — fixes source code format issues.
• site — generates Surefire reports into target/site.

The build instructions were tested using gcc-8.5.0, cmake-3.10.0, mvn-3.5.4 and clang-16.0.0.

Testing

To run all the unit tests, execute the below command.

mvn clean test

You can also install the Jazzer tool and run Fuzz tests.

mvn clean test -Dfuzzing=true

Examples

You can run the examples in the com.intel.qat.examples, use the below command:

java -cp .:./target/classes/ com.intel.qat.examples.<example-class>

Or using this command:

java --module-path target/classes  -m com.intel.qat/com.intel.qat.examples.<example-class>

Contributing

Thanks for your interest! Please see the CONTRIBUTING.md document for information on how to contribute.

Contacts

For more information on this library, contact Mammo, Mulugeta (mulugeta.mammo@intel.com) or Denloye, Olasoji (olasoji.denloye@intel.com).

 

* Java is a registered trademark of Oracle and/or its affiliates.