lib/librte_vhost/rte_vhost_crypto.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2017-2018 Intel Corporation
   3  */
   4
   5 #ifndef _VHOST_CRYPTO_H_
   6 #define _VHOST_CRYPTO_H_
   7
   8 #define VHOST_CRYPTO_MBUF_POOL_SIZE             (8192)
   9 #define VHOST_CRYPTO_MAX_BURST_SIZE             (64)
  10 #define VHOST_CRYPTO_SESSION_MAP_ENTRIES        (1024) /**< Max nb sessions */
  11 /** max nb virtual queues in a burst for finalizing*/
  12 #define VIRTIO_CRYPTO_MAX_NUM_BURST_VQS         (64)
  13 #define VHOST_CRYPTO_MAX_IV_LEN                 (32)
  14
  15 enum rte_vhost_crypto_zero_copy {
  16         RTE_VHOST_CRYPTO_ZERO_COPY_DISABLE = 0,
  17         RTE_VHOST_CRYPTO_ZERO_COPY_ENABLE = 1,
  18         RTE_VHOST_CRYPTO_MAX_ZERO_COPY_OPTIONS
  19 };
  20
  21 /**
  22  *  Create Vhost-crypto instance
  23  *
  24  * @param vid
  25  *  The identifier of the vhost device.
  26  * @param cryptodev_id
  27  *  The identifier of DPDK Cryptodev, the same cryptodev_id can be assigned to
  28  *  multiple Vhost-crypto devices.
  29  * @param sess_pool
  30  *  The pointer to the created cryptodev session pool.
  31  * @param sess_priv_pool
  32  *  The pointer to the created cryptodev session private data mempool.
  33  * @param socket_id
  34  *  NUMA Socket ID to allocate resources on. *
  35  * @return
  36  *  0 if the Vhost Crypto Instance is created successfully.
  37  *  Negative integer if otherwise
  38  */
  39 __rte_experimental
  40 int
  41 rte_vhost_crypto_create(int vid, uint8_t cryptodev_id,
  42                 struct rte_mempool *sess_pool,
  43                 struct rte_mempool *sess_priv_pool,
  44                 int socket_id);
  45
  46 /**
  47  *  Free the Vhost-crypto instance
  48  *
  49  * @param vid
  50  *  The identifier of the vhost device.
  51  * @return
  52  *  0 if the Vhost Crypto Instance is created successfully.
  53  *  Negative integer if otherwise.
  54  */
  55 __rte_experimental
  56 int
  57 rte_vhost_crypto_free(int vid);
  58
  59 /**
  60  *  Enable or disable zero copy feature
  61  *
  62  * @param vid
  63  *  The identifier of the vhost device.
  64  * @param option
  65  *  Flag of zero copy feature.
  66  * @return
  67  *  0 if completed successfully.
  68  *  Negative integer if otherwise.
  69  */
  70 __rte_experimental
  71 int
  72 rte_vhost_crypto_set_zero_copy(int vid, enum rte_vhost_crypto_zero_copy option);
  73
  74 /**
  75  * Fetch a number of vring descriptors from virt-queue and translate to DPDK
  76  * crypto operations. After this function is executed, the user can enqueue
  77  * the processed ops to the target cryptodev.
  78  *
  79  * @param vid
  80  *  The identifier of the vhost device.
  81  * @param qid
  82  *  Virtio queue index.
  83  * @param ops
  84  *  The address of an array of pointers to *rte_crypto_op* structures that must
  85  *  be large enough to store *nb_ops* pointers in it.
  86  * @param nb_ops
  87  *  The maximum number of operations to be fetched and translated.
  88  * @return
  89  *  The number of fetched and processed vhost crypto request operations.
  90  */
  91 __rte_experimental
  92 uint16_t
  93 rte_vhost_crypto_fetch_requests(int vid, uint32_t qid,
  94                 struct rte_crypto_op **ops, uint16_t nb_ops);
  95 /**
  96  * Finalize the dequeued crypto ops. After the translated crypto ops are
  97  * dequeued from the cryptodev, this function shall be called to write the
  98  * processed data back to the vring descriptor (if no-copy is turned off).
  99  *
 100  * @param ops
 101  *  The address of an array of *rte_crypto_op* structure that was dequeued
 102  *  from cryptodev.
 103  * @param nb_ops
 104  *  The number of operations contained in the array.
 105  * @callfds
 106  *  The callfd number(s) contained in this burst, this shall be an array with
 107  *  no less than VIRTIO_CRYPTO_MAX_NUM_BURST_VQS elements.
 108  * @nb_callfds
 109  *  The number of call_fd numbers exist in the callfds.
 110  * @return
 111  *  The number of ops processed.
 112  */
 113 __rte_experimental
 114 uint16_t
 115 rte_vhost_crypto_finalize_requests(struct rte_crypto_op **ops,
 116                 uint16_t nb_ops, int *callfds, uint16_t *nb_callfds);
 117
 118 #endif /**< _VHOST_CRYPTO_H_ */