1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2020 Intel Corporation
5 #ifndef _RTE_VHOST_ASYNC_H_
6 #define _RTE_VHOST_ASYNC_H_
13 struct rte_vhost_iov_iter {
14 /** offset to the first byte of interesting data */
16 /** total bytes of data in this iterator */
18 /** pointer to the iovec array */
20 /** number of iovec in this iterator */
21 unsigned long nr_segs;
25 * dma transfer descriptor pair
27 struct rte_vhost_async_desc {
28 /** source memory iov_iter */
29 struct rte_vhost_iov_iter *src;
30 /** destination memory iov_iter */
31 struct rte_vhost_iov_iter *dst;
37 struct rte_vhost_async_status {
38 /** An array of application specific data for source memory */
39 uintptr_t *src_opaque_data;
40 /** An array of application specific data for destination memory */
41 uintptr_t *dst_opaque_data;
45 * dma operation callbacks to be implemented by applications
47 struct rte_vhost_async_channel_ops {
49 * instruct async engines to perform copies for a batch of packets
52 * id of vhost device to perform data copies
54 * queue id to perform data copies
56 * an array of DMA transfer memory descriptors
58 * opaque data pair sending to DMA engine
60 * number of elements in the "descs" array
62 * number of descs processed
64 uint32_t (*transfer_data)(int vid, uint16_t queue_id,
65 struct rte_vhost_async_desc *descs,
66 struct rte_vhost_async_status *opaque_data,
69 * check copy-completed packets from the async engine
71 * id of vhost device to check copy completion
73 * queue id to check copy completion
75 * buffer to receive the opaque data pair from DMA engine
77 * max number of packets could be completed
79 * number of async descs completed
81 uint32_t (*check_completed_copies)(int vid, uint16_t queue_id,
82 struct rte_vhost_async_status *opaque_data,
83 uint16_t max_packets);
87 * inflight async packet information
89 struct async_inflight_info {
90 struct rte_mbuf *mbuf;
91 uint16_t descs; /* num of descs inflight */
95 * dma channel feature bit definition
97 struct rte_vhost_async_features {
101 uint32_t async_inorder:1;
103 uint32_t async_threshold:12;
110 * register an async channel for vhost
113 * vhost device id async channel to be attached to
115 * vhost queue id async channel to be attached to
117 * DMA channel feature bit
118 * b0 : DMA supports inorder data transfer
120 * b16 - b27: Packet length threshold for DMA transfer
121 * b28 - b31: reserved
123 * DMA operation callbacks
125 * 0 on success, -1 on failures
128 int rte_vhost_async_channel_register(int vid, uint16_t queue_id,
129 uint32_t features, struct rte_vhost_async_channel_ops *ops);
132 * unregister a dma channel for vhost
135 * vhost device id DMA channel to be detached
137 * vhost queue id DMA channel to be detached
139 * 0 on success, -1 on failures
142 int rte_vhost_async_channel_unregister(int vid, uint16_t queue_id);
145 * This function submits enqueue data to async engine. Successfully
146 * enqueued packets can be transfer completed or being occupied by DMA
147 * engines, when this API returns. Transfer completed packets are returned
148 * in comp_pkts, so users need to guarantee its size is greater than or
149 * equal to the size of pkts; for packets that are successfully enqueued
150 * but not transfer completed, users should poll transfer status by
151 * rte_vhost_poll_enqueue_completed().
154 * id of vhost device to enqueue data
156 * queue id to enqueue data
158 * array of packets to be enqueued
160 * packets num to be enqueued
162 * empty array to get transfer completed packets. Users need to
163 * guarantee its size is greater than or equal to that of pkts
165 * num of packets that are transfer completed, when this API returns.
166 * If no packets are transfer completed, its value is set to 0.
168 * num of packets enqueued, including in-flight and transfer completed
171 uint16_t rte_vhost_submit_enqueue_burst(int vid, uint16_t queue_id,
172 struct rte_mbuf **pkts, uint16_t count,
173 struct rte_mbuf **comp_pkts, uint32_t *comp_count);
176 * This function checks async completion status for a specific vhost
177 * device queue. Packets which finish copying (enqueue) operation
178 * will be returned in an array.
181 * id of vhost device to enqueue data
183 * queue id to enqueue data
185 * blank array to get return packet pointer
187 * size of the packet array
189 * num of packets returned
192 uint16_t rte_vhost_poll_enqueue_completed(int vid, uint16_t queue_id,
193 struct rte_mbuf **pkts, uint16_t count);
195 #endif /* _RTE_VHOST_ASYNC_H_ */