diff mbox series

[v3,11/12] util/mmap-alloc: Support RAM_NORESERVE via MAP_NORESERVE

Message ID 20210308150600.14440-12-david@redhat.com (mailing list archive)
State New, archived
Headers show
Series RAM_NORESERVE, MAP_NORESERVE and hostmem "reserve" property | expand

Commit Message

David Hildenbrand March 8, 2021, 3:05 p.m. UTC
Let's support RAM_NORESERVE via MAP_NORESERVE. At least on Linux,
the flag has no effect on most shared mappings - except for hugetlbfs
and anonymous memory.

Linux man page:
  "MAP_NORESERVE: Do not reserve swap space for this mapping. When swap
  space is reserved, one has the guarantee that it is possible to modify
  the mapping. When swap space is not reserved one might get SIGSEGV
  upon a write if no physical memory is available. See also the discussion
  of the file /proc/sys/vm/overcommit_memory in proc(5). In kernels before
  2.6, this flag had effect only for private writable mappings."

Note that the "guarantee" part is wrong with memory overcommit in Linux.

Also, in Linux hugetlbfs is treated differently - we configure reservation
of huge pages from the pool, not reservation of swap space (huge pages
cannot be swapped).

The rough behavior is [1]:
a) !Hugetlbfs:

  1) Without MAP_NORESERVE *or* with memory overcommit under Linux
     disabled ("/proc/sys/vm/overcommit_memory == 2"), the following
     accounting/reservation happens:
      For a file backed map
       SHARED or READ-only - 0 cost (the file is the map not swap)
       PRIVATE WRITABLE - size of mapping per instance

      For an anonymous or /dev/zero map
       SHARED   - size of mapping
       PRIVATE READ-only - 0 cost (but of little use)
       PRIVATE WRITABLE - size of mapping per instance

  2) With MAP_NORESERVE, no accounting/reservation happens.

b) Hugetlbfs:

  1) Without MAP_NORESERVE, huge pages are reserved.

  2) With MAP_NORESERVE, no huge pages are reserved.

Note: With "/proc/sys/vm/overcommit_memory == 0", we were already able
to configure it for !hugetlbfs globally; this toggle now allows
configuring it more fine-grained, not for the whole system.

The target use case is virtio-mem, which dynamically exposes memory
inside a large, sparse memory area to the VM.

[1] https://www.kernel.org/doc/Documentation/vm/overcommit-accounting

Signed-off-by: David Hildenbrand <david@redhat.com>
---
 softmmu/physmem.c |  1 +
 util/mmap-alloc.c | 66 ++++++++++++++++++++++++++++++++++++++++++++++-
 2 files changed, 66 insertions(+), 1 deletion(-)

Comments

