backends/hostmem: Report more errors on failures
Subsystems (2)
PATCH v4 5/5 backends/hostmem: Report error when memory size is unaligned
In reply to Michal PrivoznikIf memory-backend-{file,ram} has a size that's not aligned to underlying page size it is not only wasteful, but also may lead to hard to debug behaviour. For instance, in case memory-backend-file and hugepages, madvise() and mbind() fail. Rightfully so, page is the smallest unit they can work with. And even though an error is reported, the root cause it not very clear:
qemu-system-x86_64: Couldn't set property 'dump' on 'memory-backend-file': Invalid argument
After this commit:
qemu-system-x86_64: backend 'memory-backend-file' memory size must be multiple of 2 MiB
--- backends/hostmem.c | 10 ++++++++++ 1 file changed, 10 insertions(+)
backends/hostmem.c +10 -0
@@ -20,6 +20,7 @@#include "qom/object_interfaces.h" #include "qemu/mmap-alloc.h" #include "qemu/madvise.h" +#include "qemu/cutils.h" #include "hw/qdev-core.h" #ifdef CONFIG_NUMA
@@ -337,6 +338,7 @@ host_memory_backend_memory_complete(UserCreatable *uc, Error **errp)HostMemoryBackendClass *bc =MEMORY_BACKEND_GET_CLASS (uc);void *ptr;uint64_t sz; +size_t pagesize;bool async = !phase_check (PHASE_LATE_BACKENDS_CREATED );if (!bc->alloc) {
@@ -348,6 +350,14 @@ host_memory_backend_memory_complete(UserCreatable *uc, Error **errp) ptr =memory_region_get_ram_ptr (&backend->mr); sz =memory_region_size (&backend->mr); + pagesize =qemu_ram_pagesize (backend->mr.ram_block); + +if (!QEMU_IS_ALIGNED (sz, pagesize)) { + g_autofree char *pagesize_str = size_to_str(pagesize); +error_setg (errp,"backend '%s' memory size must be multiple of %s" , +object_get_typename (OBJECT (uc)), pagesize_str); +return ; + }if (backend->merge &&qemu_madvise (ptr, sz,QEMU_MADV_MERGEABLE )) {
Signature · 1 line
2.44.1
v4 cover backends/hostmem: Report more errors on failures
v4 of:
https://mail.gnu.org/archive/html/qemu-devel/2024-05/msg06511.html
diff to v3:
- In 2/5 instead of fixing up posix_madvise() retval at runtime, just don't use posix_madvise() on Darwin at all (resulted in new patch 1/5). Since 2/5 is now the same as 1/4 from v2 I'm including David's Reviewed-by line.
- The last patch was tested by Mario, so I've included his Tested-by line. Thanks!
Michal Privoznik (5):
meson: Don't even detect posix_madvise() on Darwin
osdep: Make qemu_madvise() to set errno in all cases
osdep: Make qemu_madvise() return ENOSYS on unsupported OSes backends/hostmem: Report error on qemu_madvise() failures backends/hostmem: Report error when memory size is unaligned
backends/hostmem.c | 46 ++++++++++++++++++++++++++++++++++++++-------- meson.build | 14 ++++++++++---- util/osdep.c | 9 +++++++-- 3 files changed, 55 insertions(+), 14 deletions(-)
Signature · 1 line
2.44.1
PATCH v4 1/5 meson: Don't even detect posix_madvise() on Darwin
On Darwin, posix_madvise() has the same return semantics as plain madvise() [1]. That's not really what our usage expects. Fortunately, madvise() is available and preferred anyways so we may stop detecting posix_madvise() on Darwin.
1: https://opensource.apple.com/source/xnu/xnu-7195.81.3/bsd/man/man2/madvise.2.auto.html
--- meson.build | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-)
meson.build +10 -4
@@ -2552,10 +2552,16 @@ config_host_data.set('CONFIG_OPEN_BY_HANDLE', cc.links(gnu_source_prefix + ''' #else int main(void) { struct file_handle fh; return open_by_handle_at(0, &fh, 0); } #endif''')) -config_host_data.set('CONFIG_POSIX_MADVISE', cc.links(gnu_source_prefix + ''' - #include <sys/mman.h> - #include <stddef.h> - int main(void) { return posix_madvise(NULL, 0, POSIX_MADV_DONTNEED); }''')) + +# On Darwin posix_madvise() has the same return semantics as plain madvise(), +# i.e. errno is set and -1 is returned. That's not really how POSIX defines the +# function. On the flip side, it has madvise() which is preferred anyways. +if host_os != 'darwin' + config_host_data.set('CONFIG_POSIX_MADVISE', cc.links(gnu_source_prefix + ''' + #include <sys/mman.h> + #include <stddef.h> + int main(void) { return posix_madvise(NULL, 0, POSIX_MADV_DONTNEED); }''')) +endif config_host_data.set('CONFIG_PTHREAD_SETNAME_NP_W_TID', cc.links(gnu_source_prefix + ''' #include <pthread.h>
Signature · 1 line
2.44.1
PATCH v4 2/5 osdep: Make qemu_madvise() to set errno in all cases
In reply to Michal PrivoznikThe unspoken premise of qemu_madvise() is that errno is set on error. And it is mostly the case except for posix_madvise() which is documented to return either zero (on success) or a positive error number. This means, we must set errno ourselves. And while at it, make the function return a negative value on error, just like other error paths do.
--- util/osdep.c | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-)
util/osdep.c +6 -1
@@ -57,7 +57,12 @@ int qemu_madvise(void *addr, size_t len, int advice)#if defined(CONFIG_MADVISE )return madvise (addr, len, advice);#elif defined(CONFIG_POSIX_MADVISE ) -return posix_madvise (addr, len, advice); +int rc =posix_madvise (addr, len, advice); +if (rc) { + errno = rc; +return -1 ; + } +return 0 ;#else errno =EINVAL ;return -1 ;
Signature · 1 line
2.44.1
PATCH v4 3/5 osdep: Make qemu_madvise() return ENOSYS on unsupported OSes
In reply to Michal PrivoznikNot every OS is capable of madvise() or posix_madvise() even. In that case, errno should be set to ENOSYS as it reflects the cause better.
--- util/osdep.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
util/osdep.c +1 -1
@@ -64,7 +64,7 @@ int qemu_madvise(void *addr, size_t len, int advice) }return 0 ;#else - errno =EINVAL ; + errno =ENOSYS ;return -1 ;#endif }
Signature · 1 line
2.44.1
PATCH v4 4/5 backends/hostmem: Report error on qemu_madvise() failures
In reply to Michal PrivoznikIf user sets .merge or .dump attributes qemu_madvise() is called with corresponding advice. But it is never checked for failure which may mislead users into thinking the attribute is set correctly. Report an appropriate error.
--- backends/hostmem.c | 36 ++++++++++++++++++++++++++++-------- 1 file changed, 28 insertions(+), 8 deletions(-)
backends/hostmem.c +28 -8
@@ -178,8 +178,14 @@ static void host_memory_backend_set_merge(Object *obj, bool value, Error **errp)void *ptr =memory_region_get_ram_ptr (&backend->mr);uint64_t sz =memory_region_size (&backend->mr); -qemu_madvise (ptr, sz, - value ?QEMU_MADV_MERGEABLE :QEMU_MADV_UNMERGEABLE ); +if (qemu_madvise (ptr, sz, + value ?QEMU_MADV_MERGEABLE :QEMU_MADV_UNMERGEABLE )) { +error_setg_errno (errp, errno, +"Couldn't change property 'merge' on '%s'" , +object_get_typename (obj)); +return ; + } + backend->merge = value; } }
@@ -204,8 +210,14 @@ static void host_memory_backend_set_dump(Object *obj, bool value, Error **errp)void *ptr =memory_region_get_ram_ptr (&backend->mr);uint64_t sz =memory_region_size (&backend->mr); -qemu_madvise (ptr, sz, - value ?QEMU_MADV_DODUMP :QEMU_MADV_DONTDUMP ); +if (qemu_madvise (ptr, sz, + value ?QEMU_MADV_DODUMP :QEMU_MADV_DONTDUMP )) { +error_setg_errno (errp, errno, +"Couldn't change property 'dump' on '%s'" , +object_get_typename (obj)); +return ; + } + backend->dump = value; } }
@@ -337,11 +349,19 @@ host_memory_backend_memory_complete(UserCreatable *uc, Error **errp) ptr =memory_region_get_ram_ptr (&backend->mr); sz =memory_region_size (&backend->mr); -if (backend->merge) { -qemu_madvise (ptr, sz,QEMU_MADV_MERGEABLE ); +if (backend->merge && +qemu_madvise (ptr, sz,QEMU_MADV_MERGEABLE )) { +error_setg_errno (errp, errno, +"Couldn't set property 'merge' on '%s'" , +object_get_typename (OBJECT (uc))); +return ; } -if (!backend->dump) { -qemu_madvise (ptr, sz,QEMU_MADV_DONTDUMP ); +if (!backend->dump && +qemu_madvise (ptr, sz,QEMU_MADV_DONTDUMP )) { +error_setg_errno (errp, errno, +"Couldn't set property 'dump' on '%s'" , +object_get_typename (OBJECT (uc))); +return ; }#ifdef CONFIG_NUMA unsigned long lastbit =find_last_bit (backend->host_nodes,MAX_NODES );
Signature · 1 line
2.44.1
Re: [PATCH v4 5/5] backends/hostmem: Report error when memory size is unaligned
In reply to Michal PrivoznikThis patch has been successfully tested. Try to allocate some 2M hugepages in the host, then boot up a VM with the memory size unaligned and backed by a file, QEMU prompts the following message:
qemu-system-x86_64: backend 'memory-backend-file' memory size must be multiple of 2 MiB
Quoted 61 lines · Michal Privoznik
If memory-backend-{file,ram} has a size that's not aligned to underlying page size it is not only wasteful, but also may lead to hard to debug behaviour. For instance, in case memory-backend-file and hugepages,
madvise()andmbind()fail. Rightfully so, page is the smallest unit they can work with. And even though an error is reported, the root cause it not very clear:qemu-system-x86_64: Couldn't set property 'dump' on 'memory-backend-file': Invalid argument
After this commit:
qemu-system-x86_64: backend 'memory-backend-file' memory size must be multiple of 2 MiB
Signed-off-by Michal Privoznik <[email protected]>Reviewed-by Philippe Mathieu-Daudé <[email protected]>Tested-by Mario Casquero <[email protected]>--- backends/hostmem.c | 10 ++++++++++ 1 file changed, 10 insertions(+)backends/hostmem.c +10
-1@@ -20,6 +20,7 @@#include "qom/object_interfaces.h" #include "qemu/mmap-alloc.h" #include "qemu/madvise.h" +#include "qemu/cutils.h" #include "hw/qdev-core.h" #ifdef CONFIG_NUMA @@ -337,6 +338,7 @@ host_memory_backend_memory_complete(UserCreatable *uc, Error **errp)HostMemoryBackendClass *bc =MEMORY_BACKEND_GET_CLASS (uc);void *ptr;uint64_t sz; +size_t pagesize;bool async = !phase_check (PHASE_LATE_BACKENDS_CREATED );if (!bc->alloc) {@@ -348,6 +350,14 @@ host_memory_backend_memory_complete(UserCreatable *uc, Error **errp) ptr =memory_region_get_ram_ptr (&backend->mr); sz =memory_region_size (&backend->mr); + pagesize =qemu_ram_pagesize (backend->mr.ram_block); + +if (!QEMU_IS_ALIGNED (sz, pagesize)) { + g_autofree char *pagesize_str = size_to_str(pagesize); +error_setg (errp,"backend '%s' memory size must be multiple of %s" , +object_get_typename (OBJECT (uc)), pagesize_str); +return ; + }if (backend->merge &&qemu_madvise (ptr, sz,QEMU_MADV_MERGEABLE )) { --2.44.1
Paolo Bonzini
AppliedQueued, thanks.
Paolo