X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fprog_guide%2Fvhost_lib.rst;h=171e0096f6d4ca44de6f122cc12ec173ff47a6f4;hb=6cc51b1293ceac4a77d4bf7ac91a8bbd59e1f78c;hp=258ca3e9d4ad93fc3be6714b50c9a31f3494932e;hpb=acbc38887b0a8c564e1f3fe1d9f65dfeb0d3c57a;p=dpdk.git diff --git a/doc/guides/prog_guide/vhost_lib.rst b/doc/guides/prog_guide/vhost_lib.rst index 258ca3e9d4..171e0096f6 100644 --- a/doc/guides/prog_guide/vhost_lib.rst +++ b/doc/guides/prog_guide/vhost_lib.rst @@ -235,13 +235,6 @@ The following is an overview of some key Vhost API functions: Currently, only ``RTE_VHOST_ASYNC_INORDER`` capable device is supported by vhost. - * ``async_threshold`` - - The copy length (in bytes) below which CPU copy will be used even if - applications call async vhost APIs to enqueue/dequeue data. - - Typical value is 256~1024 depending on the async device capability. - Applications must provide following ``ops`` callbacks for vhost lib to work with the async copy devices: @@ -256,6 +249,14 @@ The following is an overview of some key Vhost API functions: vhost invokes this function to get the copy data completed by async devices. +* ``rte_vhost_async_channel_register_thread_unsafe(vid, queue_id, config, ops)`` + + Register an async copy device channel for a vhost queue without + performing any locking. + + This function is only safe to call in vhost callback functions + (i.e., struct vhost_device_ops). + * ``rte_vhost_async_channel_unregister(vid, queue_id)`` Unregister the async copy device channel from a vhost queue. @@ -268,6 +269,14 @@ The following is an overview of some key Vhost API functions: devices for all vhost queues in destroy_device(), when a virtio device is paused or shut down. +* ``rte_vhost_async_channel_unregister_thread_unsafe(vid, queue_id)`` + + Unregister the async copy device channel for a vhost queue without + performing any locking. + + This function is only safe to call in vhost callback functions + (i.e., struct vhost_device_ops). + * ``rte_vhost_submit_enqueue_burst(vid, queue_id, pkts, count, comp_pkts, comp_count)`` Submit an enqueue request to transmit ``count`` packets from host to guest @@ -289,6 +298,11 @@ The following is an overview of some key Vhost API functions: This function returns the amount of in-flight packets for the vhost queue using async acceleration. +* ``rte_vhost_clear_queue_thread_unsafe(vid, queue_id, **pkts, count)`` + + Clear inflight packets which are submitted to DMA engine in vhost async data + path. Completed packets are returned to applications through ``pkts``. + Vhost-user Implementations --------------------------