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