From patchwork Tue Jun 21 12:13:13 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Herakliusz Lipiec X-Patchwork-Id: 113171 X-Patchwork-Delegate: maxime.coquelin@redhat.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id AA139A00C5; Tue, 21 Jun 2022 14:08:47 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 9AAB24069C; Tue, 21 Jun 2022 14:08:47 +0200 (CEST) Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by mails.dpdk.org (Postfix) with ESMTP id 4342740151 for ; Tue, 21 Jun 2022 14:08:46 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1655813326; x=1687349326; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=Mv8EIfMfHNw3qwJDcQbxUTLKR4SjTA4fjPPsT4qpp08=; b=Y2/R1dELGi/F0sVq4p8GrMn9aPXpNDHVaBIyLTB7I8RvjOaC+8cie728 EIrUiUDGg0yOsDMNMt/T9QQ3wlN/suGF1upHoK7kw6VGNxEw3qclo3OCZ bRLHStjoTjtJtB1C8xwAT64Y7PjMxuPhpAuLM8Rb5Nq+oGFeKNFarK0ah ZdMUMlTv0cYO5gJfyrYUwqBu2FL3Z2dSpFp43i7oi8I1ZHnkxpmVygcA3 JQWkj5rs77bveBg265OZc9Jp77xqI0ORRP+a2ELSmd0fwEvuZdVP+bQ7n B2PjGKZM8qzXAsjsVE0jwM6Xt1qCmAAAnIHekTpCHzL4m3UeiNFTa4aE7 Q==; X-IronPort-AV: E=McAfee;i="6400,9594,10384"; a="344094143" X-IronPort-AV: E=Sophos;i="5.92,209,1650956400"; d="scan'208";a="344094143" Received: from orsmga007.jf.intel.com ([10.7.209.58]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Jun 2022 05:08:45 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.92,209,1650956400"; d="scan'208";a="585259488" Received: from silpixa00399499.ir.intel.com (HELO silpixa00399499.ger.corp.intel.com) ([10.237.223.138]) by orsmga007.jf.intel.com with ESMTP; 21 Jun 2022 05:08:44 -0700 From: Herakliusz Lipiec To: maxime.coquelin@redhat.com, chenbo.xia@intel.com, bruce.richardson@intel.com Cc: dev@dpdk.org, Herakliusz Lipiec Subject: [PATCH v2 1/3] examples/vhost: update makefile to match meson build system Date: Tue, 21 Jun 2022 13:13:13 +0100 Message-Id: <20220621121315.1173180-1-herakliusz.lipiec@intel.com> X-Mailer: git-send-email 2.36.1 In-Reply-To: <20220607114856.1085803-1-herakliusz.lipiec@intel.com> References: <20220607114856.1085803-1-herakliusz.lipiec@intel.com> MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Meson build system creates a vhost binary but Makefile and docs reference same as vhost-switch. Updating makefile to match meson and the docs accordingly. Signed-off-by: Herakliusz Lipiec Acked-by: Bruce Richardson --- V2: * Moving relevant doc updates here from second patch as per Bruces suggestion. --- doc/guides/sample_app_ug/vhost.rst | 10 +++++----- examples/vhost/Makefile | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/guides/sample_app_ug/vhost.rst b/doc/guides/sample_app_ug/vhost.rst index a6ce4bc8ac..3c3cfdcd2d 100644 --- a/doc/guides/sample_app_ug/vhost.rst +++ b/doc/guides/sample_app_ug/vhost.rst @@ -17,10 +17,10 @@ Testing steps ------------- This section shows the steps how to test a typical PVP case with this -vhost-switch sample, whereas packets are received from the physical NIC +dpdk-vhost sample, whereas packets are received from the physical NIC port first and enqueued to the VM's Rx queue. Through the guest testpmd's default forwarding mode (io forward), those packets will be put into -the Tx queue. The vhost-switch example, in turn, gets the packets and +the Tx queue. The dpdk-vhost example, in turn, gets the packets and puts back to the same physical NIC port. Build @@ -38,7 +38,7 @@ Start the vswitch example .. code-block:: console - ./dpdk-vhost-switch -l 0-3 -n 4 --socket-mem 1024 \ + ./dpdk-vhost -l 0-3 -n 4 --socket-mem 1024 \ -- --socket-file /tmp/sock0 --client \ ... @@ -90,10 +90,10 @@ Then start testpmd for packet forwarding testing. Inject packets -------------- -While a virtio-net is connected to vhost-switch, a VLAN tag starts with +While a virtio-net is connected to dpdk-vhost, a VLAN tag starts with 1000 is assigned to it. So make sure configure your packet generator with the right MAC and VLAN tag, you should be able to see following -log from the vhost-switch console. It means you get it work:: +log from the dpdk-vhost console. It means you get it work:: VHOST_DATA: (0) mac 52:54:00:00:00:14 and vlan 1000 registered diff --git a/examples/vhost/Makefile b/examples/vhost/Makefile index 975a5dfe40..ea64f02bb0 100644 --- a/examples/vhost/Makefile +++ b/examples/vhost/Makefile @@ -2,7 +2,7 @@ # Copyright(c) 2010-2014 Intel Corporation # binary name -APP = vhost-switch +APP = dpdk-vhost # all source are stored in SRCS-y SRCS-y := main.c virtio_net.c From patchwork Tue Jun 21 12:13:14 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Herakliusz Lipiec X-Patchwork-Id: 113172 X-Patchwork-Delegate: maxime.coquelin@redhat.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 7563EA00C5; Tue, 21 Jun 2022 14:08:54 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 088A5427EE; Tue, 21 Jun 2022 14:08:53 +0200 (CEST) Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by mails.dpdk.org (Postfix) with ESMTP id EA0404280B for ; Tue, 21 Jun 2022 14:08:48 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1655813329; x=1687349329; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=KjJz92nsJOI9AMJEyyG2dMcjzG0JY3GMI5/DMUIV1tM=; b=YOp1DFrnCI6lODn47pPSekBtN8wF7rPt73ACHx8/wQnnmDyBTaRvaplm C9BgLX3IGwKMkbGCTWU7nle8+4ivSLHIFaUJGv89QunktB4LHRvrH25Kk ca/G6mGXo0MXpsCscXmbAJbdG45fvhC5GEgkuTgR+h7vnsaDKnTA+R0Zh Bu9PmfZ5aPeDyE0oqUYhpQ7GidxW14yeuGHLElb7VbRC68XwnhqGBVGWl i+buhxC5vPeriQ4yTfd1S0bOGOTTNJcvoUggJ0XkQemqRQj9y4L1nb3Sy /lyjcITSdWuyXFsb0d43uEEVhE6o8mcq6v9tNc/yl4/qAzD/MbJMrJnaw w==; X-IronPort-AV: E=McAfee;i="6400,9594,10384"; a="344094147" X-IronPort-AV: E=Sophos;i="5.92,209,1650956400"; d="scan'208";a="344094147" Received: from orsmga007.jf.intel.com ([10.7.209.58]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Jun 2022 05:08:48 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.92,209,1650956400"; d="scan'208";a="585259503" Received: from silpixa00399499.ir.intel.com (HELO silpixa00399499.ger.corp.intel.com) ([10.237.223.138]) by orsmga007.jf.intel.com with ESMTP; 21 Jun 2022 05:08:47 -0700 From: Herakliusz Lipiec To: maxime.coquelin@redhat.com, chenbo.xia@intel.com, bruce.richardson@intel.com Cc: dev@dpdk.org, Herakliusz Lipiec Subject: [PATCH v2 2/3] doc: update vhost sample app docs Date: Tue, 21 Jun 2022 13:13:14 +0100 Message-Id: <20220621121315.1173180-2-herakliusz.lipiec@intel.com> X-Mailer: git-send-email 2.36.1 In-Reply-To: <20220621121315.1173180-1-herakliusz.lipiec@intel.com> References: <20220607114856.1085803-1-herakliusz.lipiec@intel.com> <20220621121315.1173180-1-herakliusz.lipiec@intel.com> MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Vhost sample app documentation describes parameters that are not in the code and omits parameters that exist. Also switching the order of sections on running vhost and VM, since the --client parameter in the sample line requires a socket to be created by VM. Removing uio references and updating with vfio-pci. Signed-off-by: Herakliusz Lipiec --- V2: * Rewording portmask description as suggested by Chenbo. --- doc/guides/sample_app_ug/vhost.rst | 67 ++++++++++++++++-------------- 1 file changed, 35 insertions(+), 32 deletions(-) diff --git a/doc/guides/sample_app_ug/vhost.rst b/doc/guides/sample_app_ug/vhost.rst index 3c3cfdcd2d..8e7646b805 100644 --- a/doc/guides/sample_app_ug/vhost.rst +++ b/doc/guides/sample_app_ug/vhost.rst @@ -33,19 +33,7 @@ The application is located in the ``vhost`` sub-directory. .. note:: In this example, you need build DPDK both on the host and inside guest. -Start the vswitch example -~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: console - - ./dpdk-vhost -l 0-3 -n 4 --socket-mem 1024 \ - -- --socket-file /tmp/sock0 --client \ - ... - -Check the `Parameters`_ section for the explanations on what do those -parameters mean. - -.. _vhost_app_run_vm: +. _vhost_app_run_vm: Start the VM ~~~~~~~~~~~~ @@ -66,6 +54,19 @@ Start the VM some specific features, a higher version might be need. Such as QEMU 2.7 (or above) for the reconnect feature. + +Start the vswitch example +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: console + + ./dpdk-vhost -l 0-3 -n 4 --socket-mem 1024 \ + -- --socket-file /tmp/sock0 --client \ + ... + +Check the `Parameters`_ section for the explanations on what do those +parameters mean. + .. _vhost_app_run_dpdk_inside_guest: Run testpmd inside guest @@ -77,8 +78,8 @@ could be done by: .. code-block:: console - modprobe uio_pci_generic - dpdk/usertools/dpdk-devbind.py -b uio_pci_generic 0000:00:04.0 + modprobe vfio-pci + dpdk/usertools/dpdk-devbind.py -b vfio-pci 0000:00:04.0 Then start testpmd for packet forwarding testing. @@ -87,6 +88,9 @@ Then start testpmd for packet forwarding testing. .//app/dpdk-testpmd -l 0-1 -- -i > start tx_first +For more information about vIOMMU and NO-IOMMU and VFIO please refer to +:doc:`/../linux_gsg/linux_drivers` section of the DPDK Getting started guide. + Inject packets -------------- @@ -146,26 +150,10 @@ The rx-retry-delay option specifies the timeout (in micro seconds) between retries on an RX burst, it takes effect only when rx retry is enabled. The default value is 15. -**--dequeue-zero-copy** -Dequeue zero copy will be enabled when this option is given. it is worth to -note that if NIC is bound to driver with iommu enabled, dequeue zero copy -cannot work at VM2NIC mode (vm2vm=0) due to currently we don't setup iommu -dma mapping for guest memory. - -**--vlan-strip 0|1** -VLAN strip option is removed, because different NICs have different behaviors -when disabling VLAN strip. Such feature, which heavily depends on hardware, -should be removed from this example to reduce confusion. Now, VLAN strip is -enabled and cannot be disabled. - **--builtin-net-driver** A very simple vhost-user net driver which demonstrates how to use the generic vhost APIs will be used when this option is given. It is disabled by default. -**--dma-type** -This parameter is used to specify DMA type for async vhost-user net driver which -demonstrates how to use the async vhost APIs. It's used in combination with dmas. - **--dmas** This parameter is used to specify the assigned DMA device of a vhost device. Async vhost-user net driver will be used if --dmas is set. For example @@ -173,6 +161,20 @@ Async vhost-user net driver will be used if --dmas is set. For example device 0 enqueue operation and use DMA channel 00:04.1 for vhost device 1 enqueue operation. +**--total-num-mbufs 0-N** +This parameter sets the number of mbufs to be allocated in mbuf pools, +the default value is 147456. This is can be used if launch of a port fails +due to shortage of mbufs. + +**--tso 0|1** +Disables/enables TCP segment offload. + +**--tx-csum 0|1** +Disables/enables TX checksum offload. + +**-p mask** +Port mask which specifies the ports to be used + Common Issues ------------- @@ -201,7 +203,8 @@ Common Issues mbuf pool size is dependent on the MAX_QUEUES configuration, if NIC's max queue number is larger than 128, device start will fail due to - insufficient mbuf. + insufficient mbuf. This can be adjusted using ``--total-num-mbufs`` + parameter. * Option "builtin-net-driver" is incompatible with QEMU From patchwork Tue Jun 21 12:13:15 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Herakliusz Lipiec X-Patchwork-Id: 113173 X-Patchwork-Delegate: maxime.coquelin@redhat.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 4D459A00C5; Tue, 21 Jun 2022 14:09:00 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id EB6E84281A; Tue, 21 Jun 2022 14:08:55 +0200 (CEST) Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by mails.dpdk.org (Postfix) with ESMTP id 1F707427F4 for ; Tue, 21 Jun 2022 14:08:52 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1655813333; x=1687349333; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=sINcacvjFub2z5r2mQZaLaOdSh5Oej3clupXwJUf4mE=; b=oCacSgkzHyhiWXNmcDgtrSUAd16pbRzISKwZBm00/AcG9UQSpKWqOCDs F1gGOHpKs4zIDGFnX5Jl5+PRovhaHsKA4q8G6AdhY1jyfpEpzLDvGCymw d/9ECUF4j63xxjQPt7qOQuS1VK3coN8APwhl2KEMvVO1Zk/j7CDVSVrfW F595wFuFyxC48kdRE6KOs2rvp1WUPyW89hSPvOQiieoiY3y/gAxmyNWHO wL1QCLhdrCHR+uoKCBvCb7TrJ/9lRpha21PCRP9jCI/E/SG7Bero4K+98 n0SsUiq1GA99n7eUPTgAVZdJMKyxWCiPzLMqDGQBekdlXJDqcCnK5AqgT w==; X-IronPort-AV: E=McAfee;i="6400,9594,10384"; a="344094157" X-IronPort-AV: E=Sophos;i="5.92,209,1650956400"; d="scan'208";a="344094157" Received: from orsmga007.jf.intel.com ([10.7.209.58]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Jun 2022 05:08:52 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.92,209,1650956400"; d="scan'208";a="585259513" Received: from silpixa00399499.ir.intel.com (HELO silpixa00399499.ger.corp.intel.com) ([10.237.223.138]) by orsmga007.jf.intel.com with ESMTP; 21 Jun 2022 05:08:51 -0700 From: Herakliusz Lipiec To: maxime.coquelin@redhat.com, chenbo.xia@intel.com, bruce.richardson@intel.com Cc: dev@dpdk.org, Herakliusz Lipiec Subject: [PATCH v2 3/3] examples/vhost: update vhost usage message Date: Tue, 21 Jun 2022 13:13:15 +0100 Message-Id: <20220621121315.1173180-3-herakliusz.lipiec@intel.com> X-Mailer: git-send-email 2.36.1 In-Reply-To: <20220621121315.1173180-1-herakliusz.lipiec@intel.com> References: <20220607114856.1085803-1-herakliusz.lipiec@intel.com> <20220621121315.1173180-1-herakliusz.lipiec@intel.com> MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org updating vhost usage message to be aligned with the documentation. Signed-off-by: Herakliusz Lipiec Reviewed-by: Chenbo Xia --- examples/vhost/main.c | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/examples/vhost/main.c b/examples/vhost/main.c index c4d46de1c5..bb1aadffa9 100644 --- a/examples/vhost/main.c +++ b/examples/vhost/main.c @@ -601,7 +601,6 @@ us_vhost_usage(const char *prgname) " --vm2vm [0|1|2]\n" " --rx_retry [0|1] --mergeable [0|1] --stats [0-N]\n" " --socket-file \n" - " --nb-devices ND\n" " -p PORTMASK: Set mask for ports to be used by application\n" " --vm2vm [0|1|2]: disable/software(default)/hardware vm2vm comms\n" " --rx-retry [0|1]: disable/enable(default) retries on Rx. Enable retry if destination queue is full\n" @@ -610,11 +609,12 @@ us_vhost_usage(const char *prgname) " --mergeable [0|1]: disable(default)/enable RX mergeable buffers\n" " --stats [0-N]: 0: Disable stats, N: Time in seconds to print stats\n" " --socket-file: The path of the socket file.\n" - " --tx-csum [0|1] disable/enable TX checksum offload.\n" - " --tso [0|1] disable/enable TCP segment offload.\n" - " --client register a vhost-user socket as client mode.\n" - " --dmas register dma channel for specific vhost device.\n" - " --total-num-mbufs [0-N] set the number of mbufs to be allocated in mbuf pools, the default value is 147456.\n", + " --tx-csum [0|1]: disable/enable TX checksum offload.\n" + " --tso [0|1]: disable/enable TCP segment offload.\n" + " --client: register a vhost-user socket as client mode.\n" + " --dmas: register dma channel for specific vhost device.\n" + " --total-num-mbufs [0-N]: set the number of mbufs to be allocated in mbuf pools, the default value is 147456.\n" + " --builtin-net-driver: enable simple vhost-user net driver\n", prgname); }