From patchwork Tue Jun 21 15:20:32 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Herakliusz Lipiec X-Patchwork-Id: 113187 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 61F4DA0545; Tue, 21 Jun 2022 17:16:15 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 3B70D42823; Tue, 21 Jun 2022 17:16:15 +0200 (CEST) Received: from mga12.intel.com (mga12.intel.com [192.55.52.136]) by mails.dpdk.org (Postfix) with ESMTP id 1F11540151 for ; Tue, 21 Jun 2022 17:16:09 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1655824570; x=1687360570; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=TWtZOjvgfdulp9FLeSu7vHyOF/ZMotbrbV/kw3Jq4fI=; b=C8vdBlXH6O7HdZ7NAP5ih+8tzErmWYmfre+uz9iOkybdZ83vYxyCpJqd ao9BO5pYTnhgkelDpnlYEFrsbt4BVo9s6I3rbLhnAqzcmhhBawTVeqZDL 6maxuxP3B98H30JLXd8zVRGN15u2ugzRV95zMg6ivTNc3elVPbv2EirTj SfXgny0LfmEmXc8A0bIFb6qwVcsjdKgF1DxUkDDKuGlRl9z9U+1eowh04 tHsMlYPeuDMgeTvAHgmlKzaGNB65UA7qgQqmI14dSONz/VgD7LWPF6ktw VjawuQ7JWto+esL6PhScerENS+ztoM7x7jvWwXrO3ozUPnjLZk3vIbpn0 g==; X-IronPort-AV: E=McAfee;i="6400,9594,10384"; a="259963746" X-IronPort-AV: E=Sophos;i="5.92,209,1650956400"; d="scan'208";a="259963746" Received: from orsmga007.jf.intel.com ([10.7.209.58]) by fmsmga106.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Jun 2022 08:16:07 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.92,209,1650956400"; d="scan'208";a="585314473" 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 08:16:06 -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 v3 2/3] doc: update vhost sample app docs Date: Tue, 21 Jun 2022 16:20:32 +0100 Message-Id: <20220621152033.1214568-2-herakliusz.lipiec@intel.com> X-Mailer: git-send-email 2.36.1 In-Reply-To: <20220621152033.1214568-1-herakliusz.lipiec@intel.com> References: <20220621121315.1173180-1-herakliusz.lipiec@intel.com> <20220621152033.1214568-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 Reviewed-by: Chenbo Xia --- V3: * fix apply issues 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 e034115ce9..982e19214d 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 @@ -176,6 +164,20 @@ operation. The index of the device corresponds to the socket file in order, that means vhost device 0 is created through the first socket file, vhost device 1 is created through the second socket file, and so on. +**--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 ------------- @@ -204,7 +206,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