From aad4dc3b6bf375992386bd9c3348c0bb7b1c7c37 Mon Sep 17 00:00:00 2001 From: Rob Bradford Date: Mon, 31 Oct 2022 13:45:55 +0000 Subject: [PATCH] docs: Update memory.md to indicated that hugepages overrides shared Signed-off-by: Rob Bradford --- docs/memory.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/memory.md b/docs/memory.md index 2fdc84bdf..431abbb70 100644 --- a/docs/memory.md +++ b/docs/memory.md @@ -117,6 +117,9 @@ needing access to the guest RAM content. By default this option is turned off, which results in performing `mmap(2)` with `MAP_PRIVATE` flag. +If `hugepages=on` then the value of this field is ignored as huge pages always +requires `MAP_SHARED`. + _Example_ ``` @@ -140,6 +143,9 @@ behaviour, e.g. error with `ReadKernelImage` is common. If there is a strange error with `hugepages` enabled, just disable it or check whether there are enough huge pages. +If `hugepages=on` then the value of `shared` is ignored as huge pages always +requires `MAP_SHARED`. + By default this option is turned off. _Example_ @@ -271,6 +277,9 @@ other processes running on the host. One can use this option when running vhost-user devices as part of the VM device model, as they will be driven by standalone daemons needing access to the guest RAM content. +If `hugepages=on` then the value of this field is ignored as huge pages always +requires `MAP_SHARED`. + By default this option is turned off, which result in performing `mmap(2)` with `MAP_PRIVATE` flag. @@ -298,6 +307,9 @@ behaviour, e.g. error with `ReadKernelImage` is common. If there is a strange error with `hugepages` enabled, just disable it or check whether there are enough huge pages. +If `hugepages=on` then the value of `shared` is ignored as huge pages always +requires `MAP_SHARED`. + By default this option is turned off. _Example_