David Hildenbrand March 10, 2021, 10:28 a.m. UTC | #1
On 08.03.21 16:05, David Hildenbrand wrote:
> Let's support RAM_NORESERVE via MAP_NORESERVE. At least on Linux,
> the flag has no effect on most shared mappings - except for hugetlbfs
> and anonymous memory.
> 
> Linux man page:
>    "MAP_NORESERVE: Do not reserve swap space for this mapping. When swap
>    space is reserved, one has the guarantee that it is possible to modify
>    the mapping. When swap space is not reserved one might get SIGSEGV
>    upon a write if no physical memory is available. See also the discussion
>    of the file /proc/sys/vm/overcommit_memory in proc(5). In kernels before
>    2.6, this flag had effect only for private writable mappings."
> 
> Note that the "guarantee" part is wrong with memory overcommit in Linux.
> 
> Also, in Linux hugetlbfs is treated differently - we configure reservation
> of huge pages from the pool, not reservation of swap space (huge pages
> cannot be swapped).
> 
> The rough behavior is [1]:
> a) !Hugetlbfs:
> 
>    1) Without MAP_NORESERVE *or* with memory overcommit under Linux
>       disabled ("/proc/sys/vm/overcommit_memory == 2"), the following
>       accounting/reservation happens:
>        For a file backed map
>         SHARED or READ-only - 0 cost (the file is the map not swap)
>         PRIVATE WRITABLE - size of mapping per instance
> 
>        For an anonymous or /dev/zero map
>         SHARED   - size of mapping
>         PRIVATE READ-only - 0 cost (but of little use)
>         PRIVATE WRITABLE - size of mapping per instance
> 
>    2) With MAP_NORESERVE, no accounting/reservation happens.
> 
> b) Hugetlbfs:
> 
>    1) Without MAP_NORESERVE, huge pages are reserved.
> 
>    2) With MAP_NORESERVE, no huge pages are reserved.
> 
> Note: With "/proc/sys/vm/overcommit_memory == 0", we were already able
> to configure it for !hugetlbfs globally; this toggle now allows
> configuring it more fine-grained, not for the whole system.
> 
> The target use case is virtio-mem, which dynamically exposes memory
> inside a large, sparse memory area to the VM.
> 
> [1] https://www.kernel.org/doc/Documentation/vm/overcommit-accounting
> 
> Signed-off-by: David Hildenbrand <david@redhat.com>
> ---
>   softmmu/physmem.c |  1 +
>   util/mmap-alloc.c | 66 ++++++++++++++++++++++++++++++++++++++++++++++-
>   2 files changed, 66 insertions(+), 1 deletion(-)
> 
> diff --git a/softmmu/physmem.c b/softmmu/physmem.c
> index dcc1fb74aa..199c5a4985 100644
> --- a/softmmu/physmem.c
> +++ b/softmmu/physmem.c
> @@ -2229,6 +2229,7 @@ void qemu_ram_remap(ram_addr_t addr, ram_addr_t length)
>                   flags = MAP_FIXED;
>                   flags |= block->flags & RAM_SHARED ?
>                            MAP_SHARED : MAP_PRIVATE;
> +                flags |= block->flags & RAM_NORESERVE ? MAP_NORESERVE : 0;
>                   if (block->fd >= 0) {
>                       area = mmap(vaddr, length, PROT_READ | PROT_WRITE,
>                                   flags, block->fd, offset);
> diff --git a/util/mmap-alloc.c b/util/mmap-alloc.c
> index ecace41ad5..c511a68bbe 100644
> --- a/util/mmap-alloc.c
> +++ b/util/mmap-alloc.c
> @@ -20,6 +20,7 @@
>   #include "qemu/osdep.h"
>   #include "qemu/mmap-alloc.h"
>   #include "qemu/host-utils.h"
> +#include "qemu/cutils.h"
>   #include "qemu/error-report.h"
>   
>   #define HUGETLBFS_MAGIC       0x958458f6
> @@ -125,6 +126,7 @@ static void *mmap_activate(void *ptr, size_t size, int fd, uint32_t mmap_flags,
>       const bool readonly = mmap_flags & QEMU_RAM_MMAP_READONLY;
>       const bool shared = mmap_flags & QEMU_RAM_MMAP_SHARED;
>       const bool is_pmem = mmap_flags & QEMU_RAM_MMAP_PMEM;
> +    const bool noreserve = mmap_flags & QEMU_RAM_MMAP_NORESERVE;
>       const int prot = PROT_READ | (readonly ? 0 : PROT_WRITE);
>       int map_sync_flags = 0;
>       int flags = MAP_FIXED;
> @@ -132,6 +134,7 @@ static void *mmap_activate(void *ptr, size_t size, int fd, uint32_t mmap_flags,
>   
>       flags |= fd == -1 ? MAP_ANONYMOUS : 0;
>       flags |= shared ? MAP_SHARED : MAP_PRIVATE;
> +    flags |= noreserve ? MAP_NORESERVE : 0;
>       if (shared && is_pmem) {
>           map_sync_flags = MAP_SYNC | MAP_SHARED_VALIDATE;
>       }
> @@ -174,6 +177,66 @@ static inline size_t mmap_guard_pagesize(int fd)
>   #endif
>   }
>   
> +#define OVERCOMMIT_MEMORY_PATH "/proc/sys/vm/overcommit_memory"
> +static bool map_noreserve_effective(int fd, uint32_t mmap_flags)
> +{
> +#if defined(__linux__)
> +    const bool readonly = mmap_flags & QEMU_RAM_MMAP_READONLY;
> +    const bool shared = mmap_flags & QEMU_RAM_MMAP_SHARED;
> +    gchar *content = NULL;
> +    const char *endptr;
> +    unsigned int tmp;
> +
> +    /*
> +     * hugeltb accounting is different than ordinary swap reservation:
> +     * a) Hugetlb pages from the pool are reserved for both private and
> +     *    shared mappings. For shared mappings, reservations are tracked
> +     *    per file -- all mappers have to specify MAP_NORESERVE.
> +     * b) MAP_NORESERVE is not affected by /proc/sys/vm/overcommit_memory.
> +     */
> +    if (qemu_fd_getpagesize(fd) != qemu_real_host_page_size) {
> +        return true;
> +    }
> +
> +    /*
> +     * Accountable mappings in the kernel that can be affected by MAP_NORESEVE
> +     * are private writable mappings (see mm/mmap.c:accountable_mapping() in
> +     * Linux). For all shared or readonly mappings, MAP_NORESERVE is always
> +     * implicitly active -- no reservation; this includes shmem. The only
> +     * exception is shared anonymous memory, it is accounted like private
> +     * anonymous memory.
> +     */
> +    if (readonly || (shared && fd >= 0)) {
> +        return true;
> +    }
> +
> +    /*
> +     * MAP_NORESERVE is globally ignored for private writable mappings when
> +     * overcommit is set to "never". Sparse memory regions aren't really
> +     * possible in this system configuration.
> +     *
> +     * Bail out now instead of silently committing way more memory than
> +     * currently desired by the user.
> +     */
> +    if (g_file_get_contents(OVERCOMMIT_MEMORY_PATH, &content, NULL, NULL) &&
> +        !qemu_strtoui(content, &endptr, 0, &tmp) &&
> +        (!endptr || *endptr == '\n')) {
> +        if (tmp == 2) {
> +            error_report("Skipping reservation of swap space is not supported:"
> +                         " \"" OVERCOMMIT_MEMORY_PATH "\" is \"2\"");
> +            return false;
> +        }
> +        return true;
> +    }
> +    /* this interface has been around since Linux 2.6 */
> +    error_report("Skipping reservation of swap space is not supported:"
> +                 " Could not read: \"" OVERCOMMIT_MEMORY_PATH "\"");
> +    return false;
> +#else

I'll return "false" here for now after learning that e.g., FreeBSD never 
implemented the flag and removed it a while ago
	https://github.com/Clozure/ccl/issues/17

So I'll unlock it only for Linux - which makes sense, because I only 
test there (and only care about Linux with MAP_NORESERVE)

> +    return true;
diff mbox series

Patch

diff --git a/softmmu/physmem.c b/softmmu/physmem.c
index dcc1fb74aa..199c5a4985 100644
--- a/softmmu/physmem.c
+++ b/softmmu/physmem.c
@@ -2229,6 +2229,7 @@  void qemu_ram_remap(ram_addr_t addr, ram_addr_t length)
                 flags = MAP_FIXED;
                 flags |= block->flags & RAM_SHARED ?
                          MAP_SHARED : MAP_PRIVATE;
+                flags |= block->flags & RAM_NORESERVE ? MAP_NORESERVE : 0;
                 if (block->fd >= 0) {
                     area = mmap(vaddr, length, PROT_READ | PROT_WRITE,
                                 flags, block->fd, offset);
diff --git a/util/mmap-alloc.c b/util/mmap-alloc.c
index ecace41ad5..c511a68bbe 100644
--- a/util/mmap-alloc.c
+++ b/util/mmap-alloc.c
@@ -20,6 +20,7 @@ 
 #include "qemu/osdep.h"
 #include "qemu/mmap-alloc.h"
 #include "qemu/host-utils.h"
+#include "qemu/cutils.h"
 #include "qemu/error-report.h"
 
 #define HUGETLBFS_MAGIC       0x958458f6
@@ -125,6 +126,7 @@  static void *mmap_activate(void *ptr, size_t size, int fd, uint32_t mmap_flags,
     const bool readonly = mmap_flags & QEMU_RAM_MMAP_READONLY;
     const bool shared = mmap_flags & QEMU_RAM_MMAP_SHARED;
     const bool is_pmem = mmap_flags & QEMU_RAM_MMAP_PMEM;
+    const bool noreserve = mmap_flags & QEMU_RAM_MMAP_NORESERVE;
     const int prot = PROT_READ | (readonly ? 0 : PROT_WRITE);
     int map_sync_flags = 0;
     int flags = MAP_FIXED;
@@ -132,6 +134,7 @@  static void *mmap_activate(void *ptr, size_t size, int fd, uint32_t mmap_flags,
 
     flags |= fd == -1 ? MAP_ANONYMOUS : 0;
     flags |= shared ? MAP_SHARED : MAP_PRIVATE;
+    flags |= noreserve ? MAP_NORESERVE : 0;
     if (shared && is_pmem) {
         map_sync_flags = MAP_SYNC | MAP_SHARED_VALIDATE;
     }
@@ -174,6 +177,66 @@  static inline size_t mmap_guard_pagesize(int fd)
 #endif
 }
 
+#define OVERCOMMIT_MEMORY_PATH "/proc/sys/vm/overcommit_memory"
+static bool map_noreserve_effective(int fd, uint32_t mmap_flags)
+{
+#if defined(__linux__)
+    const bool readonly = mmap_flags & QEMU_RAM_MMAP_READONLY;
+    const bool shared = mmap_flags & QEMU_RAM_MMAP_SHARED;
+    gchar *content = NULL;
+    const char *endptr;
+    unsigned int tmp;
+
+    /*
+     * hugeltb accounting is different than ordinary swap reservation:
+     * a) Hugetlb pages from the pool are reserved for both private and
+     *    shared mappings. For shared mappings, reservations are tracked
+     *    per file -- all mappers have to specify MAP_NORESERVE.
+     * b) MAP_NORESERVE is not affected by /proc/sys/vm/overcommit_memory.
+     */
+    if (qemu_fd_getpagesize(fd) != qemu_real_host_page_size) {
+        return true;
+    }
+
+    /*
+     * Accountable mappings in the kernel that can be affected by MAP_NORESEVE
+     * are private writable mappings (see mm/mmap.c:accountable_mapping() in
+     * Linux). For all shared or readonly mappings, MAP_NORESERVE is always
+     * implicitly active -- no reservation; this includes shmem. The only
+     * exception is shared anonymous memory, it is accounted like private
+     * anonymous memory.
+     */
+    if (readonly || (shared && fd >= 0)) {
+        return true;
+    }
+
+    /*
+     * MAP_NORESERVE is globally ignored for private writable mappings when
+     * overcommit is set to "never". Sparse memory regions aren't really
+     * possible in this system configuration.
+     *
+     * Bail out now instead of silently committing way more memory than
+     * currently desired by the user.
+     */
+    if (g_file_get_contents(OVERCOMMIT_MEMORY_PATH, &content, NULL, NULL) &&
+        !qemu_strtoui(content, &endptr, 0, &tmp) &&
+        (!endptr || *endptr == '\n')) {
+        if (tmp == 2) {
+            error_report("Skipping reservation of swap space is not supported:"
+                         " \"" OVERCOMMIT_MEMORY_PATH "\" is \"2\"");
+            return false;
+        }
+        return true;
+    }
+    /* this interface has been around since Linux 2.6 */
+    error_report("Skipping reservation of swap space is not supported:"
+                 " Could not read: \"" OVERCOMMIT_MEMORY_PATH "\"");
+    return false;
+#else
+    return true;
+#endif
+}
+
 void *qemu_ram_mmap(int fd,
                     size_t size,
                     size_t align,
@@ -184,7 +247,8 @@  void *qemu_ram_mmap(int fd,
     size_t offset, total;
     void *ptr, *guardptr;
 
-    if (mmap_flags & QEMU_RAM_MMAP_NORESERVE) {
+    if (mmap_flags & QEMU_RAM_MMAP_NORESERVE &&
+        !map_noreserve_effective(fd, mmap_flags)) {
         error_report("Skipping reservation of swap space is not supported");
         return MAP_FAILED;
     }