dump.c: allow fd_write_vmcore to return errno on failure
v3 cover dump.c: allow fd_write_vmcore to return errno on failure
v3:
- added set_errg_errno() to all callers of fd_write_vmcore
- changed patch subject to reflect what it is addressing now
- link to previous version:
http://lists.gnu.org/archive/html/qemu-devel/2018-02/msg02787.html
Yasmin Beatriz (1):
dump.c: allow fd_write_vmcore to return errno on failure
dump.c | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-)
Signature · 1 line
2.14.3
PATCH v3 1/1 dump.c: allow fd_write_vmcore to return errno on failure
From: Yasmin Beatriz <[email protected]>
fd_write_vmcore can fail to execute for a lot of reasons that can be retrieved by errno, but it only returns -1. This makes difficult for the caller to know what happened and only a generic error message is propagated back to the user. This is an example using dump-guest-memory:
(qemu) dump-guest-memory /home/yasmin/mnt/test.dump
dump: failed to save memory
All callers of fd_write_vmcore of dump.c does error handling via error_setg(), so at first it seems feasible to add the Error pointer as an argument of fd_write_vmcore. This proved to be more complex than it first looked. fd_write_vmcore is used by write_elf64_notes and write_elf32_notes as a WriteCoreDumpFunction prototype. WriteCoreDumpFunction is declared in include/qom/cpu.h and is used all around the code. This leaves us with few alternatives:
- change the WriteCoreDumpFunction prototype to include an error pointer. This would require to change all functions that implements this prototype to also receive an Error pointer;
- change both write_elf64_notes and write_elf32_notes to no use the WriteCoreDumpFunction. These functions use not only fd_write_vmcore but also buf_write_note, so this would require to change buf_write_note to handle an Error pointer. Considerable easier than the alternative above, but it's still a lot of code just for the benefit of the callers of fd_write_vmcore.
This patch presents an easier solution that benefits all fd_write_vmcore callers:
- instead of returning -1 on error, return -errno. All existing callers already checks for ret < 0 so there is no need to change the caller's logic too much. This also allows the retrieval of the errno.
- all callers were updated to use error_setg_errno instead of just errno_setg. Now that fd_write_vmcore can return an errno, let's update all callers so they can benefit from a more detailed error message.
This is the same dump-guest-memory example with this patch applied:
(qemu) dump-guest-memory /home/yasmin/mnt/test.dump
dump: failed to save memory: No space left on device (qemu)
This example illustrates an error of fd_write_vmcore when called from write_data. All other callers will benefit from better error messages as well.
--- dump.c | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-)
dump.c +14 -9
@@ -107,7 +107,7 @@ static int fd_write_vmcore(const void *buf, size_t size, void *opaque) written_size =qemu_write_full (s->fd, buf, size);if (written_size != size) { -return -1 ; +return -errno; }return 0 ;
@@ -140,7 +140,7 @@ static void write_elf64_header(DumpState *s, Error **errp) ret =fd_write_vmcore (&elf_header,sizeof (elf_header), s);if (ret <0 ) { -error_setg (errp,"dump: failed to write elf header" ); +error_setg_errno (errp, -ret,"dump: failed to write elf header" ); } }
@@ -171,7 +171,7 @@ static void write_elf32_header(DumpState *s, Error **errp) ret =fd_write_vmcore (&elf_header,sizeof (elf_header), s);if (ret <0 ) { -error_setg (errp,"dump: failed to write elf header" ); +error_setg_errno (errp, -ret,"dump: failed to write elf header" ); } }
@@ -194,7 +194,8 @@ static void write_elf64_load(DumpState *s, MemoryMapping *memory_mapping, ret =fd_write_vmcore (&phdr,sizeof (Elf64_Phdr), s);if (ret <0 ) { -error_setg (errp,"dump: failed to write program header table" ); +error_setg_errno (errp, -ret, +"dump: failed to write program header table" ); } }
@@ -217,7 +218,8 @@ static void write_elf32_load(DumpState *s, MemoryMapping *memory_mapping, ret =fd_write_vmcore (&phdr,sizeof (Elf32_Phdr), s);if (ret <0 ) { -error_setg (errp,"dump: failed to write program header table" ); +error_setg_errno (errp, -ret, +"dump: failed to write program header table" ); } }
@@ -237,7 +239,8 @@ static void write_elf64_note(DumpState *s, Error **errp) ret =fd_write_vmcore (&phdr,sizeof (Elf64_Phdr), s);if (ret <0 ) { -error_setg (errp,"dump: failed to write program header table" ); +error_setg_errno (errp, -ret, +"dump: failed to write program header table" ); } }
@@ -302,7 +305,8 @@ static void write_elf32_note(DumpState *s, Error **errp) ret =fd_write_vmcore (&phdr,sizeof (Elf32_Phdr), s);if (ret <0 ) { -error_setg (errp,"dump: failed to write program header table" ); +error_setg_errno (errp, -ret, +"dump: failed to write program header table" ); } }
@@ -355,7 +359,8 @@ static void write_elf_section(DumpState *s, int type, Error **errp) ret =fd_write_vmcore (&shdr, shdr_size, s);if (ret <0 ) { -error_setg (errp,"dump: failed to write section header table" ); +error_setg_errno (errp, -ret, +"dump: failed to write section header table" ); } }
@@ -365,7 +370,7 @@ static void write_data(DumpState *s, void *buf, int length, Error **errp) ret =fd_write_vmcore (buf, length, s);if (ret <0 ) { -error_setg (errp,"dump: failed to save memory" ); +error_setg_errno (errp, -ret,"dump: failed to save memory" ); }else { s->written_size += length; }
Signature · 1 line
2.14.3
Hi
Quoted 46 lines · Daniel Henrique Barboza
From: Yasmin Beatriz <[email protected]>
fd_write_vmcorecan fail to execute for a lot of reasons that can be retrieved by errno, but it only returns -1. This makes difficult for the caller to know what happened and only a generic error message is propagated back to the user. This is an example using dump-guest-memory:(qemu) dump-guest-memory
/home/yasmin/mnt/test.dump
dump: failed to save memoryAll callers of
fd_write_vmcoreofdump.cdoes error handling viaerror_setg(), so at first it seems feasible to add the Error pointer as an argument offd_write_vmcore. This proved to be more complex than it first looked.fd_write_vmcoreis used bywrite_elf64_notesandwrite_elf32_notesas a WriteCoreDumpFunction prototype. WriteCoreDumpFunction is declared ininclude/qom/cpu.hand is used all around the code. This leaves us with few alternatives:- change the WriteCoreDumpFunction prototype to include an error pointer. This would require to change all functions that implements this prototype to also receive an Error pointer;
- change both
write_elf64_notesandwrite_elf32_notesto no use the WriteCoreDumpFunction. These functions use not onlyfd_write_vmcorebut alsobuf_write_note, so this would require to changebuf_write_noteto handle an Error pointer. Considerable easier than the alternative above, but it's still a lot of code just for the benefit of the callers offd_write_vmcore.This patch presents an easier solution that benefits all
fd_write_vmcorecallers:- instead of returning -1 on error, return -errno. All existing callers already checks for ret < 0 so there is no need to change the caller's logic too much. This also allows the retrieval of the errno.
- all callers were updated to use
error_setg_errnoinstead of justerrno_setg. Now thatfd_write_vmcorecan return an errno, let's update all callers so they can benefit from a more detailed error message.This is the same dump-guest-memory example with this patch applied:
(qemu) dump-guest-memory
/home/yasmin/mnt/test.dump
dump: failed to save memory: No space left on device (qemu)
Quoted 8 lines
This example illustrates an error of
fd_write_vmcorewhen called fromwrite_data. All other callers will benefit from better error messages as well.Reported-by [email protected]Cc Jose Ricardo Ziviani <[email protected]>Signed-off-by Yasmin Beatriz <[email protected]>Signed-off-by Daniel Henrique Barboza <[email protected]>
lgtm,
Quoted 97 lines
--- dump.c | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-)dump.c +14
-10@@ -107,7 +107,7 @@ static int fd_write_vmcore(const void *buf, size_t size, void *opaque) written_size =qemu_write_full (s->fd, buf, size);if (written_size != size) { -return -1 ; +return -errno; }return 0 ;@@ -140,7 +140,7 @@ static void write_elf64_header(DumpState *s, Error **errp) ret =fd_write_vmcore (&elf_header,sizeof (elf_header), s);if (ret <0 ) { -error_setg (errp,"dump: failed to write elf header" ); +error_setg_errno (errp, -ret,"dump: failed to write elf header" ); } }@@ -171,7 +171,7 @@ static void write_elf32_header(DumpState *s, Error **errp) ret =fd_write_vmcore (&elf_header,sizeof (elf_header), s);if (ret <0 ) { -error_setg (errp,"dump: failed to write elf header" ); +error_setg_errno (errp, -ret,"dump: failed to write elf header" ); } }@@ -194,7 +194,8 @@ static void write_elf64_load(DumpState *s, MemoryMapping *memory_mapping, ret =fd_write_vmcore (&phdr,sizeof (Elf64_Phdr), s);if (ret <0 ) { -error_setg (errp,"dump: failed to write program header table" ); +error_setg_errno (errp, -ret, +"dump: failed to write program header table" ); } }@@ -217,7 +218,8 @@ static void write_elf32_load(DumpState *s, MemoryMapping *memory_mapping, ret =fd_write_vmcore (&phdr,sizeof (Elf32_Phdr), s);if (ret <0 ) { -error_setg (errp,"dump: failed to write program header table" ); +error_setg_errno (errp, -ret, +"dump: failed to write program header table" ); } }@@ -237,7 +239,8 @@ static void write_elf64_note(DumpState *s, Error **errp) ret =fd_write_vmcore (&phdr,sizeof (Elf64_Phdr), s);if (ret <0 ) { -error_setg (errp,"dump: failed to write program header table" ); +error_setg_errno (errp, -ret, +"dump: failed to write program header table" ); } }@@ -302,7 +305,8 @@ static void write_elf32_note(DumpState *s, Error **errp) ret =fd_write_vmcore (&phdr,sizeof (Elf32_Phdr), s);if (ret <0 ) { -error_setg (errp,"dump: failed to write program header table" ); +error_setg_errno (errp, -ret, +"dump: failed to write program header table" ); } }@@ -355,7 +359,8 @@ static void write_elf_section(DumpState *s, int type, Error **errp) ret =fd_write_vmcore (&shdr, shdr_size, s);if (ret <0 ) { -error_setg (errp,"dump: failed to write section header table" ); +error_setg_errno (errp, -ret, +"dump: failed to write section header table" ); } }@@ -365,7 +370,7 @@ static void write_data(DumpState *s, void *buf, int length, Error **errp) ret =fd_write_vmcore (buf, length, s);if (ret <0 ) { -error_setg (errp,"dump: failed to save memory" ); +error_setg_errno (errp, -ret,"dump: failed to save memory" ); }else { s->written_size += length; } --2.14.3
Quoted 72 lines · Daniel Henrique Barboza
From: Yasmin Beatriz <[email protected]>
fd_write_vmcorecan fail to execute for a lot of reasons that can be retrieved by errno, but it only returns -1. This makes difficult for the caller to know what happened and only a generic error message is propagated back to the user. This is an example using dump-guest-memory:(qemu) dump-guest-memory
/home/yasmin/mnt/test.dump
dump: failed to save memoryAll callers of
fd_write_vmcoreofdump.cdoes error handling viaerror_setg(), so at first it seems feasible to add the Error pointer as an argument offd_write_vmcore. This proved to be more complex than it first looked.fd_write_vmcoreis used bywrite_elf64_notesandwrite_elf32_notesas a WriteCoreDumpFunction prototype. WriteCoreDumpFunction is declared ininclude/qom/cpu.hand is used all around the code. This leaves us with few alternatives:- change the WriteCoreDumpFunction prototype to include an error pointer. This would require to change all functions that implements this prototype to also receive an Error pointer;
- change both
write_elf64_notesandwrite_elf32_notesto no use the WriteCoreDumpFunction. These functions use not onlyfd_write_vmcorebut alsobuf_write_note, so this would require to changebuf_write_noteto handle an Error pointer. Considerable easier than the alternative above, but it's still a lot of code just for the benefit of the callers offd_write_vmcore.This patch presents an easier solution that benefits all
fd_write_vmcorecallers:- instead of returning -1 on error, return -errno. All existing callers already checks for ret < 0 so there is no need to change the caller's logic too much. This also allows the retrieval of the errno.
- all callers were updated to use
error_setg_errnoinstead of justerrno_setg. Now thatfd_write_vmcorecan return an errno, let's update all callers so they can benefit from a more detailed error message.This is the same dump-guest-memory example with this patch applied:
(qemu) dump-guest-memory
/home/yasmin/mnt/test.dump
dump: failed to save memory: No space left on device (qemu)This example illustrates an error of
fd_write_vmcorewhen called fromwrite_data. All other callers will benefit from better error messages as well.Reported-by [email protected]Cc Jose Ricardo Ziviani <[email protected]>Signed-off-by Yasmin Beatriz <[email protected]>Signed-off-by Daniel Henrique Barboza <[email protected]>--- dump.c | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-)dump.c +1
-1@@ -107,7 +107,7 @@ static int fd_write_vmcore(const void *buf, size_t size, void *opaque) written_size =qemu_write_full (s->fd, buf, size);if (written_size != size) { -return -1 ; +return -errno; }return 0 ;
dump.c static void write_elf64_header(DumpState *s, Error **errp) · line 143
Quoted 5 lines
dump.c +1
-1@@ -140,7 +140,7 @@ static void write_elf64_header(DumpState *s, Error **errp) ret =fd_write_vmcore (&elf_header,sizeof (elf_header), s);if (ret <0 ) { -error_setg (errp,"dump: failed to write elf header" ); +error_setg_errno (errp, -ret,"dump: failed to write elf header" );
Do we need -ret passed to error_setg_errno()? fd_write_vmcore() returns negative errno in case of error.
Cheers
Murilo
Quoted 74 lines · Murilo Opsfelder Araujo
Quoted 73 lines · Daniel Henrique Barboza
From: Yasmin Beatriz <[email protected]>
fd_write_vmcorecan fail to execute for a lot of reasons that can be retrieved by errno, but it only returns -1. This makes difficult for the caller to know what happened and only a generic error message is propagated back to the user. This is an example using dump-guest-memory:(qemu) dump-guest-memory
/home/yasmin/mnt/test.dump
dump: failed to save memoryAll callers of
fd_write_vmcoreofdump.cdoes error handling viaerror_setg(), so at first it seems feasible to add the Error pointer as an argument offd_write_vmcore. This proved to be more complex than it first looked.fd_write_vmcoreis used bywrite_elf64_notesandwrite_elf32_notesas a WriteCoreDumpFunction prototype. WriteCoreDumpFunction is declared ininclude/qom/cpu.hand is used all around the code. This leaves us with few alternatives:- change the WriteCoreDumpFunction prototype to include an error pointer. This would require to change all functions that implements this prototype to also receive an Error pointer;
- change both
write_elf64_notesandwrite_elf32_notesto no use the WriteCoreDumpFunction. These functions use not onlyfd_write_vmcorebut alsobuf_write_note, so this would require to changebuf_write_noteto handle an Error pointer. Considerable easier than the alternative above, but it's still a lot of code just for the benefit of the callers offd_write_vmcore.This patch presents an easier solution that benefits all
fd_write_vmcorecallers:- instead of returning -1 on error, return -errno. All existing callers already checks for ret < 0 so there is no need to change the caller's logic too much. This also allows the retrieval of the errno.
- all callers were updated to use
error_setg_errnoinstead of justerrno_setg. Now thatfd_write_vmcorecan return an errno, let's update all callers so they can benefit from a more detailed error message.This is the same dump-guest-memory example with this patch applied:
(qemu) dump-guest-memory
/home/yasmin/mnt/test.dump
dump: failed to save memory: No space left on device (qemu)This example illustrates an error of
fd_write_vmcorewhen called fromwrite_data. All other callers will benefit from better error messages as well.Reported-by [email protected]Cc Jose Ricardo Ziviani <[email protected]>Signed-off-by Yasmin Beatriz <[email protected]>Signed-off-by Daniel Henrique Barboza <[email protected]>--- dump.c | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-)dump.c +1
-1@@ -107,7 +107,7 @@ static int fd_write_vmcore(const void *buf, size_t size, void *opaque) written_size =qemu_write_full (s->fd, buf, size);if (written_size != size) { -return -1 ; +return -errno; }return 0 ;@@ -140,7 +140,7 @@ static void write_elf64_header(DumpState *s, Error **errp)
Quoted 6 lines
dump.c static void write_elf64_header(DumpState *s, Error **errp) · line 143
Quoted 4 lines
dump.c +1
-1ret =fd_write_vmcore (&elf_header,sizeof (elf_header), s);if (ret <0 ) { -error_setg (errp,"dump: failed to write elf header" ); +error_setg_errno (errp, -ret,"dump: failed to write elf header" );Do we need -ret passed to
error_setg_errno()?fd_write_vmcore()returns negative errno in case of error.
I am passing -ret here to provide a positive errno value to error_setg_errno. I am not sure if os_error can be negative and didn't want to risk strerror() breaking.
Daniel
Quoted 3 lines
Cheers
Murilo
Quoted 21 lines · Murilo Opsfelder Araujo
Quoted 20 lines · Daniel Henrique Barboza
From: Yasmin Beatriz <[email protected]>
fd_write_vmcorecan fail to execute for a lot of reasons that can be retrieved by errno, but it only returns -1. This makes difficult for the caller to know what happened and only a generic error message is propagated back to the user. This is an example using dump-guest-memory:+++
b/dump.cdump.c +1
-1@@ -107,7 +107,7 @@ static int fd_write_vmcore(const void *buf, size_t size, void *opaque) written_size =qemu_write_full (s->fd, buf, size);if (written_size != size) { -return -1 ; +return -errno; }return 0 ;@@ -140,7 +140,7 @@ static void write_elf64_header(DumpState *s, Error **errp)
Quoted 7 lines
dump.c static void write_elf64_header(DumpState *s, Error **errp) · line 143
Quoted 4 lines
dump.c +1
-1ret =fd_write_vmcore (&elf_header,sizeof (elf_header), s);if (ret <0 ) { -error_setg (errp,"dump: failed to write elf header" ); +error_setg_errno (errp, -ret,"dump: failed to write elf header" );Do we need -ret passed to
error_setg_errno()?fd_write_vmcore()returns negative errno in case of error.
Yes, this usage is correct. error_setg_errno() takes a positive errno value (using strerror, which only decodes positive values into useful strings); but we typically return negative errno values (as was correctly done in fd_write_vmcore), so the extra layer of negation here is needed.
Signature · 3 lines
Eric Blake, Principal Software Engineer Red Hat, Inc. +1-919-301-3266 Virtualization: qemu.org | libvirt.org
Quoted 33 lines · Eric Blake
Quoted 23 lines · Murilo Opsfelder Araujo
Quoted 22 lines · Daniel Henrique Barboza
From: Yasmin Beatriz <[email protected]>
fd_write_vmcorecan fail to execute for a lot of reasons that can be retrieved by errno, but it only returns -1. This makes difficult for the caller to know what happened and only a generic error message is propagated back to the user. This is an example using dump-guest-memory:+++
b/dump.cdump.c +1
-1@@ -107,7 +107,7 @@ static int fd_write_vmcore(const void *buf, size_t size, void *opaque) written_size = qemu_write_full(s->fd, buf, size); if (written_size != size) { - return -1; + return -errno; }return 0;
(quoted diff) +0
-0@@ -140,7 +140,7 @@ static void write_elf64_header(DumpState *s, Error **errp)Quoted 8 lines
dump.c static void write_elf64_header(DumpState *s, Error **errp)
Quoted 5 lines
dump.c +1
-1ret = fd_write_vmcore(&elf_header, sizeof(elf_header), s); if (ret < 0) { - error_setg(errp, "dump: failed to write elf header"); + error_setg_errno(errp, -ret, "dump: failed to write elf header");Do we need -ret passed to
error_setg_errno()?fd_write_vmcore()returns negative errno in case of error.
Quoted 6 lines
Yes, this usage is correct.
error_setg_errno()takes a positive errno value (using strerror, which only decodes positive values into useful strings); but we typically return negative errno values (as was correctly done infd_write_vmcore), so the extra layer of negation here is needed.
For some reason I assumed "non-zero" in the error_setg_errno() description as negative.
Thanks Daniel and Eric.
Quoted 10 lines · Daniel Henrique Barboza
From: Yasmin Beatriz <[email protected]>
fd_write_vmcorecan fail to execute for a lot of reasons that can be retrieved by errno, but it only returns -1. This makes difficult for the caller to know what happened and only a generic error message is propagated back to the user. This is an example using dump-guest-memory:(qemu) dump-guest-memory
/home/yasmin/mnt/test.dump
dump: failed to save memory
...
Quoted 10 lines
This is the same dump-guest-memory example with this patch applied:
(qemu) dump-guest-memory
/home/yasmin/mnt/test.dump
dump: failed to save memory: No space left on device (qemu)This example illustrates an error of
fd_write_vmcorewhen called fromwrite_data. All other callers will benefit from better error messages as well.
Quoted 8 lines
Reported-by [email protected]Cc Jose Ricardo Ziviani <[email protected]>Signed-off-by Yasmin Beatriz <[email protected]>Signed-off-by Daniel Henrique Barboza <[email protected]>--- dump.c | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-)
Signature · 3 lines
Eric Blake, Principal Software Engineer Red Hat, Inc. +1-919-301-3266 Virtualization: qemu.org | libvirt.org
Ping
Quoted 13 lines · Daniel Henrique Barboza
v3:
- addedset_errg_errno()to all callers offd_write_vmcore
- changed patch subject to reflect what it is addressing now
- link to previous version:
http://lists.gnu.org/archive/html/qemu-devel/2018-02/msg02787.htmlYasmin Beatriz (1):
dump.c: allowfd_write_vmcoreto return errno on failuredump.c | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-)
Quoted 16 lines · Daniel Henrique Barboza
Ping
Quoted 13 lines · Daniel Henrique Barboza
v3:
- addedset_errg_errno()to all callers offd_write_vmcore
- changed patch subject to reflect what it is addressing now
- link to previous version:
http://lists.gnu.org/archive/html/qemu-devel/2018-02/msg02787.htmlYasmin Beatriz (1):
dump.c: allowfd_write_vmcoreto return errno on failuredump.c | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-)
This seems like an appropriate bug-fix patch for inclusion in 2.12. Marc-André, are you planning a pull request, or should we bundle this through another miscellaneous tree?
Signature · 3 lines
Eric Blake, Principal Software Engineer Red Hat, Inc. +1-919-301-3266 Virtualization: qemu.org | libvirt.org
Hi
Quoted 16 lines · Eric Blake
Quoted 15 lines · Daniel Henrique Barboza
Ping
Quoted 11 lines · Daniel Henrique Barboza
v3:
- addedset_errg_errno()to all callers offd_write_vmcore
- changed patch subject to reflect what it is addressing now
- link to previous version:
http://lists.gnu.org/archive/html/qemu-devel/2018-02/msg02787.htmlYasmin Beatriz (1):
dump.c: allowfd_write_vmcoreto return errno on failure
Quoted 7 lines
Quoted 3 lines
Quoted 3 lines
dump.c | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-)This seems like an appropriate bug-fix patch for inclusion in 2.12. Marc-André, are you planning a pull request, or should we bundle this through another miscellaneous tree?
Ok, I'll prepare a pull request.
Thanks