doc/guides/cryptodevs/aesni_gcm.rst

   1 ..  BSD LICENSE
   2     Copyright(c) 2016-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
  30 AES-NI GCM Crypto Poll Mode Driver
  31 ==================================
  32
  33
  34 The AES-NI GCM PMD (**librte_pmd_aesni_gcm**) provides poll mode crypto driver
  35 support for utilizing Intel multi buffer library (see AES-NI Multi-buffer PMD documentation
  36 to learn more about it, including installation).
  37
  38 Features
  39 --------
  40
  41 AESNI GCM PMD has support for:
  42
  43 Authentication algorithms:
  44
  45 * RTE_CRYPTO_AUTH_AES_GMAC
  46
  47 AEAD algorithms:
  48
  49 * RTE_CRYPTO_AEAD_AES_GCM
  50
  51
  52 Limitations
  53 -----------
  54
  55 * Chained mbufs are supported but only out-of-place (destination mbuf must be contiguous).
  56 * Cipher only is not supported.
  57
  58
  59 Installation
  60 ------------
  61
  62 To build DPDK with the AESNI_GCM_PMD the user is required to download the multi-buffer
  63 library from `here <https://github.com/01org/intel-ipsec-mb>`_
  64 and compile it on their user system before building DPDK.
  65 The latest version of the library supported by this PMD is v0.47, which
  66 can be downloaded in `<https://github.com/01org/intel-ipsec-mb/archive/v0.47.zip>`_.
  67
  68 .. code-block:: console
  69
  70         make
  71
  72 As a reference, the following table shows a mapping between the past DPDK versions
  73 and the external crypto libraries supported by them:
  74
  75 .. _table_aesni_gcm_versions:
  76
  77 .. table:: DPDK and external crypto library version compatibility
  78
  79    =============  ================================
  80    DPDK version   Crypto library version
  81    =============  ================================
  82    16.04 - 16.11  Multi-buffer library 0.43 - 0.44
  83    17.02 - 17.05  ISA-L Crypto v2.18
  84    17.08+         Multi-buffer library 0.46+
  85    =============  ================================
  86
  87
  88 Initialization
  89 --------------
  90
  91 In order to enable this virtual crypto PMD, user must:
  92
  93 * Export the environmental variable AESNI_MULTI_BUFFER_LIB_PATH with the path where
  94   the library was extracted.
  95
  96 * Build the multi buffer library (explained in Installation section).
  97
  98 * Set CONFIG_RTE_LIBRTE_PMD_AESNI_GCM=y in config/common_base.
  99
 100 To use the PMD in an application, user must:
 101
 102 * Call rte_vdev_init("crypto_aesni_gcm") within the application.
 103
 104 * Use --vdev="crypto_aesni_gcm" in the EAL options, which will call rte_vdev_init() internally.
 105
 106 The following parameters (all optional) can be provided in the previous two calls:
 107
 108 * socket_id: Specify the socket where the memory for the device is going to be allocated
 109   (by default, socket_id will be the socket where the core that is creating the PMD is running on).
 110
 111 * max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default).
 112
 113 * max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default).
 114
 115 Example:
 116
 117 .. code-block:: console
 118
 119     ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_gcm,socket_id=0,max_nb_sessions=128" \
 120     -- -p 1 --cdev SW --chain AEAD --aead_algo "aes-gcm"