Document packed virtqueue vectorized path selection logic in virtio net
PMD.
Signed-off-by: Marvin Liu <yong....@intel.com>
diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
index 6286286db..4bd46f83e 100644
--- a/doc/guides/nics/virtio.rst
+++ b/doc/guides/nics/virtio.rst
@@ -417,6 +417,10 @@ Below devargs are supported by the virtio-user vdev:
rte_eth_link_get_nowait function.
(Default: 10000 (10G))
+#. ``vectorized``:
+
+ It is used to enable virtio device vectorized path.
+ (Default: 0 (disabled))
Virtio paths Selection and Usage
--------------------------------
@@ -469,6 +473,13 @@ according to below configuration:
both negotiated, this path will be selected.
#. Packed virtqueue in-order non-mergeable path: If in-order feature is
negotiated and
Rx mergeable is not negotiated, this path will be selected.
+#. Packed virtqueue vectorized Rx path: If building and running environment
support
+ AVX512 && in-order feature is negotiated && Rx mergeable is not negotiated
&&
+ TCP_LRO Rx offloading is disabled && vectorized option enabled,
+ this path will be selected.
+#. Packed virtqueue vectorized Tx path: If building and running environment
support
+ AVX512 && in-order feature is negotiated && vectorized option enabled,
+ this path will be selected.
Rx/Tx callbacks of each Virtio path
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -491,6 +502,8 @@ are shown in below table:
Packed virtqueue non-meregable path virtio_recv_pkts_packed
virtio_xmit_pkts_packed
Packed virtqueue in-order mergeable path
virtio_recv_mergeable_pkts_packed virtio_xmit_pkts_packed
Packed virtqueue in-order non-mergeable path virtio_recv_pkts_packed
virtio_xmit_pkts_packed
+ Packed virtqueue vectorized Rx path virtio_recv_pkts_packed_vec
virtio_xmit_pkts_packed
+ Packed virtqueue vectorized Tx path virtio_recv_pkts_packed
virtio_xmit_pkts_packed_vec
============================================
================================= ========================
Virtio paths Support Status from Release to Release
@@ -508,20 +521,22 @@ All virtio paths support status are shown in below table:
.. table:: Virtio Paths and Releases
- ============================================ ============= =============
=============
- Virtio paths 16.11 ~ 18.05 18.08 ~ 18.11
19.02 ~ 19.11
- ============================================ ============= =============
=============
- Split virtqueue mergeable path Y Y
Y
- Split virtqueue non-mergeable path Y Y
Y
- Split virtqueue vectorized Rx path Y Y
Y
- Split virtqueue simple Tx path Y N
N
- Split virtqueue in-order mergeable path Y
Y
- Split virtqueue in-order non-mergeable path Y
Y
- Packed virtqueue mergeable path
Y
- Packed virtqueue non-mergeable path
Y
- Packed virtqueue in-order mergeable path
Y
- Packed virtqueue in-order non-mergeable path
Y
- ============================================ ============= =============
=============
+ ============================================ ============= =============
============= =======
+ Virtio paths 16.11 ~ 18.05 18.08 ~ 18.11
19.02 ~ 19.11 20.05 ~
+ ============================================ ============= =============
============= =======
+ Split virtqueue mergeable path Y Y
Y Y
+ Split virtqueue non-mergeable path Y Y
Y Y
+ Split virtqueue vectorized Rx path Y Y
Y Y
+ Split virtqueue simple Tx path Y N
N N
+ Split virtqueue in-order mergeable path Y
Y Y
+ Split virtqueue in-order non-mergeable path Y
Y Y
+ Packed virtqueue mergeable path
Y Y
+ Packed virtqueue non-mergeable path
Y Y
+ Packed virtqueue in-order mergeable path
Y Y
+ Packed virtqueue in-order non-mergeable path
Y Y
+ Packed virtqueue vectorized Rx path
Y
+ Packed virtqueue vectorized Tx path
Y
+ ============================================ ============= =============
============= =======
QEMU Support Status
~~~~~~~~~~~~~~~~~~~
--
2.17.1
