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 12215A054A for ; Fri, 27 May 2022 19:26:32 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 0CB8C427F0; Fri, 27 May 2022 19:26:32 +0200 (CEST) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by mails.dpdk.org (Postfix) with ESMTP id 46DC940E78; Fri, 27 May 2022 19:26:29 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1653672389; x=1685208389; h=from:to:cc:subject:date:message-id; bh=SAP/9vHIdyuoEAQEPCB9laaLBj1srwlaW2D8H5blsCc=; b=Bt6Dmuu710eZ3OPekO26/VajoSdGSv7AbxhQ/UGd+h0O4nSba64hMEdK KSTuVK+H3Ba3Z+ILjYKXQldLRaj28YRd/UTk4LVVXDSNYu+n7Z68Y13BT Sq3mMnRtZTXFMQ/3UVB9jMSdYcfBK+QJpH4DJZua/6nhYuaIJ8kGQUIeJ 9jP1l80/gGFbZfxVo+Gdk43p72o7g5TeAuYjZYOZzghfGN4BSEOwZu+8w CeHzVNb+amp6+h5XNuS0Cjo4akIcVMOkntzbep35MN9O0YEiDjO5CdhzY ZuxVIkj+SFKvzb0aakwAtZStBWCDyf98lTbhnUeSypcehZ+tz3lxHJxGh Q==; X-IronPort-AV: E=McAfee;i="6400,9594,10360"; a="273348872" X-IronPort-AV: E=Sophos;i="5.91,256,1647327600"; d="scan'208";a="273348872" Received: from orsmga006.jf.intel.com ([10.7.209.51]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 27 May 2022 10:26:28 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.91,256,1647327600"; d="scan'208";a="550330776" Received: from silpixa00399499.ir.intel.com (HELO silpixa00399499.ger.corp.intel.com) ([10.237.223.138]) by orsmga006.jf.intel.com with ESMTP; 27 May 2022 10:26:26 -0700 From: Herakliusz Lipiec To: maxime.coquelin@redhat.com, chenbo.xia@intel.com Cc: john.mcnamara@intel.com, dev@dpdk.org, Herakliusz Lipiec , stable@dpdk.org Subject: [PATCH] doc: fix readability in lib vhost prog guide Date: Fri, 27 May 2022 18:31:20 +0100 Message-Id: <20220527173120.30050-1-herakliusz.lipiec@intel.com> X-Mailer: git-send-email 2.17.2 X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org fix grammar issues and readbility in vhost library programmer guide Fixes: 768274ebbd5e ("vhost: avoid populate guest memory") Signed-off-by: Herakliusz Lipiec Cc: stable@dpdk.org --- doc/guides/prog_guide/vhost_lib.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/guides/prog_guide/vhost_lib.rst b/doc/guides/prog_guide/vhost_lib.rst index f287b76ebf..70a0683d5b 100644 --- a/doc/guides/prog_guide/vhost_lib.rst +++ b/doc/guides/prog_guide/vhost_lib.rst @@ -310,7 +310,7 @@ vhost-user implementation has two options: * The vhost supported features must be exactly the same before and after the restart. For example, if TSO is disabled and then enabled, - nothing will work and issues undefined might happen. + nothing will work and undefined issues might happen. No matter which mode is used, once a connection is established, DPDK vhost-user will start receiving and processing vhost messages from QEMU. @@ -341,21 +341,21 @@ Guest memory requirement * Memory pre-allocation - For non-async data path, guest memory pre-allocation is not a - must. This can help save of memory. If users really want the guest memory - to be pre-allocated (e.g., for performance reason), we can add option - ``-mem-prealloc`` when starting QEMU. Or, we can lock all memory at vhost - side which will force memory to be allocated when mmap at vhost side; - option --mlockall in ovs-dpdk is an example in hand. + For non-async data path guest memory pre-allocation is not a + must but can help save memory. To do this we can we can add option + ``-mem-prealloc`` when starting QEMU, or we can lock all memory at vhost + side which will force memory to be allocated when it calls mmap + (option --mlockall in ovs-dpdk is an example in hand). + For async data path, we force the VM memory to be pre-allocated at vhost lib when mapping the guest memory; and also we need to lock the memory to prevent pages being swapped out to disk. * Memory sharing - Make sure ``share=on`` QEMU option is given. vhost-user will not work with - a QEMU version without shared memory mapping. + Make sure ``share=on`` QEMU option is given. The vhost-user will not work with + a QEMU instance without shared memory mapping. Vhost supported vSwitch reference --------------------------------- -- 2.17.2