deb-libisal/README.md
Greg Tucker 5ec8ea0e14 doc: Add build details and contributing
Signed-off-by: Greg Tucker <greg.b.tucker@intel.com>
2017-02-24 14:50:34 -07:00

1.9 KiB

================================================= Intel(R) Intelligent Storage Acceleration Library

Build Status

ISA-L is a collection of optimized low-level functions targeting storage applications. ISA-L includes:

  • Erasure codes - Fast block Reed-Solomon type erasure codes for any encode/decode matrix in GF(2^8).
  • CRC - Fast implementations of cyclic redundancy check. Six different polynomials supported.
    • iscsi32, ieee32, t10dif, ecma64, iso64, jones64.
  • Raid - calculate and operate on XOR and P+Q parity found in common RAID implementations.
  • Compression - Fast deflate-compatible data compression.
  • De-compression - Fast inflate-compatible data compression.

Also see:

Building ISA-L

Prerequisites

  • yasm version 1.2.0 or later or nasm v2.11.01 or later.
  • gcc, clang, icc or VC compiler.
  • GNU 'make' or 'nmake' (Windows).
  • Building with autotools requires autoconf/automake packages.

Autotools

To build and install the library with autotools it is usually sufficient to run:

./autogen.sh
./configure
make
sudo make install

Makefile

To use a standard makefile run:

make -f Makefile.unx

Windows

On Windows use nmake to build dll and static lib:

nmake -f Makefile.nmake

Other make targets

Other targes include:

  • make check : create and run tests
  • make tests : create additional unit tests
  • make perfs : create included performance tests
  • make ex : build examples
  • make other : build other utilities such as compression file tests