1..  BSD LICENSE
2    Copyright(c) 2015-2017 Intel Corporation. All rights reserved.
3
4    Redistribution and use in source and binary forms, with or without
5    modification, are permitted provided that the following conditions
6    are met:
7
8    * Redistributions of source code must retain the above copyright
9    notice, this list of conditions and the following disclaimer.
10    * Redistributions in binary form must reproduce the above copyright
11    notice, this list of conditions and the following disclaimer in
12    the documentation and/or other materials provided with the
13    distribution.
14    * Neither the name of Intel Corporation nor the names of its
15    contributors may be used to endorse or promote products derived
16    from this software without specific prior written permission.
17
18    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30AESN-NI Multi Buffer Crypto Poll Mode Driver
31============================================
32
33
34The AESNI MB PMD (**librte_pmd_aesni_mb**) provides poll mode crypto driver
35support for utilizing Intel multi buffer library, see the white paper
36`Fast Multi-buffer IPsec Implementations on Intel® Architecture Processors
37<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>`_.
38
39The AES-NI MB PMD has current only been tested on Fedora 21 64-bit with gcc.
40
41Features
42--------
43
44AESNI MB PMD has support for:
45
46Cipher algorithms:
47
48* RTE_CRYPTO_CIPHER_AES128_CBC
49* RTE_CRYPTO_CIPHER_AES192_CBC
50* RTE_CRYPTO_CIPHER_AES256_CBC
51* RTE_CRYPTO_CIPHER_AES128_CTR
52* RTE_CRYPTO_CIPHER_AES192_CTR
53* RTE_CRYPTO_CIPHER_AES256_CTR
54* RTE_CRYPTO_CIPHER_AES_DOCSISBPI
55* RTE_CRYPTO_CIPHER_DES_CBC
56* RTE_CRYPTO_CIPHER_DES_DOCSISBPI
57
58Hash algorithms:
59
60* RTE_CRYPTO_HASH_MD5_HMAC
61* RTE_CRYPTO_HASH_SHA1_HMAC
62* RTE_CRYPTO_HASH_SHA224_HMAC
63* RTE_CRYPTO_HASH_SHA256_HMAC
64* RTE_CRYPTO_HASH_SHA384_HMAC
65* RTE_CRYPTO_HASH_SHA512_HMAC
66* RTE_CRYPTO_HASH_AES_XCBC_HMAC
67
68Limitations
69-----------
70
71* Chained mbufs are not supported.
72* Only in-place is currently supported (destination address is the same as source address).
73
74
75Installation
76------------
77
78To build DPDK with the AESNI_MB_PMD the user is required to download the multi-buffer
79library from `here <https://github.com/01org/intel-ipsec-mb>`_
80and compile it on their user system before building DPDK.
81The latest version of the library supported by this PMD is v0.47, which
82can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v0.47.zip>`_.
83
84.. code-block:: console
85
86	make
87
88As a reference, the following table shows a mapping between the past DPDK versions
89and the Multi-Buffer library version supported by them:
90
91.. _table_aesni_mb_versions:
92
93.. table:: DPDK and Multi-Buffer library version compatibility
94
95   ==============  ============================
96   DPDK version    Multi-buffer library version
97   ==============  ============================
98   2.2 - 16.11     0.43 - 0.44
99   17.02           0.44
100   17.05 - 17.08   0.45 - 0.47
101   17.11+          0.47
102   ==============  ============================
103
104
105Initialization
106--------------
107
108In order to enable this virtual crypto PMD, user must:
109
110* Export the environmental variable AESNI_MULTI_BUFFER_LIB_PATH with the path where
111  the library was extracted.
112
113* Build the multi buffer library (explained in Installation section).
114
115* Set CONFIG_RTE_LIBRTE_PMD_AESNI_MB=y in config/common_base.
116
117To use the PMD in an application, user must:
118
119* Call rte_vdev_init("crypto_aesni_mb") within the application.
120
121* Use --vdev="crypto_aesni_mb" in the EAL options, which will call rte_vdev_init() internally.
122
123The following parameters (all optional) can be provided in the previous two calls:
124
125* socket_id: Specify the socket where the memory for the device is going to be allocated
126  (by default, socket_id will be the socket where the core that is creating the PMD is running on).
127
128* max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default).
129
130* max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default).
131
132Example:
133
134.. code-block:: console
135
136    ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_mb,socket_id=0,max_nb_sessions=128" \
137    -- -p 1 --cdev SW --chain CIPHER_HASH --cipher_algo "aes-cbc" --auth_algo "sha1-hmac"
138
139Extra notes
140-----------
141
142For AES Counter mode (AES-CTR), the library supports two different sizes for Initialization
143Vector (IV):
144
145* 12 bytes: used mainly for IPSec, as it requires 12 bytes from the user, which internally
146  are appended the counter block (4 bytes), which is set to 1 for the first block
147  (no padding required from the user)
148
149* 16 bytes: when passing 16 bytes, the library will take them and use the last 4 bytes
150  as the initial counter block for the first block.
151