Skip to content

Installation Instructions

Jump to bottom
mulugetam edited this page Aug 18, 2023 · 2 revisions

Prerequisites

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.

Clone this wiki locally