doc: add vhost async enqueue API usage

This patch updates the correct usage for async enqueue APIs.
The rte_vhost_poll_enqueue_completed() needs to be
called in time to notify the guest of completed packets and
avoid packet loss.

Signed-off-by: Xuan Ding <xuan.ding@intel.com>
Reviewed-by: Chenbo Xia <chenbo.xia@intel.com>
This commit is contained in:
Xuan Ding 2022-06-21 07:21:31 +00:00 committed by Maxime Coquelin
parent 41f9a1757f
commit 9851c4e339

View File

@ -486,6 +486,14 @@ the same vring with their own DMA virtual channels. Besides, the number
of DMA devices is limited. For the purpose of scaling, it's necessary to
support sharing DMA channels among vrings.
* Async enqueue API usage
In async enqueue path, rte_vhost_poll_enqueue_completed() needs to be
called in time to notify the guest of DMA copy completed packets.
Moreover, calling rte_vhost_submit_enqueue_burst() all the time but
not poll completed will cause the DMA ring to be full, which will
result in packet loss eventually.
Recommended IOVA mode in async datapath
---------------------------------------