doc/guides/cryptodevs/aesni_gcm.rst

   1 ..  BSD LICENSE
   2     Copyright(c) 2016 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 ISA-L crypto library, which provides operation acceleration
  36 through the AES-NI instruction sets for AES-GCM authenticated cipher algorithm.
  37
  38 Features
  39 --------
  40
  41 AESNI GCM PMD has support for:
  42
  43 Cipher algorithms:
  44
  45 * RTE_CRYPTO_CIPHER_AES_GCM
  46
  47 Authentication algorithms:
  48
  49 * RTE_CRYPTO_AUTH_AES_GCM
  50 * RTE_CRYPTO_AUTH_AES_GMAC
  51
  52 Installation
  53 ------------
  54
  55 To build DPDK with the AESNI_GCM_PMD the user is required to install
  56 the ``libisal_crypto`` library in the build environment.
  57 For download and more details please visit `<https://github.com/01org/isa-l_crypto>`_.
  58
  59 Initialization
  60 --------------
  61
  62 In order to enable this virtual crypto PMD, user must:
  63
  64 * Install the ISA-L crypto library (explained in Installation section).
  65
  66 * Set CONFIG_RTE_LIBRTE_PMD_AESNI_GCM=y in config/common_base.
  67
  68 To use the PMD in an application, user must:
  69
  70 * Call rte_vdev_init("crypto_aesni_gcm") within the application.
  71
  72 * Use --vdev="crypto_aesni_gcm" in the EAL options, which will call rte_vdev_init() internally.
  73
  74 The following parameters (all optional) can be provided in the previous two calls:
  75
  76 * socket_id: Specify the socket where the memory for the device is going to be allocated
  77   (by default, socket_id will be the socket where the core that is creating the PMD is running on).
  78
  79 * max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default).
  80
  81 * max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default).
  82
  83 Example:
  84
  85 .. code-block:: console
  86
  87     ./l2fwd-crypto -l 6 -n 4 --vdev="crypto_aesni_gcm,socket_id=1,max_nb_sessions=128"
  88
  89 Limitations
  90 -----------
  91
  92 * Chained mbufs are supported but only out-of-place (destination mbuf must be contiguous).
  93 * Hash only is not supported.
  94 * Cipher only is not supported.