[Qemu-devel] [PATCH] doc: document ivshmem & hugepages

[Qemu-devel] [PATCH] doc: document ivshmem & hugepages

[marcandre.lureau]

From: Marc-André Lureau <marcandre.lureau@redhat.com>

Document and give some examples of hugepages support with ivshmem device
and server.

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
---
 qemu-doc.texi | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/qemu-doc.texi b/qemu-doc.texi
index afa2263..b15c14c 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -1293,6 +1293,19 @@ copy the shared memory on migration to the destination host.  With
 With the @option{peer} case, the device should be detached and then reattached
 after migration using the PCI hotplug support.
 
+@subsubsection ivshmem & hugepages
+
+Instead of specifying the <shm size> using POSIX shm, you may specify
+a memory backend, that has hugepage support:
+
+@example
+qemu-system-i386 -object memory-backend-file,size=1G,mem-path=/mnt/hugepages,id=mb1
+                 -device ivshmem,memdev=mb1
+@end example
+
+ivshmem-server also supports hugepages mount points with the
+@option{-m} memory path argument.
+
 @node direct_linux_boot
 @section Direct Linux Boot
 
-- 
2.4.3

Re: [Qemu-devel] [PATCH] doc: document ivshmem & hugepages

[Eric Blake]

[-- Attachment #1: Type: text/plain, Size: 1258 bytes --]

On 10/07/2015 08:32 AM, marcandre.lureau@redhat.com wrote:
> From: Marc-André Lureau <marcandre.lureau@redhat.com>
> 
> Document and give some examples of hugepages support with ivshmem device
> and server.
> 
> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> ---
>  qemu-doc.texi | 13 +++++++++++++
>  1 file changed, 13 insertions(+)
> 
> diff --git a/qemu-doc.texi b/qemu-doc.texi
> index afa2263..b15c14c 100644
> --- a/qemu-doc.texi
> +++ b/qemu-doc.texi
> @@ -1293,6 +1293,19 @@ copy the shared memory on migration to the destination host.  With
>  With the @option{peer} case, the device should be detached and then reattached
>  after migration using the PCI hotplug support.
>  
> +@subsubsection ivshmem & hugepages

s/&/and/ (documentation looks a bit too casual if you don't spell out
conjunctions)

> +
> +Instead of specifying the <shm size> using POSIX shm, you may specify
> +a memory backend, that has hugepage support:

s/backend,/backend/

With those two fixes, the grammar is:
Reviewed-by: Eric Blake <eblake@redhat.com>

I don't know if it is technically accurate, though.

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 604 bytes --]