2015-10-22 14:54:34 -07:00
|
|
|
Intel(R) Intelligent Storage Acceleration Library
|
|
|
|
|
=================================================
|
|
|
|
|
|
2016-03-01 08:40:13 +01:00
|
|
|
[](https://travis-ci.org/01org/isa-l)
|
|
|
|
|
|
2016-07-21 15:01:09 -07:00
|
|
|
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).
|
2016-12-06 23:00:34 -07:00
|
|
|
* CRC - Fast implementations of cyclic redundancy check. Six different
|
2016-07-21 15:01:09 -07:00
|
|
|
polynomials supported.
|
2016-12-06 23:00:34 -07:00
|
|
|
- iscsi32, ieee32, t10dif, ecma64, iso64, jones64.
|
2016-07-21 15:01:09 -07:00
|
|
|
* Raid - calculate and operate on XOR and P+Q parity found in common RAID
|
|
|
|
|
implementations.
|
|
|
|
|
* Compression - Fast deflate-compatible data compression.
|
2016-12-06 23:00:34 -07:00
|
|
|
* De-compression - Fast inflate-compatible data compression.
|
|
|
|
|
|
2017-02-23 20:45:31 -07:00
|
|
|
Also see:
|
|
|
|
|
* [ISA-L for updates](https://github.com/01org/isa-l).
|
|
|
|
|
* For crypto functions see [isa-l_crypto on github](https://github.com/01org/isa-l_crypto).
|
2017-09-20 11:25:37 -07:00
|
|
|
* The [github wiki](https://github.com/01org/isa-l/wiki) including a list of
|
|
|
|
|
[distros/ports](https://github.com/01org/isa-l/wiki/Ports--Repos) offering binary packages.
|
2017-02-23 20:45:31 -07:00
|
|
|
* ISA-L [mailing list](https://lists.01.org/mailman/listinfo/isal).
|
|
|
|
|
* [Contributing](CONTRIBUTING.md).
|
2015-10-22 14:54:34 -07:00
|
|
|
|
|
|
|
|
Building ISA-L
|
2017-02-23 20:45:31 -07:00
|
|
|
--------------
|
|
|
|
|
|
|
|
|
|
### Prerequisites
|
2015-10-22 14:54:34 -07:00
|
|
|
|
2017-12-20 11:46:50 -07:00
|
|
|
* Assembler: nasm v2.11.01 or later (nasm v2.13 or better suggested for building in AVX512 support)
|
|
|
|
|
or yasm version 1.2.0 or later.
|
2017-09-20 11:25:37 -07:00
|
|
|
* Compiler: gcc, clang, icc or VC compiler.
|
|
|
|
|
* Make: GNU 'make' or 'nmake' (Windows).
|
|
|
|
|
* Optional: Building with autotools requires autoconf/automake packages.
|
2015-10-22 14:54:34 -07:00
|
|
|
|
2017-02-23 20:45:31 -07:00
|
|
|
### Autotools
|
|
|
|
|
To build and install the library with autotools it is usually sufficient to run:
|
2016-02-25 16:56:22 -07:00
|
|
|
|
2016-03-01 08:40:26 +01:00
|
|
|
./autogen.sh
|
|
|
|
|
./configure
|
|
|
|
|
make
|
|
|
|
|
sudo make install
|
2015-10-22 14:54:34 -07:00
|
|
|
|
2017-02-23 20:45:31 -07:00
|
|
|
### Makefile
|
|
|
|
|
To use a standard makefile run:
|
2016-02-25 16:56:22 -07:00
|
|
|
|
2017-02-23 20:45:31 -07:00
|
|
|
make -f Makefile.unx
|
2016-02-25 16:56:22 -07:00
|
|
|
|
2017-02-23 20:45:31 -07:00
|
|
|
### Windows
|
2016-03-01 08:40:26 +01:00
|
|
|
On Windows use nmake to build dll and static lib:
|
2016-02-25 16:56:22 -07:00
|
|
|
|
2016-03-01 08:40:26 +01:00
|
|
|
nmake -f Makefile.nmake
|
2016-02-25 16:56:22 -07:00
|
|
|
|
2017-02-23 20:45:31 -07:00
|
|
|
### Other make targets
|
2017-03-30 18:35:15 -07:00
|
|
|
Other targets include:
|
2017-02-23 20:45:31 -07:00
|
|
|
* `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
|
2017-09-20 11:25:37 -07:00
|
|
|
* `make doc` : build API manual
|
