From patchwork Wed Dec 9 12:35:41 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Iremonger, Bernard" X-Patchwork-Id: 9434 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id EE9765955; Wed, 9 Dec 2015 13:35:51 +0100 (CET) Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by dpdk.org (Postfix) with ESMTP id E6C365952 for ; Wed, 9 Dec 2015 13:35:49 +0100 (CET) Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by orsmga103.jf.intel.com with ESMTP; 09 Dec 2015 04:35:48 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.20,403,1444719600"; d="scan'208";a="857214778" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by fmsmga001.fm.intel.com with ESMTP; 09 Dec 2015 04:35:47 -0800 Received: from sivswdev01.ir.intel.com (sivswdev01.ir.intel.com [10.237.217.45]) by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id tB9CZkOt006516; Wed, 9 Dec 2015 12:35:46 GMT Received: from sivswdev01.ir.intel.com (localhost [127.0.0.1]) by sivswdev01.ir.intel.com with ESMTP id tB9CZkpI009646; Wed, 9 Dec 2015 12:35:46 GMT Received: (from bairemon@localhost) by sivswdev01.ir.intel.com with id tB9CZk5f009642; Wed, 9 Dec 2015 12:35:46 GMT From: Bernard Iremonger To: dev@dpdk.org Date: Wed, 9 Dec 2015 12:35:41 +0000 Message-Id: <1449664541-9546-1-git-send-email-bernard.iremonger@intel.com> X-Mailer: git-send-email 1.7.4.1 Subject: [dpdk-dev] [PATCH 1/1] doc: correct Vhost Sample Application guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" correct sample console commands Fixes: d0dff9ba445e ("doc: sample application user guide" Fixes: 9bc23cb8209c ("doc: add vhost-user to sample guide") Fixes: 43866bf71d58 ("doc: fix vhost sample parameter") Signed-off-by: Bernard Iremonger Acked-by: Huawei Xie --- doc/guides/sample_app_ug/vhost.rst | 40 +++++++++++++++++++------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/doc/guides/sample_app_ug/vhost.rst b/doc/guides/sample_app_ug/vhost.rst index ceeaf52..70d31b6 100644 --- a/doc/guides/sample_app_ug/vhost.rst +++ b/doc/guides/sample_app_ug/vhost.rst @@ -1,6 +1,6 @@ .. BSD LICENSE - Copyright(c) 2010-2014 Intel Corporation. All rights reserved. + Copyright(c) 2010-2015 Intel Corporation. All rights reserved. All rights reserved. Redistribution and use in source and binary forms, with or without @@ -386,13 +386,13 @@ Running the Sample Code .. code-block:: console - user@target:~$ ./build/app/vhost-switch -c f -n 4 --huge-dir / mnt/huge -- -p 0x1 --dev-basename usvhost + user@target:~$ ./build/app/vhost-switch -c f -n 4 --socket-mem 1024 --huge-dir /mnt/huge -- -p 0x1 --dev-basename usvhost vhost user: a socket file named usvhost will be created under current directory. Use its path as the socket path in guest's qemu commandline. .. code-block:: console - user@target:~$ ./build/app/vhost-switch -c f -n 4 --huge-dir / mnt/huge -- -p 0x1 --dev-basename usvhost + user@target:~$ ./build/app/vhost-switch -c f -n 4 --socket-mem 1024 --huge-dir /mnt/huge -- -p 0x1 --dev-basename usvhost .. note:: @@ -411,7 +411,7 @@ For compatibility with the QEMU wrapper script, a base name of "usvhost" should .. code-block:: console - user@target:~$ ./build/app/vhost-switch -c f -n 4 --huge-dir / mnt/huge -- -p 0x1 --dev-basename usvhost + user@target:~$ ./build/app/vhost-switch -c f -n 4 --socket-mem 1024 --huge-dir /mnt/huge -- -p 0x1 --dev-basename usvhost **vm2vm.** The vm2vm parameter disable/set mode of packet switching between guests in the host. @@ -424,7 +424,7 @@ which bases on the packet destination MAC address and VLAN tag. .. code-block:: console - user@target:~$ ./build/app/vhost-switch -c f -n 4 --huge-dir /mnt/huge -- --vm2vm [0,1,2] + user@target:~$ ./build/app/vhost-switch -c f -n 4 --socket-mem 1024 --huge-dir /mnt/huge -- --vm2vm [0,1,2] **Mergeable Buffers.** The mergeable buffers parameter controls how virtio-net descriptors are used for virtio-net headers. @@ -434,7 +434,7 @@ The default value is 0 or disabled since recent kernels virtio-net drivers show .. code-block:: console - user@target:~$ ./build/app/vhost-switch -c f -n 4 --huge-dir / mnt/huge -- --mergeable [0,1] + user@target:~$ ./build/app/vhost-switch -c f -n 4 --socket-mem 1024 --huge-dir /mnt/huge -- --mergeable [0,1] **Stats.** The stats parameter controls the printing of virtio-net device statistics. @@ -442,7 +442,7 @@ The parameter specifies an interval second to print statistics, with an interval .. code-block:: console - user@target:~$ ./build/app/vhost-switch -c f -n 4 --huge-dir / mnt/huge -- --stats [0,n] + user@target:~$ ./build/app/vhost-switch -c f -n 4 --socket-mem 1024 --huge-dir /mnt/huge -- --stats [0,n] **RX Retry.** The rx-retry option enables/disables enqueue retries when the guests RX queue is full. @@ -452,7 +452,7 @@ This option is enabled by default. .. code-block:: console - user@target:~$ ./build/app/vhost-switch -c f -n 4 --huge-dir / mnt/huge -- --rx-retry [0,1] + user@target:~$ ./build/app/vhost-switch -c f -n 4 --socket-mem 1024 --huge-dir /mnt/huge -- --rx-retry [0,1] **RX Retry Number.** The rx-retry-num option specifies the number of retries on an RX burst, @@ -461,7 +461,7 @@ The default value is 4. .. code-block:: console - user@target:~$ ./build/app/vhost-switch -c f -n 4 --huge-dir / mnt/huge -- --rx-retry 1 --rx-retry-num 5 + user@target:~$ ./build/app/vhost-switch -c f -n 4 --socket-mem 1024 --huge-dir /mnt/huge -- --rx-retry 1 --rx-retry-num 5 **RX Retry Delay Time.** The rx-retry-delay option specifies the timeout (in micro seconds) between retries on an RX burst, @@ -470,7 +470,7 @@ The default value is 15. .. code-block:: console - user@target:~$ ./build/app/vhost-switch -c f -n 4 --huge-dir / mnt/huge -- --rx-retry 1 --rx-retry-delay 20 + user@target:~$ ./build/app/vhost-switch -c f -n 4 --socket-mem 1024 --huge-dir /mnt/huge -- --rx-retry 1 --rx-retry-delay 20 **Zero copy.** The zero copy option enables/disables the zero copy mode for RX/TX packet, @@ -481,7 +481,7 @@ This option is disabled by default. .. code-block:: console - user@target:~$ ./build/app/vhost-switch -c f -n 4 --huge-dir /mnt/huge -- --zero-copy [0,1] + user@target:~$ ./build/app/vhost-switch -c f -n 4 --socket-mem 1024 --huge-dir /mnt/huge -- --zero-copy [0,1] **RX descriptor number.** The RX descriptor number option specify the Ethernet RX descriptor number, @@ -494,7 +494,7 @@ So it is valid only in zero copy mode is enabled. The value is 32 by default. .. code-block:: console - user@target:~$ ./build/app/vhost-switch -c f -n 4 --huge-dir /mnt/huge -- --zero-copy 1 --rx-desc-num [0, n] + user@target:~$ ./build/app/vhost-switch -c f -n 4 --socket-mem 1024 --huge-dir /mnt/huge -- --zero-copy 1 --rx-desc-num [0, n] **TX descriptor number.** The TX descriptor number option specify the Ethernet TX descriptor number, it is valid only in zero copy mode is enabled. @@ -502,7 +502,7 @@ The value is 64 by default. .. code-block:: console - user@target:~$ ./build/app/vhost-switch -c f -n 4 --huge-dir /mnt/huge -- --zero-copy 1 --tx-desc-num [0, n] + user@target:~$ ./build/app/vhost-switch -c f -n 4 --socket-mem 1024 --huge-dir /mnt/huge -- --zero-copy 1 --tx-desc-num [0, n] **VLAN strip.** The VLAN strip option enable/disable the VLAN strip on host, if disabled, the guest will receive the packets with VLAN tag. @@ -510,7 +510,7 @@ It is enabled by default. .. code-block:: console - user@target:~$ ./build/app/vhost-switch -c f -n 4 --huge-dir /mnt/huge -- --vlan-strip [0, 1] + user@target:~$ ./build/app/vhost-switch -c f -n 4 --socket-mem 1024 --huge-dir /mnt/huge -- --vlan-strip [0, 1] Running the Virtual Machine (QEMU) ---------------------------------- @@ -539,7 +539,7 @@ QEMU must be executed with specific parameters to: .. code-block:: console - user@target:~$ qemu-system-x86_64 ... -mem-prealloc -mem-path / dev/hugepages ... + user@target:~$ qemu-system-x86_64 ... -mem-prealloc -mem-path /dev/hugepages ... .. note:: @@ -573,7 +573,7 @@ In this case, the path passed to the guest should be that of the 1 GB page huget .. code-block:: console - user@target:~$ qemu-system-x86_64 ... -mem-prealloc -mem-path / dev/hugepages ... + user@target:~$ qemu-system-x86_64 ... -mem-prealloc -mem-path /dev/hugepages ... .. note:: @@ -771,21 +771,21 @@ Run the testpmd application as follows: .. code-block:: console - user@target:~$ x86_64-native-linuxapp-gcc/app/testpmd -c 0x3 -- n 4 -socket-mem 128 -- --burst=64 -i + user@target:~$ x86_64-native-linuxapp-gcc/app/testpmd -c 0x3 -n 4 --socket-mem 512 -- --burst=64 --i --disable-hw-vlan-filter The destination MAC address for packets transmitted on each port can be set at the command line: .. code-block:: console - user@target:~$ x86_64-native-linuxapp-gcc/app/testpmd -c 0x3 -- n 4 -socket-mem 128 -- --burst=64 -i --eth- peer=0,aa:bb:cc:dd:ee:ff --eth-peer=1,ff,ee,dd,cc,bb,aa + user@target:~$ x86_64-native-linuxapp-gcc/app/testpmd -c 0x3 -n 4 --socket-mem 512 -- --burst=64 --i --disable-hw-vlan-filter --eth-peer=0,aa:bb:cc:dd:ee:ff --eth-peer=1,ff:ee:dd:cc:bb:aa * Packets received on port 1 will be forwarded on port 0 to MAC address - aa:bb:cc:dd:ee:ff. + aa:bb:cc:dd:ee:ff * Packets received on port 0 will be forwarded on port 1 to MAC address - ff,ee,dd,cc,bb,aa. + ff:ee:dd:cc:bb:aa The testpmd application can then be configured to act as an L2 forwarding application: