From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id E9C4EA00C4; Fri, 1 Jul 2022 15:11:13 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id ADCAF4069D; Fri, 1 Jul 2022 15:11:13 +0200 (CEST) Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by mails.dpdk.org (Postfix) with ESMTP id D604740156 for ; Fri, 1 Jul 2022 15:11:11 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1656681072; x=1688217072; h=from:to:cc:subject:date:message-id:references: in-reply-to:content-transfer-encoding:mime-version; bh=8g0A/IT8HaCGFF4Bv84gX4lJK8+smnmnJlPFp6bJ0AQ=; b=QTpap24uYq6B5pIjU6w1RNswunqTjFCIT9UHUaYvDI96SZ5Ms9n6L1kK 4PjnirUHF2YoEsiXzqh82dAsQs032y11NxfzvOalByV2h7tZ8j0fNN6op jZNChz73PGIOc1wJ1nTfskC4v8JdPuHR7vvz7X/uBRmafBoPYfMviogRA jyh7hFgUGlzSdmrm12y75cTGg2t3jJFDm9fCIIXZpp7YCWCbCTR/M4YTq NSZzdzbjrRmIkczI6og7aJ6zBWAd2ciHiBUw/SPiiN9lEd2pVCxd3cgoQ +LF3IrzSejKTOgMHa9GyYQ+PcAruD8KlSmt2XgTkI9FLzs1k4Y6ufMmF/ Q==; X-IronPort-AV: E=McAfee;i="6400,9594,10394"; a="280200882" X-IronPort-AV: E=Sophos;i="5.92,237,1650956400"; d="scan'208";a="280200882" Received: from fmsmga007.fm.intel.com ([10.253.24.52]) by fmsmga102.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 01 Jul 2022 06:11:10 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.92,237,1650956400"; d="scan'208";a="596254167" Received: from orsmsx603.amr.corp.intel.com ([10.22.229.16]) by fmsmga007.fm.intel.com with ESMTP; 01 Jul 2022 06:10:57 -0700 Received: from orsmsx607.amr.corp.intel.com (10.22.229.20) by ORSMSX603.amr.corp.intel.com (10.22.229.16) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2308.27; Fri, 1 Jul 2022 06:10:57 -0700 Received: from ORSEDG602.ED.cps.intel.com (10.7.248.7) by orsmsx607.amr.corp.intel.com (10.22.229.20) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2308.27 via Frontend Transport; Fri, 1 Jul 2022 06:10:57 -0700 Received: from NAM11-DM6-obe.outbound.protection.outlook.com (104.47.57.173) by edgegateway.intel.com (134.134.137.103) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.2308.27; Fri, 1 Jul 2022 06:10:56 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=lhCnlE/wws2j29+HvS1ubODiHO1VE4TOI/QNGZD8Kwnb3Ye+uv0gy0D58auZIVm4oe5nT2a6niVNPggRlquRCmcIcCcedTxUSw7TZC6kbLewQTF6DlX4EypZQUq9BU+Yxf9jkBsQ0JBDzaNObKiYTtOnBzeUbF5knOYRq/ShibU4TU015cyCLrZk4w8vcBQ6FgtTEw//UxxZ2ofGsn2WZKXF1shFm9DcdRPoQBfeBRcYhwxM2N/6hN4v7PJO9kMyZPOCzX+dS7odxaDsCLwUYaGzfEnCZUWHZb7jF5rkF/MN4DLr+dXr3QOrLkwmv8AqEG5UZlGcUEz09LNGPH84dA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=/o1sc92eiiUkOkpPr5VYTepvLmHfeGnli1YWHREmIHo=; b=ivwelExinXKsc7fX/khjuxemMahCZXb0TxCHH2Htu3VfOhzq+AdOT5Mb79AnEw+am83KYCQcx3p3dBW+grwuHwh2gzE/xnpOc8C1n+byfAVkJgSLS4mvD5nJt1f1jqmSlJ9aD2M9Pcp4UApdm1+DyI+7xTQ4cWxHex+KR4glPq3nLfFbbcU3LvZfwWPCfJ3zqzImrgAACfezOiLkYTT42RtLas9HmwCD9OYTAldPG9Qi9Dh5VSFd66bRMS0k6UHCgOhIfcMCS6d8aNFPcF8lCrSR2QxLn/WZ/DS0ao8ZFWcJIToJpuFR6kDEnEs+umw3U7w742Z1vaC4Z8HymFnuuA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=intel.com; dmarc=pass action=none header.from=intel.com; dkim=pass header.d=intel.com; arc=none Received: from SN6PR11MB3504.namprd11.prod.outlook.com (2603:10b6:805:d0::17) by BYAPR11MB2792.namprd11.prod.outlook.com (2603:10b6:a02:c3::14) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5373.17; Fri, 1 Jul 2022 13:10:54 +0000 Received: from SN6PR11MB3504.namprd11.prod.outlook.com ([fe80::54a0:2dbc:18b7:2aa9]) by SN6PR11MB3504.namprd11.prod.outlook.com ([fe80::54a0:2dbc:18b7:2aa9%7]) with mapi id 15.20.5373.018; Fri, 1 Jul 2022 13:10:54 +0000 From: "Xia, Chenbo" To: "Lipiec, Herakliusz" , "maxime.coquelin@redhat.com" , "Richardson, Bruce" CC: "dev@dpdk.org" Subject: RE: [PATCH v3 2/3] doc: update vhost sample app docs Thread-Topic: [PATCH v3 2/3] doc: update vhost sample app docs Thread-Index: AQHYhYHd8nWPyHsEx0mw33WW7O7Deq1pjN5w Date: Fri, 1 Jul 2022 13:10:54 +0000 Message-ID: References: <20220621121315.1173180-1-herakliusz.lipiec@intel.com> <20220621152033.1214568-1-herakliusz.lipiec@intel.com> <20220621152033.1214568-2-herakliusz.lipiec@intel.com> In-Reply-To: <20220621152033.1214568-2-herakliusz.lipiec@intel.com> Accept-Language: en-US, zh-CN Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: authentication-results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=intel.com; x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: aa3f9cc9-b0d3-4865-a9d7-08da5b63213a x-ms-traffictypediagnostic: BYAPR11MB2792:EE_ x-ld-processed: 46c98d88-e344-4ed4-8496-4ed7712e255d,ExtAddr x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: reJmggImKbmKl9AdL6LStSKWFmWyZ7NgixF3vJlxvLrI6n6cpz+6QZ6tqyeonTRlzlyzS8lKfy3Yu/L8zkncX3BCB37LPoYuZpwOHe2VhfbQODz+GZuGeXGJRK/f5gPp3Ykgj3rtNRfoxsm50JpqCIaF5H5YpwHZ7JA56N1MvyPK2htx3AM9Iu+KoKm9fb2GTz63JvqkCsAlYKig7wFOeuhZEzZNfKX5aKs95ZGtFKsEoQxf3dNES6Z4nXaiQj5TEA095S4ugafm4+Q3HtMis3CIG3Es7TAe8nzSf+xpOVFcvPd+qVfcZkMoYCdVak2/Ksot790yhKH06jjIsN8D/hHtsA9PLjoeOzFYOw/STBhMc/LgGkABm/FiUcpZO+Fg3HqE0fDLG05OJF0iiuRbx1JrJi1S6lw4EUHIasFgIk+59V+Z1X1cFpWqLkEoIkgXmV0588SGRweqj3NO0BscnoDEOgFPAyxvUZtjDI43koYL1di6qYpGdVTzWtd5C6PWUFFWsfBBEawIAjhGnRjXBiECDc+j+vrdWYG0bZRjAVgW8XjkcmFEenfyQXGCbwwND3+p/0aJmypAq+4X9x1HAFXJ2iYPDJJyGdJkZaSeeNhiWgvtniBj5ICMv0P3v+hCKXjB+Ec91F4eb/XegTjAzZ7cfNX4LLgGo0yLiQJWWqwsuHX7Ydx3plodh9VfmF5W69ohTncJYV+aGCqSi0ktbC3cB+XcMyvwGu0P2H2VSFFGDMAw5OMlcRnFskLB3CJ/HIyDufAGk2GftppN4xF8jZvTFbd7AL0X/IhR9DfXUW/wBSPsuqpYJIxsBE02/lmQ x-forefront-antispam-report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:SN6PR11MB3504.namprd11.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230016)(346002)(396003)(39860400002)(136003)(376002)(366004)(478600001)(52536014)(64756008)(41300700001)(38070700005)(71200400001)(38100700002)(110136005)(66946007)(15650500001)(66476007)(66556008)(122000001)(8676002)(76116006)(8936002)(6506007)(4326008)(86362001)(82960400001)(83380400001)(66446008)(7696005)(55016003)(186003)(9686003)(5660300002)(6636002)(2906002)(316002)(33656002)(26005)(53546011); DIR:OUT; SFP:1102; x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?jzypkdJrjwWs/fznZSC/XSXhaSZ2ZUbCnQysmuLkwdH+xJNBGtwxVSdmq4C0?= =?us-ascii?Q?UPtuDC8CVsd22Qv1RpoK0kpW1unz1Ct5ErXkPSAUFDkJiDBjYWOVmTG9gjLY?= =?us-ascii?Q?HwC0kGc38OAY50GDh3zt153DDbYuscwBtUNz3niSPBs5KdcM7sgumat3xPGc?= =?us-ascii?Q?4Rred+TuP8nfuHU7yvJCRPsE0Pa2QzclUklFZYfOxocmRB8AyZksp/5oHV9u?= =?us-ascii?Q?0fqLUOAGdfkxkDcQfFJE9z0tZkONjcVUygRGRIRtgPvt1ocC/cYvYQGbLfKa?= =?us-ascii?Q?tej8WgUehQPpfEwpEjCip5kYOj6O98wtXF76O8E2YjUPRjWISpUoa3U9Aq0Z?= =?us-ascii?Q?TfPxf10yxRHfIwnvnE7YdBF6WH+c2lT5Ok94uQ2HMPVoZ9K/wJc6pXXaYRfc?= =?us-ascii?Q?0k5uSKvPWj207y24z5d7Z/J94eqn/q66JMMYWBAsf3nzSASymDm+fQ/x3Q8q?= =?us-ascii?Q?/BkuU9TnJSDWuM9cBJXSDI8T+YjF4RobUP8/003A68/VCLJ7SH/7gaashqVR?= =?us-ascii?Q?fFhT7DezC3O66ACTAxSHBa+chsm3iOo7aK8uahsBh1e9lSHHJFr4up6QOLTR?= =?us-ascii?Q?KpQGjWNYeZypBvzh+ot6Et7AZXb9h7R9kEtv798CwEcTN6VE/X0rTuPTWDIG?= =?us-ascii?Q?dma04LorD3HqzQyELduz7Pjt2Jd6sjXD3mo/FGkHQ3wKcNPqTSFN+DeDmfD0?= =?us-ascii?Q?uY5rZe4OxPzqLba/MSG2KiyQD5R+Xg4AHHbBdGn5a2os/ACwRmDVPaT1wmIt?= =?us-ascii?Q?kB1OQsGsMNIJHIKirTK4zyy8sg9OfxxCJkKZ7Uzw3kTi/x9StTR7abFMHEEt?= =?us-ascii?Q?F1brR9UGs3El6W0mmOUHFj52PbAzPtxHHfh+9Vq/APKsWlrO/Jo9iAW/S9L7?= =?us-ascii?Q?xE8alseDBG144v4nEDcZpOliGSY8iJ1ddfv6KFo2O2Xn0VJbTMxgxCl42NzS?= =?us-ascii?Q?1VrjU6U/ijky70Lz8ggrDk6d4CJhganDZndujhtSxDXrPyQDX2mlSRWQApC5?= =?us-ascii?Q?qnsZrLXYZCyDavtsjDg6DyASkbLo8DfD8GlD19w0bUMlTzvFC+0kltHWjvyv?= =?us-ascii?Q?1HL/jMMWGUNoaGxhfwdbnpuC6h8Ve8ZUyNzoLBzYHWEPLKqwoVSKqRlKCOz3?= =?us-ascii?Q?FT9REqKYCI7MHX8soi9KOxlmOucqDTlv56hbbqPmmIwDSIHwURYuNy0EccdQ?= =?us-ascii?Q?VRxdd8yDk6+/oWbTuynz3YF6wtb+1tXQEG+vGKutiaHT2FOrzD/mFzWi1nTJ?= =?us-ascii?Q?/fTLBmntuT3bsQPnjn/cpUw4GrPI2wTH0aFm3J6NNXApb3zLDoanZ/7dxAZg?= =?us-ascii?Q?chtLrbqQxDZ3euaysDjbA90H3aTjqjSu53y44OFaXVpD4T8YUp1kyr08mZK8?= =?us-ascii?Q?ZI0sKbZN1zO/YSaKOZa08wow6YNcYfp/N4UMxbgA+w670US2qGymMiYNHVJJ?= =?us-ascii?Q?N297e/t8CjBWOUXi8AMkZsik44t19n3pev8R3sALGwxQmOp/yi7O8OnCeyPV?= =?us-ascii?Q?gx+MaOeNX+tbEpc0K0DINv1I7QM4vHZRyaWrA+CftV4B72P97z0wUY21fm8e?= =?us-ascii?Q?SfyXCvNGn8KyaCQ7b69IY12l3/R/o0ihewumfgLg?= Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: SN6PR11MB3504.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: aa3f9cc9-b0d3-4865-a9d7-08da5b63213a X-MS-Exchange-CrossTenant-originalarrivaltime: 01 Jul 2022 13:10:54.3104 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 46c98d88-e344-4ed4-8496-4ed7712e255d X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: ug/yyaR78vxhy9luIuRmLxXNwqKpwT3fNZfLtuAjxskKojHlkHHAJARSPvoj6lFMdL4+dzl/IErecH4GbUxUAw== X-MS-Exchange-Transport-CrossTenantHeadersStamped: BYAPR11MB2792 X-OriginatorOrg: intel.com 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 > -----Original Message----- > From: Lipiec, Herakliusz > Sent: Tuesday, June 21, 2022 11:21 PM > To: maxime.coquelin@redhat.com; Xia, Chenbo ; > Richardson, Bruce > Cc: dev@dpdk.org; Lipiec, Herakliusz > Subject: [PATCH v3 2/3] doc: update vhost sample app docs >=20 > 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. >=20 > Signed-off-by: Herakliusz Lipiec > --- > 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(-) >=20 > 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 gues= t. >=20 > -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: >=20 > 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. >=20 > + > +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: >=20 > Run testpmd inside guest > @@ -77,8 +78,8 @@ could be done by: >=20 > .. code-block:: console >=20 > - 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 >=20 > Then start testpmd for packet forwarding testing. >=20 > @@ -87,6 +88,9 @@ Then start testpmd for packet forwarding testing. > .//app/dpdk-testpmd -l 0-1 -- -i > > start tx_first >=20 > +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 > -------------- >=20 > @@ -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. >=20 > -**--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 cop= y > -cannot work at VM2NIC mode (vm2vm=3D0) 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. >=20 > -**--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 th= e > socket file in order, > that means vhost device 0 is created through the first socket file, vhos= t > device 1 is created through the second socket file, and so on. >=20 > +**--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 > ------------- >=20 > @@ -204,7 +206,8 @@ Common Issues >=20 > 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. >=20 > * Option "builtin-net-driver" is incompatible with QEMU >=20 > -- > 2.36.1 Reviewed-by: Chenbo Xia