1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright(c) 2021 Intel Corporation. 3 4Chacha20-poly1305 Crypto Poll Mode Driver 5========================================= 6 7The Chacha20-poly1305 PMD provides poll mode crypto driver support for 8utilizing `Intel IPSec Multi-buffer library <https://github.com/01org/intel-ipsec-mb>`_. 9 10Features 11-------- 12 13Chacha20-poly1305 PMD has support for: 14 15AEAD algorithms: 16 17* RTE_CRYPTO_AEAD_CHACHA20_POLY1305 18 19Chaha20_Poly1305 PMD vs AESNI MB PMD 20------------------------------------ 21 22AESNI MB PMD also supports CHACHA20-POLY1305 algorithms. 23It is recommended to use the AESNI MB PMD, 24which offers better performance on Intel processors, 25when single-segment buffers are used. 26Take a look at the PMD documentation (:doc:`aesni_mb`) for more information. 27 28Installation 29------------ 30 31To build DPDK with the Chacha20-poly1305 PMD the user is required to download 32the multi-buffer library from `here <https://github.com/01org/intel-ipsec-mb>`_ 33and compile it on their user system before building DPDK. 34The latest version of the library supported by this PMD is v1.3, which 35can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v1.3.zip>`_. 36 37After downloading the library, the user needs to unpack and compile it 38on their system before building DPDK: 39 40.. code-block:: console 41 42 make 43 make install 44 45The library requires NASM to be built. Depending on the library version, it might 46require a minimum NASM version (e.g. v0.54 requires at least NASM 2.14). 47 48NASM is packaged for different OS. However, on some OS the version is too old, 49so a manual installation is required. In that case, NASM can be downloaded from 50`NASM website <https://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D>`_. 51Once it is downloaded, extract it and follow these steps: 52 53.. code-block:: console 54 55 ./configure 56 make 57 make install 58 59.. note:: 60 61 Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53. 62 If a lower GCC version than 5.0, the workaround proposed by the following link 63 should be used: `<https://github.com/intel/intel-ipsec-mb/issues/40>`_. 64 65As a reference, the following table shows a mapping between the past DPDK versions 66and the external crypto libraries supported by them: 67 68.. _table_chacha20_poly1305_versions: 69 70.. table:: DPDK and external crypto library version compatibility 71 72 ============= ================================ 73 DPDK version Crypto library version 74 ============= ================================ 75 21.11+ Multi-buffer library 1.0-1.3* 76 ============= ================================ 77 78\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system. 79 80Initialization 81-------------- 82 83In order to enable this virtual crypto PMD, user must: 84 85* Build the multi buffer library (explained in Installation section). 86 87To use the PMD in an application, user must: 88 89* Call rte_vdev_init("crypto_chacha20_poly1305") within the application. 90 91* Use --vdev="crypto_chacha20_poly1305" in the EAL options, which will call 92 rte_vdev_init() internally. 93 94The following parameters (all optional) can be provided in the previous two calls: 95 96* socket_id: Specify the socket where the memory for the device is going to be allocated 97 (by default, socket_id will be the socket where the core that is creating the PMD is running on). 98 99* max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default). 100 101* max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default). 102 103Example: 104 105.. code-block:: console 106 107 --vdev="crypto_chacha20_poly1305,socket_id=0,max_nb_sessions=128" 108