From: Herakliusz Lipiec <herakliusz.lipiec@intel.com>
To: maxime.coquelin@redhat.com, chenbo.xia@intel.com
Cc: john.mcnamara@intel.com, dev@dpdk.org,
Herakliusz Lipiec <herakliusz.lipiec@intel.com>,
stable@dpdk.org
Subject: [PATCH] doc: fix readability in lib vhost prog guide
Date: Fri, 27 May 2022 18:31:20 +0100 [thread overview]
Message-ID: <20220527173120.30050-1-herakliusz.lipiec@intel.com> (raw)
fix grammar issues and readbility in vhost library programmer guide
Fixes: 768274ebbd5e ("vhost: avoid populate guest memory")
Signed-off-by: Herakliusz Lipiec <herakliusz.lipiec@intel.com>
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
next reply other threads:[~2022-05-27 17:26 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-05-27 17:31 Herakliusz Lipiec [this message]
2022-06-15 1:56 ` Xia, Chenbo
2022-06-23 13:57 ` [PATCH v2] doc/prog_guide: " Herakliusz Lipiec
2022-06-24 7:51 ` Xia, Chenbo
2022-07-01 13:52 ` Maxime Coquelin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220527173120.30050-1-herakliusz.lipiec@intel.com \
--to=herakliusz.lipiec@intel.com \
--cc=chenbo.xia@intel.com \
--cc=dev@dpdk.org \
--cc=john.mcnamara@intel.com \
--cc=maxime.coquelin@redhat.com \
--cc=stable@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).