fddf380404
Update documentation with correct names of supported algorithms. Fixes:1703e94ac5("qat: add driver for QuickAssist devices") Fixes:3aafc423cf("snow3g: add driver for SNOW 3G library") Fixes:924e84f873("aesni_mb: add driver for multi buffer based crypto") Fixes:2773c86d06("crypto/kasumi: add driver for KASUMI library") Signed-off-by: Deepak Kumar Jain <deepak.k.jain@intel.com> Acked-by: Fiona Trahe <fiona.trahe@intel.com>
117 lines
4.4 KiB
ReStructuredText
117 lines
4.4 KiB
ReStructuredText
.. BSD LICENSE
|
|
Copyright(c) 2015 Intel Corporation. All rights reserved.
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions
|
|
are met:
|
|
|
|
* Redistributions of source code must retain the above copyright
|
|
notice, this list of conditions and the following disclaimer.
|
|
* Redistributions in binary form must reproduce the above copyright
|
|
notice, this list of conditions and the following disclaimer in
|
|
the documentation and/or other materials provided with the
|
|
distribution.
|
|
* Neither the name of Intel Corporation nor the names of its
|
|
contributors may be used to endorse or promote products derived
|
|
from this software without specific prior written permission.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
AESN-NI Multi Buffer Crytpo Poll Mode Driver
|
|
============================================
|
|
|
|
|
|
The AESNI MB PMD (**librte_pmd_aesni_mb**) provides poll mode crypto driver
|
|
support for utilizing Intel multi buffer library, see the white paper
|
|
`Fast Multi-buffer IPsec Implementations on Intel® Architecture Processors
|
|
<https://www-ssl.intel.com/content/www/us/en/intelligent-systems/intel-technology/fast-multi-buffer-ipsec-implementations-ia-processors-paper.html?wapkw=multi+buffer>`_.
|
|
|
|
The AES-NI MB PMD has current only been tested on Fedora 21 64-bit with gcc.
|
|
|
|
Features
|
|
--------
|
|
|
|
AESNI MB PMD has support for:
|
|
|
|
Cipher algorithms:
|
|
|
|
* RTE_CRYPTO_CIPHER_AES128_CBC
|
|
* RTE_CRYPTO_CIPHER_AES192_CBC
|
|
* RTE_CRYPTO_CIPHER_AES256_CBC
|
|
* RTE_CRYPTO_CIPHER_AES128_CTR
|
|
* RTE_CRYPTO_CIPHER_AES192_CTR
|
|
* RTE_CRYPTO_CIPHER_AES256_CTR
|
|
|
|
Hash algorithms:
|
|
|
|
* RTE_CRYPTO_HASH_SHA1_HMAC
|
|
* RTE_CRYPTO_HASH_SHA256_HMAC
|
|
* RTE_CRYPTO_HASH_SHA512_HMAC
|
|
|
|
Limitations
|
|
-----------
|
|
|
|
* Chained mbufs are not supported.
|
|
* Hash only is not supported.
|
|
* Cipher only is not supported.
|
|
* Only in-place is currently supported (destination address is the same as source address).
|
|
* Only supports session-oriented API implementation (session-less APIs are not supported).
|
|
* Not performance tuned.
|
|
|
|
Installation
|
|
------------
|
|
|
|
To build DPDK with the AESNI_MB_PMD the user is required to download the mult-
|
|
buffer library from `here <https://downloadcenter.intel.com/download/22972>`_
|
|
and compile it on their user system before building DPDK. When building the
|
|
multi-buffer library it is necessary to have YASM package installed and also
|
|
requires the overriding of YASM path when building, as a path is hard coded in
|
|
the Makefile of the release package.
|
|
|
|
.. code-block:: console
|
|
|
|
make YASM=/usr/bin/yasm
|
|
|
|
Initialization
|
|
--------------
|
|
|
|
In order to enable this virtual crypto PMD, user must:
|
|
|
|
* Export the environmental variable AESNI_MULTI_BUFFER_LIB_PATH with the path where
|
|
the library was extracted.
|
|
|
|
* Build the multi buffer library (explained in Installation section).
|
|
|
|
* Set CONFIG_RTE_LIBRTE_PMD_AESNI_MB=y in config/common_base.
|
|
|
|
To use the PMD in an application, user must:
|
|
|
|
* Call rte_eal_vdev_init("crypto_aesni_mb") within the application.
|
|
|
|
* Use --vdev="crypto_aesni_mb" in the EAL options, which will call rte_eal_vdev_init() internally.
|
|
|
|
The following parameters (all optional) can be provided in the previous two calls:
|
|
|
|
* socket_id: Specify the socket where the memory for the device is going to be allocated
|
|
(by default, socket_id will be the socket where the core that is creating the PMD is running on).
|
|
|
|
* max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default).
|
|
|
|
* max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default).
|
|
|
|
Example:
|
|
|
|
.. code-block:: console
|
|
|
|
./l2fwd-crypto -c 40 -n 4 --vdev="crypto_aesni_mb,socket_id=1,max_nb_sessions=128"
|