ceph/src/isa-l/README.md

   1 Intel(R) Intelligent Storage Acceleration Library
   2 =================================================
   3
   4 [![Build Status](https://travis-ci.org/01org/isa-l.svg?branch=master)](https://travis-ci.org/01org/isa-l)
   5
   6 ISA-L is a collection of optimized low-level functions targeting storage
   7 applications.  ISA-L includes:
   8 * Erasure codes - Fast block Reed-Solomon type erasure codes for any
   9   encode/decode matrix in GF(2^8).
  10 * CRC - Fast implementations of cyclic redundancy check.  Six different
  11   polynomials supported.
  12   - iscsi32, ieee32, t10dif, ecma64, iso64, jones64.
  13 * Raid - calculate and operate on XOR and P+Q parity found in common RAID
  14   implementations.
  15 * Compression - Fast deflate-compatible data compression.
  16 * De-compression - Fast inflate-compatible data compression.
  17
  18 Also see:
  19 * [ISA-L for updates](https://github.com/01org/isa-l).
  20 * For crypto functions see [isa-l_crypto on github](https://github.com/01org/isa-l_crypto).
  21 * The [github wiki](https://github.com/01org/isa-l/wiki).
  22 * ISA-L [mailing list](https://lists.01.org/mailman/listinfo/isal).
  23 * [Contributing](CONTRIBUTING.md).
  24
  25 Building ISA-L
  26 --------------
  27
  28 ### Prerequisites
  29
  30 * yasm version 1.2.0 or later or nasm v2.11.01 or later.
  31 * gcc, clang, icc or VC compiler.
  32 * GNU 'make' or 'nmake' (Windows).
  33 * Building with autotools requires autoconf/automake packages.
  34
  35 ### Autotools
  36 To build and install the library with autotools it is usually sufficient to run:
  37
  38     ./autogen.sh
  39     ./configure
  40     make
  41     sudo make install
  42
  43 ### Makefile
  44 To use a standard makefile run:
  45
  46     make -f Makefile.unx
  47
  48 ### Windows
  49 On Windows use nmake to build dll and static lib:
  50
  51     nmake -f Makefile.nmake
  52
  53 ### Other make targets
  54 Other targets include:
  55 * `make check` : create and run tests
  56 * `make tests` : create additional unit tests
  57 * `make perfs` : create included performance tests
  58 * `make ex`    : build examples
  59 * `make other` : build other utilities such as compression file tests