git.droids-corp.org / dpdk.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
doc: rebuild with meson whenever a file changes
[dpdk.git] / doc / guides / howto / virtio_user_as_exceptional_path.rst
diff --git a/doc/guides/howto/virtio_user_as_exceptional_path.rst b/doc/guides/howto/virtio_user_as_exceptional_path.rst
index 26a72e2..ec021af 100644 (file)
--- a/doc/guides/howto/virtio_user_as_exceptional_path.rst
+++ b/doc/guides/howto/virtio_user_as_exceptional_path.rst
@@ -1,34 +1,7 @@
-..  BSD LICENSE
-    Copyright(c) 2016 Intel Corporation. All rights reserved.
-    All rights reserved.
-
-    Redistribution and use in source and binary forms, with or without
-    modification, are permitted provided that the following conditions
-    are met:
-
-    * Redistributions of source code must retain the above copyright
-    notice, this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright
-    notice, this list of conditions and the following disclaimer in
-    the documentation and/or other materials provided with the
-    distribution.
-    * Neither the name of Intel Corporation nor the names of its
-    contributors may be used to endorse or promote products derived
-    from this software without specific prior written permission.
-
-    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-.. _virtio_user_as_excpetional_path:
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2016 Intel Corporation.
+
+.. _virtio_user_as_exceptional_path:
 
 Virtio_user as Exceptional Path
 ===============================
 
 Virtio_user as Exceptional Path
 ===============================
@@ -49,12 +22,12 @@ solution is very promising in:
 *   Features
 
     vhost-net is born to be a networking solution, which has lots of networking
 *   Features
 
     vhost-net is born to be a networking solution, which has lots of networking
-    related featuers, like multi queue, tso, multi-seg mbuf, etc.
+    related features, like multi queue, tso, multi-seg mbuf, etc.
 
 *   Performance
 
     similar to KNI, this solution would use one or more kthreads to
 
 *   Performance
 
     similar to KNI, this solution would use one or more kthreads to
-    send/receive packets from user space DPDK applications, which has little
+    send/receive packets to/from user space DPDK applications, which has little
     impact on user space polling thread (except that it might enter into kernel
     space to wake up those kthreads if necessary).
 
     impact on user space polling thread (except that it might enter into kernel
     space to wake up those kthreads if necessary).
 
@@ -65,7 +38,7 @@ in :numref:`figure_virtio_user_as_exceptional_path`.
 
 .. figure:: img/virtio_user_as_exceptional_path.*
 
 
 .. figure:: img/virtio_user_as_exceptional_path.*
 
-   Overview of a DPDK app using virtio-user as excpetional path
+   Overview of a DPDK app using virtio-user as exceptional path
 
 
 Sample Usage
 
 
 Sample Usage
@@ -82,10 +55,10 @@ compiling the kernel and those kernel modules should be inserted.
 
     .. code-block:: console
 
 
     .. code-block:: console
 
-        $(testpmd) -c 0xc -n 4 \
+        $(testpmd) -l 2-3 -n 4 \
                --vdev=virtio_user0,path=/dev/vhost-net,queue_size=1024 \
                --vdev=virtio_user0,path=/dev/vhost-net,queue_size=1024 \
-               -- -i --txqflags=0x0 --disable-hw-vlan --enable-lro --crc-strip
-               --enable-rx-cksum --rxd=1024 --txd=1024
+               -- -i --tx-offloads=0x0000002c --enable-lro \
+               --txd=1024 --rxd=1024
 
     This command runs testpmd with two ports, one physical NIC to communicate
     with outside, and one virtio-user to communicate with kernel.
 
     This command runs testpmd with two ports, one physical NIC to communicate
     with outside, and one virtio-user to communicate with kernel.
@@ -94,12 +67,7 @@ compiling the kernel and those kernel modules should be inserted.
 
     This is used to negotiate VIRTIO_NET_F_GUEST_TSO4 and
     VIRTIO_NET_F_GUEST_TSO6 feature so that large packets from kernel can be
 
     This is used to negotiate VIRTIO_NET_F_GUEST_TSO4 and
     VIRTIO_NET_F_GUEST_TSO6 feature so that large packets from kernel can be
-    transmitted DPDK application and further TSOed by physical NIC.
-
-* ``--enable-rx-cksum``
-
-    This is used to negotiate VIRTIO_NET_F_GUEST_CSUM so that packets from
-    kernel can be deemed as valid Rx checksumed.
+    transmitted to DPDK application and further TSOed by physical NIC.
 
 * ``queue_size``
 
 
 * ``queue_size``
 
@@ -107,15 +75,23 @@ compiling the kernel and those kernel modules should be inserted.
 
 * ``queues``
 
 
 * ``queues``
 
-    Number of multi-queues. Each qeueue will be served by a kthread. For example:
+    Number of multi-queues. Each queue will be served by a kthread. For example:
 
     .. code-block:: console
 
 
     .. code-block:: console
 
-        $(testpmd) -c 0xc -n 4 \
+        $(testpmd) -l 2-3 -n 4 \
                --vdev=virtio_user0,path=/dev/vhost-net,queues=2,queue_size=1024 \
                --vdev=virtio_user0,path=/dev/vhost-net,queues=2,queue_size=1024 \
-               -- -i --txqflags=0x0 --disable-hw-vlan --enable-lro \
-               --crc-strip --enable-rx-cksum --txq=2 --rxq=2 --rxd=1024 \
-               --txd=1024
+               -- -i --tx-offloads=0x0000002c --enable-lro \
+               --txq=2 --rxq=2 --txd=1024 --rxd=1024
+
+#. Enable Rx checksum offloads in testpmd:
+
+    .. code-block:: console
+
+        (testpmd) port stop 0
+        (testpmd) port config 0 rx_offload tcp_cksum on
+        (testpmd) port config 0 rx_offload udp_cksum on
+        (testpmd) port start 0
 
 #. Start testpmd:
 
 
 #. Start testpmd:
 
DPDK repo used for reviews