diff options
Diffstat (limited to 'src/crypto/isa-l/isa-l_crypto/README.md')
-rw-r--r-- | src/crypto/isa-l/isa-l_crypto/README.md | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/src/crypto/isa-l/isa-l_crypto/README.md b/src/crypto/isa-l/isa-l_crypto/README.md new file mode 100644 index 000000000..f9f560c54 --- /dev/null +++ b/src/crypto/isa-l/isa-l_crypto/README.md @@ -0,0 +1,63 @@ +Intel(R) Intelligent Storage Acceleration Library Crypto Version +================================================================ + +ISA-L_crypto is a collection of optimized low-level functions targeting storage +applications. ISA-L_crypto includes: + +* Multi-buffer hashes - run multiple hash jobs together on one core for much + better throughput than single-buffer versions. + - SHA1, SHA256, SHA512, MD5, SM3 + +* Multi-hash - Get the performance of multi-buffer hashing with a single-buffer + interface. Specification ref : [Multi-Hash white paper](https://www.intel.com/content/dam/www/public/us/en/documents/white-papers/multi-hash-paper.pdf) + +* Multi-hash + murmur - run both together. + +* AES - block ciphers + - XTS, GCM, CBC + +* Rolling hash - Hash input in a window which moves through the input + +Also see: +* [ISA-L_crypto for updates](https://github.com/intel/isa-l_crypto). +* For non-crypto ISA-L see [isa-l on github](https://github.com/intel/isa-l). +* The [github wiki](https://github.com/intel/isa-l/wiki) covering isa-l and + isa-l crypto. +* [Contributing](CONTRIBUTING.md). + +Building ISA-L +-------------- + +### Prerequisites + +* 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. +* Compiler: gcc, clang, icc or VC compiler. +* Make: GNU 'make' or 'nmake' (Windows). +* Optional: 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 targets include: +* `make check` : create and run tests +* `make tests` : create additional unit tests +* `make perfs` : create included performance tests +* `make ex` : build examples +* `make doc` : build API manual |