mirror of https://github.com/F-Stack/f-stack.git
121 lines
4.3 KiB
ReStructuredText
121 lines
4.3 KiB
ReStructuredText
.. BSD LICENSE
|
|
Copyright(c) 2016-2017 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.
|
|
|
|
AES-NI GCM Crypto Poll Mode Driver
|
|
==================================
|
|
|
|
|
|
The AES-NI GCM PMD (**librte_pmd_aesni_gcm**) provides poll mode crypto driver
|
|
support for utilizing Intel multi buffer library (see AES-NI Multi-buffer PMD documentation
|
|
to learn more about it, including installation).
|
|
|
|
Features
|
|
--------
|
|
|
|
AESNI GCM PMD has support for:
|
|
|
|
Authentication algorithms:
|
|
|
|
* RTE_CRYPTO_AUTH_AES_GMAC
|
|
|
|
AEAD algorithms:
|
|
|
|
* RTE_CRYPTO_AEAD_AES_GCM
|
|
|
|
|
|
Limitations
|
|
-----------
|
|
|
|
* Chained mbufs are supported but only out-of-place (destination mbuf must be contiguous).
|
|
* Cipher only is not supported.
|
|
|
|
|
|
Installation
|
|
------------
|
|
|
|
To build DPDK with the AESNI_GCM_PMD the user is required to download the multi-buffer
|
|
library from `here <https://github.com/01org/intel-ipsec-mb>`_
|
|
and compile it on their user system before building DPDK.
|
|
The latest version of the library supported by this PMD is v0.47, which
|
|
can be downloaded in `<https://github.com/01org/intel-ipsec-mb/archive/v0.47.zip>`_.
|
|
|
|
.. code-block:: console
|
|
|
|
make
|
|
|
|
As a reference, the following table shows a mapping between the past DPDK versions
|
|
and the external crypto libraries supported by them:
|
|
|
|
.. _table_aesni_gcm_versions:
|
|
|
|
.. table:: DPDK and external crypto library version compatibility
|
|
|
|
============= ================================
|
|
DPDK version Crypto library version
|
|
============= ================================
|
|
16.04 - 16.11 Multi-buffer library 0.43 - 0.44
|
|
17.02 - 17.05 ISA-L Crypto v2.18
|
|
17.08+ Multi-buffer library 0.46+
|
|
============= ================================
|
|
|
|
|
|
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_GCM=y in config/common_base.
|
|
|
|
To use the PMD in an application, user must:
|
|
|
|
* Call rte_vdev_init("crypto_aesni_gcm") within the application.
|
|
|
|
* Use --vdev="crypto_aesni_gcm" in the EAL options, which will call rte_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 -l 1 -n 4 --vdev="crypto_aesni_gcm,socket_id=0,max_nb_sessions=128" \
|
|
-- -p 1 --cdev SW --chain AEAD --aead_algo "aes-gcm"
|