hmp: Allow for error message hints on HMP
PATCH 1/1 hmp: Allow for error message hints on HMP
Commits 7216ae3d and d2828429 disabled some error message hints, all because a change to use modern error reporting meant that the hint would be output prior to the actual error. Fix this by making hints a first-class member of Error.
For example, we are now back to the pleasant:
$ qemu-system-x86_64 --nodefaults -S --vnc :0 --chardev null,id=, qemu-system-x86_64: --chardev null,id=,: Parameter 'id' expects an identifier Identifiers consist of letters, digits, '-', '.', '_', starting with a letter.
--- include/qapi/error.h | 7 +++++++ qdev-monitor.c | 42 ++++++++++++++---------------------------- util/error.c | 31 +++++++++++++++++++++++++++++++ util/qemu-option.c | 11 ++++------- 4 files changed, 56 insertions(+), 35 deletions(-)
include/qapi/error.h +7 -0
@@ -67,6 +67,13 @@ void error_set_win32(Error **errp, int win32_err, ErrorClass err_class,*/ void error_setg_file_open (Error **errp,int os_errno,const char *filename); +/** +* Append a printf-style human-readable explanation to an existing error. +* May be called multiple times, and safe if @errp is NULL. +*/ +void error_append_hint(Error **errp, const char *fmt, ...) + GCC_FMT_ATTR(2, 3); +/* * Get the error class of an error object. */
qdev-monitor.c +14 -28
84 lines not on this page · raw message
util/error.c +31 -0
@@ -18,6 +18,7 @@ struct Error {char *msg;ErrorClass err_class; +char *hint; };Error *error_abort;
@@ -91,6 +92,31 @@ void error_setg_file_open(Error **errp, int os_errno, const char *filename)error_setg_errno (errp, os_errno,"Could not open '%s'" , filename); } +void error_append_hint (Error **errp,const char *fmt, ...) +{ +char *msg1; +char *tmp; +va_list ap; +int saved_errno = errno; +Error *err; + +if (!errp) { +return ; + } + err = *errp; +assert (err && errp != &error_abort); + +va_start (ap, fmt); + msg1 =g_strdup_vprintf (fmt, ap); + tmp = err->hint; + err->hint =g_strdup_printf ("%s%s" , tmp ? tmp :"" , msg1); +g_free (tmp); +g_free (msg1); +va_end (ap); + + errno = saved_errno; +} +#ifdef _WIN32 void error_set_win32(Error **errp, int win32_err, ErrorClass err_class,
@@ -138,6 +164,7 @@ Error *error_copy(const Error *err) err_new =g_malloc0 (sizeof (*err)); err_new->msg =g_strdup (err->msg); err_new->err_class = err->err_class; + err_new->hint =g_strdup (err->hint);return err_new; }
@@ -155,6 +182,9 @@ const char *error_get_pretty(Error *err)void error_report_err (Error *err) {error_report ("%s" ,error_get_pretty (err)); +if (err->hint) { +error_printf_unless_qmp ("%s\n" , err->hint); + }error_free (err); }
@@ -162,6 +192,7 @@ void error_free(Error *err) {if (err) {g_free (err->msg); +g_free (err->hint);g_free (err); } }
util/qemu-option.c +4 -7
@@ -200,10 +200,8 @@ void parse_option_size(const char *name, const char *value,break ;default :error_setg (errp,QERR_INVALID_PARAMETER_VALUE , name,"a size" ); -#if 0 /* conversion from qerror_report() to error_set() broke this: */ -error_printf_unless_qmp ("You may use k, M, G or T suffixes for " -"kilobytes, megabytes, gigabytes and terabytes.\n" ); -#endif +error_append_hint (errp,"You may use k, M, G or T suffixes for " +"kilobytes, megabytes, gigabytes and terabytes." );return ; } }else {
@@ -643,9 +641,8 @@ QemuOpts *qemu_opts_create(QemuOptsList *list, const char *id,if (!id_wellformed (id)) {error_setg (errp,QERR_INVALID_PARAMETER_VALUE ,"id" ,"an identifier" ); -#if 0 /* conversion from qerror_report() to error_set() broke this: */ -error_printf_unless_qmp ("Identifiers consist of letters, digits, '-', '.', '_', starting with a letter.\n" ); -#endif +error_append_hint (errp,"Identifiers consist of letters, digits, " +"'-', '.', '_', starting with a letter." );return NULL ; } opts =qemu_opts_find (list, id);
Signature · 1 line
2.4.3
[adding some potential maintainers in cc; ./scripts/get_maintainer.pl struck out in spite of the patch touching multiple files. Maybe that means we need a MAINTAINERS update?]
Quoted 229 lines · Eric Blake
Commits
7216ae3dandd2828429disabled some error message hints, all because a change to use modern error reporting meant that the hint would be output prior to the actual error. Fix this by making hints a first-class member of Error.For example, we are now back to the pleasant:
$ qemu-system-x86_64 --nodefaults -S --vnc :0 --chardev null,id=, qemu-system-x86_64: --chardev null,id=,: Parameter 'id' expects an identifier Identifiers consist of letters, digits, '-', '.', '_', starting with a letter.Signed-off-by Eric Blake <[email protected]>--- include/qapi/error.h | 7 +++++++ qdev-monitor.c | 42 ++++++++++++++---------------------------- util/error.c | 31 +++++++++++++++++++++++++++++++ util/qemu-option.c | 11 ++++------- 4 files changed, 56 insertions(+), 35 deletions(-)include/qapi/error.h +7
-0@@ -67,6 +67,13 @@ void error_set_win32(Error **errp, int win32_err, ErrorClass err_class,*/ void error_setg_file_open (Error **errp,int os_errno,const char *filename); +/** +* Append a printf-style human-readable explanation to an existing error. +* May be called multiple times, and safe if @errp is NULL. +*/ +void error_append_hint(Error **errp, const char *fmt, ...) + GCC_FMT_ATTR(2, 3); +/* * Get the error class of an error object. */ qdev-monitor.c +14
-28@@ -289,37 +289,35 @@ static Object *qdev_get_peripheral_anon(void)return dev; } -#if 0 /* conversion from qerror_report() to error_set() broke their use */ -static void qbus_list_bus (DeviceState *dev) +static void qbus_list_bus (DeviceState *dev,Error **errp) {BusState *child;const char *sep =" " ; -error_printf ("child buses at \"%s\":" , - dev->id ? dev->id :object_get_typename (OBJECT (dev))); +error_append_hint (errp,"child buses at \"%s\":" , + dev->id ? dev->id :object_get_typename (OBJECT (dev))); QLIST_FOREACH(child, &dev->child_bus, sibling) { -error_printf ("%s\"%s\"" , sep, child->name); +error_append_hint (errp,"%s\"%s\"" , sep, child->name); sep =", " ; } -error_printf ("\n" ); } -static void qbus_list_dev (BusState *bus) +static void qbus_list_dev (BusState *bus,Error **errp) {BusChild *kid;const char *sep =" " ; -error_printf ("devices at \"%s\":" , bus->name); +error_append_hint (errp,"devices at \"%s\":" , bus->name); QTAILQ_FOREACH(kid, &bus->children, sibling) {DeviceState *dev = kid->child; -error_printf ("%s\"%s\"" , sep,object_get_typename (OBJECT (dev))); -if (dev->id) -error_printf ("/\"%s\"" , dev->id); +error_append_hint (errp,"%s\"%s\"" , sep, +object_get_typename (OBJECT (dev))); +if (dev->id) { +error_append_hint (errp,"/\"%s\"" , dev->id); + } sep =", " ; } -error_printf ("\n" ); } -#endif static BusState *qbus_find_bus (DeviceState *dev,char *elem) {@@ -461,11 +459,7 @@ static BusState *qbus_find(const char *path, Error **errp)if (!dev) {error_set (errp,ERROR_CLASS_DEVICE_NOT_FOUND ,"Device '%s' not found" , elem); -#if 0 /* conversion from qerror_report() to error_set() broke this: */ -if (!monitor_cur_is_qmp ()) { -qbus_list_dev (bus); - } -#endif +qbus_list_dev (bus, errp);return NULL ; }@@ -483,11 +477,7 @@ static BusState *qbus_find(const char *path, Error **errp)if (dev->num_child_bus) {error_setg (errp,"Device '%s' has multiple child buses" , elem); -#if 0 /* conversion from qerror_report() to error_set() broke this: */ -if (!monitor_cur_is_qmp ()) { -qbus_list_bus (dev); - } -#endif +qbus_list_bus (dev, errp); }else {error_setg (errp,"Device '%s' has no child bus" , elem); }@@ -503,11 +493,7 @@ static BusState *qbus_find(const char *path, Error **errp) bus =qbus_find_bus (dev, elem);if (!bus) {error_setg (errp,"Bus '%s' not found" , elem); -#if 0 /* conversion from qerror_report() to error_set() broke this: */ -if (!monitor_cur_is_qmp ()) { -qbus_list_bus (dev); - } -#endif +qbus_list_bus (dev, errp);return NULL ; } }util/error.c +31
-0@@ -18,6 +18,7 @@ struct Error {char *msg;ErrorClass err_class; +char *hint; };Error *error_abort;@@ -91,6 +92,31 @@ void error_setg_file_open(Error **errp, int os_errno, const char *filename)error_setg_errno (errp, os_errno,"Could not open '%s'" , filename); } +void error_append_hint (Error **errp,const char *fmt, ...) +{ +char *msg1; +char *tmp; +va_list ap; +int saved_errno = errno; +Error *err; + +if (!errp) { +return ; + } + err = *errp; +assert (err && errp != &error_abort); + +va_start (ap, fmt); + msg1 =g_strdup_vprintf (fmt, ap); + tmp = err->hint; + err->hint =g_strdup_printf ("%s%s" , tmp ? tmp :"" , msg1); +g_free (tmp); +g_free (msg1); +va_end (ap); + + errno = saved_errno; +} +#ifdef _WIN32 void error_set_win32(Error **errp, int win32_err, ErrorClass err_class,@@ -138,6 +164,7 @@ Error *error_copy(const Error *err) err_new =g_malloc0 (sizeof (*err)); err_new->msg =g_strdup (err->msg); err_new->err_class = err->err_class; + err_new->hint =g_strdup (err->hint);return err_new; }@@ -155,6 +182,9 @@ const char *error_get_pretty(Error *err)void error_report_err (Error *err) {error_report ("%s" ,error_get_pretty (err)); +if (err->hint) { +error_printf_unless_qmp ("%s\n" , err->hint); + }error_free (err); }@@ -162,6 +192,7 @@ void error_free(Error *err) {if (err) {g_free (err->msg); +g_free (err->hint);g_free (err); } }util/qemu-option.c +4
-7@@ -200,10 +200,8 @@ void parse_option_size(const char *name, const char *value,break ;default :error_setg (errp,QERR_INVALID_PARAMETER_VALUE , name,"a size" ); -#if 0 /* conversion from qerror_report() to error_set() broke this: */ -error_printf_unless_qmp ("You may use k, M, G or T suffixes for " -"kilobytes, megabytes, gigabytes and terabytes.\n" ); -#endif +error_append_hint (errp,"You may use k, M, G or T suffixes for " +"kilobytes, megabytes, gigabytes and terabytes." );return ; } }else {@@ -643,9 +641,8 @@ QemuOpts *qemu_opts_create(QemuOptsList *list, const char *id,if (!id_wellformed (id)) {error_setg (errp,QERR_INVALID_PARAMETER_VALUE ,"id" ,"an identifier" ); -#if 0 /* conversion from qerror_report() to error_set() broke this: */ -error_printf_unless_qmp ("Identifiers consist of letters, digits, '-', '.', '_', starting with a letter.\n" ); -#endif +error_append_hint (errp,"Identifiers consist of letters, digits, " +"'-', '.', '_', starting with a letter." );return NULL ; } opts =qemu_opts_find (list, id);
Signature · 2 lines
Eric Blake eblake redhat com +1-919-301-3266 Libvirt virtualization library http://libvirt.org
Quoted 153 lines · Eric Blake
Commits
7216ae3dandd2828429disabled some error message hints, all because a change to use modern error reporting meant that the hint would be output prior to the actual error. Fix this by making hints a first-class member of Error.For example, we are now back to the pleasant:
$ qemu-system-x86_64 --nodefaults -S --vnc :0 --chardev null,id=, qemu-system-x86_64: --chardev null,id=,: Parameter 'id' expects an identifier Identifiers consist of letters, digits, '-', '.', '_', starting with a letter.Signed-off-by Eric Blake <[email protected]>--- include/qapi/error.h | 7 +++++++ qdev-monitor.c | 42 ++++++++++++++---------------------------- util/error.c | 31 +++++++++++++++++++++++++++++++ util/qemu-option.c | 11 ++++------- 4 files changed, 56 insertions(+), 35 deletions(-)include/qapi/error.h +7
-0@@ -67,6 +67,13 @@ void error_set_win32(Error **errp, int win32_err, ErrorClass err_class,*/ void error_setg_file_open (Error **errp,int os_errno,const char *filename); +/** +* Append a printf-style human-readable explanation to an existing error. +* May be called multiple times, and safe if @errp is NULL. +*/ +void error_append_hint(Error **errp, const char *fmt, ...) + GCC_FMT_ATTR(2, 3); +/* * Get the error class of an error object. */ qdev-monitor.c +14
-28@@ -289,37 +289,35 @@ static Object *qdev_get_peripheral_anon(void)return dev; } -#if 0 /* conversion from qerror_report() to error_set() broke their use */ -static void qbus_list_bus (DeviceState *dev) +static void qbus_list_bus (DeviceState *dev,Error **errp) {BusState *child;const char *sep =" " ; -error_printf ("child buses at \"%s\":" , - dev->id ? dev->id :object_get_typename (OBJECT (dev))); +error_append_hint (errp,"child buses at \"%s\":" , + dev->id ? dev->id :object_get_typename (OBJECT (dev))); QLIST_FOREACH(child, &dev->child_bus, sibling) { -error_printf ("%s\"%s\"" , sep, child->name); +error_append_hint (errp,"%s\"%s\"" , sep, child->name); sep =", " ; } -error_printf ("\n" ); } -static void qbus_list_dev (BusState *bus) +static void qbus_list_dev (BusState *bus,Error **errp) {BusChild *kid;const char *sep =" " ; -error_printf ("devices at \"%s\":" , bus->name); +error_append_hint (errp,"devices at \"%s\":" , bus->name); QTAILQ_FOREACH(kid, &bus->children, sibling) {DeviceState *dev = kid->child; -error_printf ("%s\"%s\"" , sep,object_get_typename (OBJECT (dev))); -if (dev->id) -error_printf ("/\"%s\"" , dev->id); +error_append_hint (errp,"%s\"%s\"" , sep, +object_get_typename (OBJECT (dev))); +if (dev->id) { +error_append_hint (errp,"/\"%s\"" , dev->id); + } sep =", " ; } -error_printf ("\n" ); } -#endif static BusState *qbus_find_bus (DeviceState *dev,char *elem) {@@ -461,11 +459,7 @@ static BusState *qbus_find(const char *path, Error **errp)if (!dev) {error_set (errp,ERROR_CLASS_DEVICE_NOT_FOUND ,"Device '%s' not found" , elem); -#if 0 /* conversion from qerror_report() to error_set() broke this: */ -if (!monitor_cur_is_qmp ()) { -qbus_list_dev (bus); - } -#endif +qbus_list_dev (bus, errp);return NULL ; }@@ -483,11 +477,7 @@ static BusState *qbus_find(const char *path, Error **errp)if (dev->num_child_bus) {error_setg (errp,"Device '%s' has multiple child buses" , elem); -#if 0 /* conversion from qerror_report() to error_set() broke this: */ -if (!monitor_cur_is_qmp ()) { -qbus_list_bus (dev); - } -#endif +qbus_list_bus (dev, errp); }else {error_setg (errp,"Device '%s' has no child bus" , elem); }@@ -503,11 +493,7 @@ static BusState *qbus_find(const char *path, Error **errp) bus =qbus_find_bus (dev, elem);if (!bus) {error_setg (errp,"Bus '%s' not found" , elem); -#if 0 /* conversion from qerror_report() to error_set() broke this: */ -if (!monitor_cur_is_qmp ()) { -qbus_list_bus (dev); - } -#endif +qbus_list_bus (dev, errp);return NULL ; } }util/error.c +9
-0@@ -18,6 +18,7 @@ struct Error {char *msg;ErrorClass err_class; +char *hint; };Error *error_abort;@@ -91,6 +92,31 @@ void error_setg_file_open(Error **errp, int os_errno, const char *filename)error_setg_errno (errp, os_errno,"Could not open '%s'" , filename); } +void error_append_hint (Error **errp,const char *fmt, ...) +{ +char *msg1; +char *tmp; +va_list ap; +int saved_errno = errno; +Error *err; +
util/error.c void error_setg_file_open(Error **errp, int os_errno, const char *filename) · line 112
Quoted 10 lines
util/error.c +10
-0+if (!errp) { +return ; + } + err = *errp; +assert (err && errp != &error_abort); + +va_start (ap, fmt); + msg1 =g_strdup_vprintf (fmt, ap); + tmp = err->hint; + err->hint =g_strdup_printf ("%s%s" , tmp ? tmp :"" , msg1);
It could use a GString and g_string_append_vprintf instead of the somewhat ugly O(n^2) concatenation...
Paolo
Quoted 66 lines
util/error.c +12
-0+g_free (tmp); +g_free (msg1); +va_end (ap); + + errno = saved_errno; +} +#ifdef _WIN32 void error_set_win32(Error **errp, int win32_err, ErrorClass err_class,@@ -138,6 +164,7 @@ Error *error_copy(const Error *err) err_new =g_malloc0 (sizeof (*err)); err_new->msg =g_strdup (err->msg); err_new->err_class = err->err_class; + err_new->hint =g_strdup (err->hint);return err_new; }@@ -155,6 +182,9 @@ const char *error_get_pretty(Error *err)void error_report_err (Error *err) {error_report ("%s" ,error_get_pretty (err)); +if (err->hint) { +error_printf_unless_qmp ("%s\n" , err->hint); + }error_free (err); }@@ -162,6 +192,7 @@ void error_free(Error *err) {if (err) {g_free (err->msg); +g_free (err->hint);g_free (err); } }util/qemu-option.c +4
-7@@ -200,10 +200,8 @@ void parse_option_size(const char *name, const char *value,break ;default :error_setg (errp,QERR_INVALID_PARAMETER_VALUE , name,"a size" ); -#if 0 /* conversion from qerror_report() to error_set() broke this: */ -error_printf_unless_qmp ("You may use k, M, G or T suffixes for " -"kilobytes, megabytes, gigabytes and terabytes.\n" ); -#endif +error_append_hint (errp,"You may use k, M, G or T suffixes for " +"kilobytes, megabytes, gigabytes and terabytes." );return ; } }else {@@ -643,9 +641,8 @@ QemuOpts *qemu_opts_create(QemuOptsList *list, const char *id,if (!id_wellformed (id)) {error_setg (errp,QERR_INVALID_PARAMETER_VALUE ,"id" ,"an identifier" ); -#if 0 /* conversion from qerror_report() to error_set() broke this: */ -error_printf_unless_qmp ("Identifiers consist of letters, digits, '-', '.', '_', starting with a letter.\n" ); -#endif +error_append_hint (errp,"Identifiers consist of letters, digits, " +"'-', '.', '_', starting with a letter." );return NULL ; } opts =qemu_opts_find (list, id);