1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017-2018 Intel Corporation
5 #ifndef _VHOST_CRYPTO_H_
6 #define _VHOST_CRYPTO_H_
8 #define VHOST_CRYPTO_MBUF_POOL_SIZE (8192)
9 #define VHOST_CRYPTO_MAX_BURST_SIZE (64)
10 #define VHOST_CRYPTO_MAX_DATA_SIZE (4096)
11 #define VHOST_CRYPTO_SESSION_MAP_ENTRIES (1024) /**< Max nb sessions */
12 /** max nb virtual queues in a burst for finalizing*/
13 #define VIRTIO_CRYPTO_MAX_NUM_BURST_VQS (64)
14 #define VHOST_CRYPTO_MAX_IV_LEN (32)
15 #define VHOST_CRYPTO_MAX_N_DESC (32)
17 enum rte_vhost_crypto_zero_copy {
18 RTE_VHOST_CRYPTO_ZERO_COPY_DISABLE = 0,
19 RTE_VHOST_CRYPTO_ZERO_COPY_ENABLE = 1,
20 RTE_VHOST_CRYPTO_MAX_ZERO_COPY_OPTIONS
24 * Start vhost crypto driver
27 * The vhost-user socket file path
29 * 0 on success, -1 on failure
33 rte_vhost_crypto_driver_start(const char *path);
36 * Create Vhost-crypto instance
39 * The identifier of the vhost device.
41 * The identifier of DPDK Cryptodev, the same cryptodev_id can be assigned to
42 * multiple Vhost-crypto devices.
44 * The pointer to the created cryptodev session pool.
45 * @param sess_priv_pool
46 * The pointer to the created cryptodev session private data mempool.
48 * NUMA Socket ID to allocate resources on. *
50 * 0 if the Vhost Crypto Instance is created successfully.
51 * Negative integer if otherwise
55 rte_vhost_crypto_create(int vid, uint8_t cryptodev_id,
56 struct rte_mempool *sess_pool,
57 struct rte_mempool *sess_priv_pool,
61 * Free the Vhost-crypto instance
64 * The identifier of the vhost device.
66 * 0 if the Vhost Crypto Instance is created successfully.
67 * Negative integer if otherwise.
71 rte_vhost_crypto_free(int vid);
74 * Enable or disable zero copy feature
77 * The identifier of the vhost device.
79 * Flag of zero copy feature.
81 * 0 if completed successfully.
82 * Negative integer if otherwise.
86 rte_vhost_crypto_set_zero_copy(int vid, enum rte_vhost_crypto_zero_copy option);
89 * Fetch a number of vring descriptors from virt-queue and translate to DPDK
90 * crypto operations. After this function is executed, the user can enqueue
91 * the processed ops to the target cryptodev.
94 * The identifier of the vhost device.
98 * The address of an array of pointers to *rte_crypto_op* structures that must
99 * be large enough to store *nb_ops* pointers in it.
101 * The maximum number of operations to be fetched and translated.
103 * The number of fetched and processed vhost crypto request operations.
107 rte_vhost_crypto_fetch_requests(int vid, uint32_t qid,
108 struct rte_crypto_op **ops, uint16_t nb_ops);
110 * Finalize the dequeued crypto ops. After the translated crypto ops are
111 * dequeued from the cryptodev, this function shall be called to write the
112 * processed data back to the vring descriptor (if no-copy is turned off).
115 * The address of an array of *rte_crypto_op* structure that was dequeued
118 * The number of operations contained in the array.
120 * The callfd number(s) contained in this burst, this shall be an array with
121 * no less than VIRTIO_CRYPTO_MAX_NUM_BURST_VQS elements.
123 * The number of call_fd numbers exist in the callfds.
125 * The number of ops processed.
129 rte_vhost_crypto_finalize_requests(struct rte_crypto_op **ops,
130 uint16_t nb_ops, int *callfds, uint16_t *nb_callfds);
132 #endif /**< _VHOST_CRYPTO_H_ */