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