enforce use of G_GNUC_PRINTF annotations
cover enforce use of G_GNUC_PRINTF annotations
We've been very gradually adding G_GNUC_PRINTF annotations to functions over years. This has been useful in detecting certain malformed printf strings, or cases where we pass user data as the printf format which is a potential security flaw.
Given the inherant memory corruption danger in use of format strings vs mis-matched variadic arguments, it is worth applying G_GNUC_PRINTF to all functions using printf, even if we know they are safe.
The compilers can reasonably reliably identify such places with the -Wsuggest-attribute=format / -Wmissing-format-attribute flags.
This series adds G_GNUC_PRINTF / G_GNUC_SCANF to allow the code locations that the compilers highlight. Then it adds the above warning flags to the build flags, to catch any future additions of functions that take printf/scanf format strings.
Daniel P. Berrangé (6):
disas: add G_GNUC_PRINTF to gstring_printf hw/xen: use G_GNUC_PRINTF/SCANF for various functions tools/virtiofsd: add G_GNUC_PRINTF for logging functions util/error: add G_GNUC_PRINTF for various functions
tests: add G_GNUC_PRINTF for various functions enforce use of G_GNUC_PRINTF attributes
configure | 2 ++ disas.c | 1 + hw/xen/xen-bus.c | 1 + hw/xen/xen_pvdev.c | 1 + include/hw/xen/xen-bus-helper.h | 6 ++++-- include/hw/xen/xen-bus.h | 3 ++- tests/qtest/ahci-test.c | 3 +++ tests/qtest/arm-cpu-features.c | 1 + tests/qtest/erst-test.c | 2 +- tests/qtest/ide-test.c | 3 ++- tests/qtest/ivshmem-test.c | 4 ++-- tests/qtest/libqmp.c | 2 +- tests/qtest/libqos/libqos-pc.h | 6 ++++-- tests/qtest/libqos/libqos-spapr.h | 6 ++++-- tests/qtest/libqos/libqos.h | 6 ++++-- tests/qtest/libqos/virtio-9p.c | 1 + tests/qtest/migration-helpers.h | 1 + tests/qtest/rtas-test.c | 2 +- tests/qtest/usb-hcd-uhci-test.c | 4 ++-- tests/unit/test-qmp-cmds.c | 13 +++++++++---- tools/virtiofsd/fuse_log.c | 1 + tools/virtiofsd/fuse_log.h | 6 ++++-- tools/virtiofsd/passthrough_ll.c | 1 + util/error-report.c | 1 + util/error.c | 1 + 25 files changed, 55 insertions(+), 23 deletions(-)
Signature · 1 line
2.38.1
PATCH 1/6 disas: add G_GNUC_PRINTF to gstring_printf
--- disas.c | 1 + 1 file changed, 1 insertion(+)
disas.c +1 -0
@@ -239,6 +239,7 @@ void target_disas(FILE *out, CPUState *cpu, target_ulong code, } } +G_GNUC_PRINTF(2, 3)static int gstring_printf (FILE *stream,const char *fmt, ...) {/* We abuse the FILE parameter to pass a GString. */
Signature · 1 line
2.38.1
Re: [PATCH 1/6] disas: add G_GNUC_PRINTF to gstring_printf
Am 19.12.22 um 14:02 schrieb Daniel P. Berrangé:
Quoted 10 lines
Signed-off-by Daniel P. Berrangé <[email protected]>--- disas.c | 1 + 1 file changed, 1 insertion(+)disas.c +0
-0
disas.c void target_disas(FILE *out, CPUState *cpu, target_ulong code, · line 245
Quoted 7 lines
disas.c +1
-0@@ -239,6 +239,7 @@ void target_disas(FILE *out, CPUState *cpu, target_ulong code, } } +G_GNUC_PRINTF(2, 3)static int gstring_printf (FILE *stream,const char *fmt, ...) {/* We abuse the FILE parameter to pass a GString. */
The current code uses a different pattern:
static RETURN_TYPE G_GNUC_PRINTF(2, 3) function(argument list)
So I would have expected
static int G_GNUC_PRINTF(2, 3) gstring_printf(FILE *stream, const char *fmt, ...)
Does that matter? Do we care for different patterns?
Stefan
PATCH 2/6 hw/xen: use G_GNUC_PRINTF/SCANF for various functions
In reply to Daniel P. Berrangé--- hw/xen/xen-bus.c | 1 + hw/xen/xen_pvdev.c | 1 + include/hw/xen/xen-bus-helper.h | 6 ++++-- include/hw/xen/xen-bus.h | 3 ++- 4 files changed, 8 insertions(+), 3 deletions(-)
hw/xen/xen-bus.c +1 -0
@@ -561,6 +561,7 @@ void xen_device_backend_printf(XenDevice *xendev, const char *key, } } +G_GNUC_SCANF(3, 4)static int xen_device_backend_scanf (XenDevice *xendev,const char *key,const char *fmt, ...) {
hw/xen/xen_pvdev.c +1 -0
@@ -196,6 +196,7 @@ const char *xenbus_strstate(enum xenbus_state state)* 2 == noisy debug messages (logfile only). * 3 == will flood your log (logfile only). */ +G_GNUC_PRINTF(3, 0)static void xen_pv_output_msg (struct XenLegacyDevice *xendev,FILE *f,const char *fmt,va_list args) {
include/hw/xen/xen-bus-helper.h +4 -2
@@ -31,10 +31,12 @@ void xs_node_printf(struct xs_handle *xsh, xs_transaction_t tid,/* Read from node/key unless node is empty, in which case read from key */ int xs_node_vscanf(struct xs_handle *xsh, xs_transaction_t tid, const char *node, const char *key, Error **errp, -const char *fmt,va_list ap); + const char *fmt, va_list ap) + G_GNUC_SCANF(6, 0); int xs_node_scanf(struct xs_handle *xsh, xs_transaction_t tid, const char *node, const char *key, Error **errp, -const char *fmt, ...); + const char *fmt, ...) + G_GNUC_SCANF(6, 7);/* Watch node/key unless node is empty, in which case watch key */ void xs_node_watch(struct xs_handle *xsh, const char *node, const char *key,
include/hw/xen/xen-bus.h +2 -1
@@ -94,7 +94,8 @@ void xen_device_frontend_printf(XenDevice *xendev, const char *key,G_GNUC_PRINTF (3 ,4 ); int xen_device_frontend_scanf(XenDevice *xendev, const char *key, -const char *fmt, ...); + const char *fmt, ...) + G_GNUC_SCANF(3, 4);void xen_device_set_max_grant_refs (XenDevice *xendev,unsigned int nr_refs,Error **errp);
Signature · 1 line
2.38.1
Re: [PATCH 2/6] hw/xen: use G_GNUC_PRINTF/SCANF for various functions
Quoted 1 line · Daniel P. Berrangé
Signed-off-by Daniel P. Berrangé <[email protected]>
Thanks,
Signature · 1 line
Anthony PERARD
PATCH 3/6 tools/virtiofsd: add G_GNUC_PRINTF for logging functions
In reply to Daniel P. Berrangé--- tools/virtiofsd/fuse_log.c | 1 + tools/virtiofsd/fuse_log.h | 6 ++++-- tools/virtiofsd/passthrough_ll.c | 1 + 3 files changed, 6 insertions(+), 2 deletions(-)
tools/virtiofsd/fuse_log.c +1 -0
@@ -12,6 +12,7 @@#include "fuse_log.h" +G_GNUC_PRINTF(2, 0)static void default_log_func (__attribute__((unused))enum fuse_log_level level,const char *fmt,va_list ap) {
tools/virtiofsd/fuse_log.h +4 -2
@@ -45,7 +45,8 @@ enum fuse_log_level {* @param ap format string arguments */ typedef void (*fuse_log_func_t )(enum fuse_log_level level,const char *fmt, -va_list ap); + va_list ap) +G_GNUC_PRINTF (2 ,0 );/** * Install a custom log handler function.
@@ -68,6 +69,7 @@ void fuse_set_log_func(fuse_log_func_t func);* @param level severity level (FUSE_LOG_ERR, FUSE_LOG_DEBUG, etc) * @param fmt sprintf-style format string including newline */ -void fuse_log (enum fuse_log_level level,const char *fmt, ...); +void fuse_log(enum fuse_log_level level, const char *fmt, ...) + G_GNUC_PRINTF(2, 3);#endif /* FUSE_LOG_H_ */
tools/virtiofsd/passthrough_ll.c +1 -0
@@ -4182,6 +4182,7 @@ static void setup_nofile_rlimit(unsigned long rlimit_nofile) } } +G_GNUC_PRINTF(2, 0)static void log_func (enum fuse_log_level level,const char *fmt,va_list ap) { g_autofree char *localfmt = NULL;
Signature · 1 line
2.38.1
Re: [PATCH 3/6] tools/virtiofsd: add G_GNUC_PRINTF for logging functions
Quoted 1 line · * Daniel P. Berrangé ([email protected]) wrote:
Signed-off-by Daniel P. Berrangé <[email protected]>
Yes, although I'm a little surprised this hasn't thrown up any warnings.
Quoted 56 lines
--- tools/virtiofsd/fuse_log.c | 1 + tools/virtiofsd/fuse_log.h | 6 ++++-- tools/virtiofsd/passthrough_ll.c | 1 + 3 files changed, 6 insertions(+), 2 deletions(-)tools/virtiofsd/fuse_log.c +1
-0@@ -12,6 +12,7 @@#include "fuse_log.h" +G_GNUC_PRINTF(2, 0)static void default_log_func (__attribute__((unused))enum fuse_log_level level,const char *fmt,va_list ap) {tools/virtiofsd/fuse_log.h +4
-2@@ -45,7 +45,8 @@ enum fuse_log_level {* @param ap format string arguments */ typedef void (*fuse_log_func_t )(enum fuse_log_level level,const char *fmt, -va_list ap); + va_list ap) +G_GNUC_PRINTF (2 ,0 );/** * Install a custom log handler function. @@ -68,6 +69,7 @@ void fuse_set_log_func(fuse_log_func_t func);* @param level severity level (FUSE_LOG_ERR, FUSE_LOG_DEBUG, etc) * @param fmt sprintf-style format string including newline */ -void fuse_log (enum fuse_log_level level,const char *fmt, ...); +void fuse_log(enum fuse_log_level level, const char *fmt, ...) + G_GNUC_PRINTF(2, 3);#endif /* FUSE_LOG_H_ */ tools/virtiofsd/passthrough_ll.c +1
-0@@ -4182,6 +4182,7 @@ static void setup_nofile_rlimit(unsigned long rlimit_nofile) } } +G_GNUC_PRINTF(2, 0)static void log_func (enum fuse_log_level level,const char *fmt,va_list ap) { g_autofree char *localfmt = NULL;Signature · 1 line
2.38.1
Signature · 1 line
Dr. David Alan Gilbert / [email protected] / Manchester, UK
PATCH 4/6 util/error: add G_GNUC_PRINTF for various functions
In reply to Daniel P. Berrangé--- util/error-report.c | 1 + util/error.c | 1 + 2 files changed, 2 insertions(+)
util/error-report.c +1 -0
@@ -193,6 +193,7 @@ real_time_iso8601(void)* a single phrase, with no newline or trailing punctuation. * Prepend the current location and append a newline. */ +G_GNUC_PRINTF(2, 0)static void vreport (report_type type,const char *fmt,va_list ap) {gchar *timestr;
util/error.c +1 -0
@@ -45,6 +45,7 @@ static void error_handle_fatal(Error **errp, Error *err) } } +G_GNUC_PRINTF(6, 0) static void error_setv(Error **errp, const char *src, int line, const char *func, ErrorClass err_class, const char *fmt, va_list ap,
Signature · 1 line
2.38.1
Re: [PATCH 4/6] util/error: add G_GNUC_PRINTF for various functions
Quoted 5 lines · Daniel P. Berrangé
Signed-off-by Daniel P. Berrangé <[email protected]>--- util/error-report.c | 1 + util/error.c | 1 + 2 files changed, 2 insertions(+)
Re: [PATCH 4/6] util/error: add G_GNUC_PRINTF for various functions
In reply to Daniel P. BerrangéQuoted 23 lines · Daniel P. Berrangé
Signed-off-by Daniel P. Berrangé <[email protected]>--- util/error-report.c | 1 + util/error.c | 1 + 2 files changed, 2 insertions(+)util/error-report.c +1
-0@@ -193,6 +193,7 @@ real_time_iso8601(void)* a single phrase, with no newline or trailing punctuation. * Prepend the current location and append a newline. */ +G_GNUC_PRINTF(2, 0)static void vreport (report_type type,const char *fmt,va_list ap) {gchar *timestr;util/error.c +0
-0
util/error.c static void error_handle_fatal(Error **errp, Error *err) · line 51
Quoted 7 lines
util/error.c +1
-0@@ -45,6 +45,7 @@ static void error_handle_fatal(Error **errp, Error *err) } } +G_GNUC_PRINTF(6, 0) static void error_setv(Error **errp, const char *src, int line, const char *func, ErrorClass err_class, const char *fmt, va_list ap,
PATCH 5/6 tests: add G_GNUC_PRINTF for various functions
In reply to Daniel P. Berrangé--- tests/qtest/ahci-test.c | 3 +++ tests/qtest/arm-cpu-features.c | 1 + tests/qtest/erst-test.c | 2 +- tests/qtest/ide-test.c | 3 ++- tests/qtest/ivshmem-test.c | 4 ++-- tests/qtest/libqmp.c | 2 +- tests/qtest/libqos/libqos-pc.h | 6 ++++-- tests/qtest/libqos/libqos-spapr.h | 6 ++++-- tests/qtest/libqos/libqos.h | 6 ++++-- tests/qtest/libqos/virtio-9p.c | 1 + tests/qtest/migration-helpers.h | 1 + tests/qtest/rtas-test.c | 2 +- tests/qtest/usb-hcd-uhci-test.c | 4 ++-- tests/unit/test-qmp-cmds.c | 13 +++++++++---- 14 files changed, 36 insertions(+), 18 deletions(-)
tests/qtest/ahci-test.c +3 -0
@@ -154,6 +154,7 @@ static void ahci_migrate(AHCIQState *from, AHCIQState *to, const char *uri)/** * Start a Q35 machine and bookmark a handle to the AHCI device. */ +G_GNUC_PRINTF(1, 0)static AHCIQState *ahci_vboot (const char *cli,va_list ap) {AHCIQState *s;
@@ -171,6 +172,7 @@ static AHCIQState *ahci_vboot(const char *cli, va_list ap)/** * Start a Q35 machine and bookmark a handle to the AHCI device. */ +G_GNUC_PRINTF(1, 2)static AHCIQState *ahci_boot (const char *cli, ...) {AHCIQState *s;
@@ -209,6 +211,7 @@ static void ahci_shutdown(AHCIQState *ahci)* Boot and fully enable the HBA device. * @see ahci_boot, ahci_pci_enable and ahci_hba_enable. */ +G_GNUC_PRINTF(1, 2)static AHCIQState *ahci_boot_and_enable (const char *cli, ...) {AHCIQState *ahci;
tests/qtest/arm-cpu-features.c +1 -0
@@ -32,6 +32,7 @@ static QDict *do_query_no_props(QTestState *qts, const char *cpu_type) QUERY_TAIL, cpu_type); } +G_GNUC_PRINTF(3, 4)static QDict *do_query (QTestState *qts,const char *cpu_type,const char *fmt, ...) {
tests/qtest/erst-test.c +1 -1
@@ -98,7 +98,7 @@ static void setup_vm_cmd(ERSTState *s, const char *cmd)const char *arch =qtest_get_arch ();if (strcmp (arch,"i386" ) ==0 ||strcmp (arch,"x86_64" ) ==0 ) { - s->qs =qtest_pc_boot (cmd); + s->qs =qtest_pc_boot ("%s" , cmd); }else {g_printerr ("erst-test tests are only available on x86\n" );exit (EXIT_FAILURE );
tests/qtest/ide-test.c +2 -1
@@ -125,6 +125,7 @@ static QGuestAllocator guest_malloc;static char *tmp_path[2 ];static char *debug_path; +G_GNUC_PRINTF(1, 2)static QTestState *ide_test_start (const char *cmdline_fmt, ...) {QTestState *qts;
@@ -788,7 +789,7 @@ static void test_flush_nodev(void)QPCIDevice *dev;QPCIBar bmdma_bar, ide_bar; - qts =ide_test_start ("" ); + qts =ide_test_start ("%s" ,"" ); dev =get_pci_device (qts, &bmdma_bar, &ide_bar);
tests/qtest/ivshmem-test.c +2 -2
@@ -109,9 +109,9 @@ static void setup_vm_cmd(IVState *s, const char *cmd, bool msix)const char *arch =qtest_get_arch ();if (strcmp (arch,"i386" ) ==0 ||strcmp (arch,"x86_64" ) ==0 ) { - s->qs =qtest_pc_boot (cmd); + s->qs =qtest_pc_boot ("%s" , cmd); }else if (strcmp (arch,"ppc64" ) ==0 ) { - s->qs =qtest_spapr_boot (cmd); + s->qs =qtest_spapr_boot ("%s" , cmd); }else {g_printerr ("ivshmem-test tests are only available on x86 or ppc64\n" );exit (EXIT_FAILURE );
tests/qtest/libqmp.c +1 -1
@@ -134,7 +134,7 @@ static void socket_send_fds(int socket_fd, int *fds, size_t fds_num,* in the case that they choose to discard all replies up until * a particular EVENT is received. */ -static void +static G_GNUC_PRINTF(4, 0) void _qmp_fd_vsend_fds(int fd, int *fds, size_t fds_num, const char *fmt, va_list ap) {
tests/qtest/libqos/libqos-pc.h +4 -2
@@ -3,8 +3,10 @@#include "libqos.h" -QOSState *qtest_pc_vboot (const char *cmdline_fmt,va_list ap); -QOSState *qtest_pc_boot (const char *cmdline_fmt, ...); +QOSState *qtest_pc_vboot (const char *cmdline_fmt,va_list ap) +G_GNUC_PRINTF (1 ,0 ); +QOSState *qtest_pc_boot (const char *cmdline_fmt, ...) +G_GNUC_PRINTF (1 ,2 );void qtest_pc_shutdown (QOSState *qs);#endif
tests/qtest/libqos/libqos-spapr.h +4 -2
@@ -3,8 +3,10 @@#include "libqos.h" -QOSState *qtest_spapr_vboot (const char *cmdline_fmt,va_list ap); -QOSState *qtest_spapr_boot (const char *cmdline_fmt, ...); +QOSState *qtest_spapr_vboot (const char *cmdline_fmt,va_list ap) +G_GNUC_PRINTF (1 ,0 ); +QOSState *qtest_spapr_boot (const char *cmdline_fmt, ...) +G_GNUC_PRINTF (1 ,2 );void qtest_spapr_shutdown (QOSState *qs);/* List of capabilities needed to silence warnings with TCG */
tests/qtest/libqos/libqos.h +4 -2
@@ -21,8 +21,10 @@ struct QOSState {QOSOps *ops; }; -QOSState *qtest_vboot (QOSOps *ops,const char *cmdline_fmt,va_list ap); -QOSState *qtest_boot (QOSOps *ops,const char *cmdline_fmt, ...); +QOSState *qtest_vboot (QOSOps *ops,const char *cmdline_fmt,va_list ap) +G_GNUC_PRINTF (2 ,0 ); +QOSState *qtest_boot (QOSOps *ops,const char *cmdline_fmt, ...) +G_GNUC_PRINTF (2 ,3 );void qtest_common_shutdown (QOSState *qs);void qtest_shutdown (QOSState *qs);bool have_qemu_img (void );
tests/qtest/libqos/virtio-9p.c +1 -0
@@ -211,6 +211,7 @@ static void *virtio_9p_pci_create(void *pci_bus, QGuestAllocator *t_alloc,* variable arguments of this function to this * replacement string */ +G_GNUC_PRINTF(3, 4)static void regex_replace (GString *haystack,const char *pattern,const char *replace_fmt, ...) {
tests/qtest/migration-helpers.h +1 -0
@@ -25,6 +25,7 @@ QDict *wait_command_fd(QTestState *who, int fd, const char *command, ...); G_GNUC_PRINTF(2, 3)QDict *wait_command (QTestState *who,const char *command, ...); +G_GNUC_PRINTF(2, 3)QDict *qmp_command (QTestState *who,const char *command, ...);G_GNUC_PRINTF (3 ,4 )
tests/qtest/rtas-test.c +1 -1
@@ -13,7 +13,7 @@ static void run_test_rtas_get_time_of_day(const char *machine)uint64_t ret;time_t t1, t2; - qs =qtest_spapr_boot (machine); + qs =qtest_spapr_boot ("%s" , machine); t1 =time (NULL ); ret =qrtas_get_time_of_day (qs->qts, &qs->alloc, &tm, &ns);
tests/qtest/usb-hcd-uhci-test.c +2 -2
@@ -72,9 +72,9 @@ int main(int argc, char **argv)qtest_add_func ("/uhci/pci/hotplug/usb-storage" , test_usb_storage_hotplug);if (strcmp (arch,"i386" ) ==0 ||strcmp (arch,"x86_64" ) ==0 ) { - qs =qtest_pc_boot (cmd); + qs =qtest_pc_boot ("%s" , cmd); }else if (strcmp (arch,"ppc64" ) ==0 ) { - qs =qtest_spapr_boot (cmd); + qs =qtest_spapr_boot ("%s" , cmd); }else {g_printerr ("usb-hcd-uhci-test tests are only " "available on x86 or ppc64\n" );
tests/unit/test-qmp-cmds.c +9 -4
@@ -138,6 +138,7 @@ void qmp___org_qemu_x_command(__org_qemu_x_EnumList *a, } +G_GNUC_PRINTF(2, 3)static QObject *do_qmp_dispatch (bool allow_oob,const char *template, ...) {va_list ap;
@@ -160,6 +161,7 @@ static QObject *do_qmp_dispatch(bool allow_oob, const char *template, ...)return ret; } +G_GNUC_PRINTF(3, 4)static void do_qmp_dispatch_error (bool allow_oob,ErrorClass cls,const char *template, ...) {
@@ -269,7 +271,7 @@ static void test_dispatch_cmd_io(void)static void test_dispatch_cmd_deprecated (void ) { -const char *cmd ="{ 'execute': 'test-command-features1' }" ; +#define cmd "{ 'execute': 'test-command-features1' }"QDict *ret;memset (&compat_policy,0 ,sizeof (compat_policy));
@@ -287,12 +289,13 @@ static void test_dispatch_cmd_deprecated(void) compat_policy.deprecated_input =COMPAT_POLICY_INPUT_REJECT ;do_qmp_dispatch_error (false,ERROR_CLASS_COMMAND_NOT_FOUND , cmd); +#undef cmd }static void test_dispatch_cmd_arg_deprecated (void ) { -const char *cmd ="{ 'execute': 'test-features0'," -" 'arguments': { 'fs1': { 'foo': 42 } } }" ; +#define cmd "{ 'execute': 'test-features0'," \ + " 'arguments': { 'fs1': { 'foo': 42 } } }"QDict *ret;memset (&compat_policy,0 ,sizeof (compat_policy));
@@ -310,11 +313,12 @@ static void test_dispatch_cmd_arg_deprecated(void) compat_policy.deprecated_input =COMPAT_POLICY_INPUT_REJECT ;do_qmp_dispatch_error (false,ERROR_CLASS_GENERIC_ERROR , cmd); +#undef cmd }static void test_dispatch_cmd_ret_deprecated (void ) { -const char *cmd ="{ 'execute': 'test-features0' }" ; +#define cmd "{ 'execute': 'test-features0' }"QDict *ret;memset (&compat_policy,0 ,sizeof (compat_policy));
@@ -334,6 +338,7 @@ static void test_dispatch_cmd_ret_deprecated(void) ret =qobject_to (QDict,do_qmp_dispatch (false, cmd));assert (ret &&qdict_size (ret) ==0 );qobject_unref (ret); +#undef cmd }/* test generated dealloc functions for generated types */
Signature · 1 line
2.38.1
Re: [PATCH 5/6] tests: add G_GNUC_PRINTF for various functions
Quoted 17 lines · Daniel P. Berrangé
Signed-off-by Daniel P. Berrangé <[email protected]>--- tests/qtest/ahci-test.c | 3 +++ tests/qtest/arm-cpu-features.c | 1 + tests/qtest/erst-test.c | 2 +- tests/qtest/ide-test.c | 3 ++- tests/qtest/ivshmem-test.c | 4 ++-- tests/qtest/libqmp.c | 2 +- tests/qtest/libqos/libqos-pc.h | 6 ++++-- tests/qtest/libqos/libqos-spapr.h | 6 ++++-- tests/qtest/libqos/libqos.h | 6 ++++-- tests/qtest/libqos/virtio-9p.c | 1 + tests/qtest/migration-helpers.h | 1 + tests/qtest/rtas-test.c | 2 +- tests/qtest/usb-hcd-uhci-test.c | 4 ++-- tests/unit/test-qmp-cmds.c | 13 +++++++++---- 14 files changed, 36 insertions(+), 18 deletions(-)
...
Quoted 21 lines
tests/unit/test-qmp-cmds.c +2
-0@@ -138,6 +138,7 @@ void qmp___org_qemu_x_command(__org_qemu_x_EnumList *a, } +G_GNUC_PRINTF(2, 3)static QObject *do_qmp_dispatch (bool allow_oob,const char *template, ...) {va_list ap;@@ -160,6 +161,7 @@ static QObject *do_qmp_dispatch(bool allow_oob, const char *template, ...)return ret; } +G_GNUC_PRINTF(3, 4)static void do_qmp_dispatch_error (bool allow_oob,ErrorClass cls,const char *template, ...) {
tests/unit/test-qmp-cmds.c static void test_dispatch_cmd_io(void) · line 275
Quoted 6 lines
tests/unit/test-qmp-cmds.c +1
-1@@ -269,7 +271,7 @@ static void test_dispatch_cmd_io(void)static void test_dispatch_cmd_deprecated (void ) { -const char *cmd ="{ 'execute': 'test-command-features1' }" ; +#define cmd "{ 'execute': 'test-command-features1' }"QDict *ret;
That looks weird, why is this required?
Thomas
Re: [PATCH 5/6] tests: add G_GNUC_PRINTF for various functions
Quoted 36 lines · Thomas Huth
Quoted 17 lines · Daniel P. Berrangé
Signed-off-by Daniel P. Berrangé <[email protected]>--- tests/qtest/ahci-test.c | 3 +++ tests/qtest/arm-cpu-features.c | 1 + tests/qtest/erst-test.c | 2 +- tests/qtest/ide-test.c | 3 ++- tests/qtest/ivshmem-test.c | 4 ++-- tests/qtest/libqmp.c | 2 +- tests/qtest/libqos/libqos-pc.h | 6 ++++-- tests/qtest/libqos/libqos-spapr.h | 6 ++++-- tests/qtest/libqos/libqos.h | 6 ++++-- tests/qtest/libqos/virtio-9p.c | 1 + tests/qtest/migration-helpers.h | 1 + tests/qtest/rtas-test.c | 2 +- tests/qtest/usb-hcd-uhci-test.c | 4 ++-- tests/unit/test-qmp-cmds.c | 13 +++++++++---- 14 files changed, 36 insertions(+), 18 deletions(-)...
Quoted 17 lines
tests/unit/test-qmp-cmds.c +2
-0@@ -138,6 +138,7 @@ void qmp___org_qemu_x_command(__org_qemu_x_EnumList *a, } +G_GNUC_PRINTF(2, 3)static QObject *do_qmp_dispatch (bool allow_oob,const char *template, ...) {va_list ap;@@ -160,6 +161,7 @@ static QObject *do_qmp_dispatch(bool allow_oob, const char *template, ...)return ret; } +G_GNUC_PRINTF(3, 4)static void do_qmp_dispatch_error (bool allow_oob,ErrorClass cls,const char *template, ...) {
Quoted 8 lines
tests/unit/test-qmp-cmds.c static void test_dispatch_cmd_io(void) · line 274
Quoted 6 lines
tests/unit/test-qmp-cmds.c +1
-1@@ -269,7 +271,7 @@ static void test_dispatch_cmd_io(void)static void test_dispatch_cmd_deprecated (void ) { -const char *cmd ="{ 'execute': 'test-command-features1' }" ; +#define cmd "{ 'execute': 'test-command-features1' }"QDict *ret;That looks weird, why is this required?
This means that the compiler can see we're passing a constant string into the API call a few lines lower. Without it, the compiler can't see that 'cmd' doesn't contain any printf format specifiers, and thus it would force us to use func('%s', cmd)... except that's not actually possible since our crazy json printf formatter doesn't allow arbitrary '%s', the '%s' can only occur at well defined points in the JSON doc.
Using a constant string via #define was the easiest way to give the compiler visibility of the safety.
With regards,
Daniel
Signature · 3 lines
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
PATCH 6/6 enforce use of G_GNUC_PRINTF attributes
In reply to Daniel P. BerrangéWe've been very gradually adding G_GNUC_PRINTF annotations to functions over years. This has been useful in detecting certain malformed printf strings, or cases where we pass user data as the printf format which is a potential security flaw.
Given the inherant memory corruption danger in use of format strings vs mis-matched variadic arguments, it is worth applying G_GNUC_PRINTF to all functions using printf, even if we know they are safe.
The compilers can reasonably reliably identify such places with the -Wsuggest-attribute=format / -Wmissing-format-attribute flags.
--- configure | 2 ++ 1 file changed, 2 insertions(+)
configure +2 -0
@@ -1208,6 +1208,8 @@ add_to warn_flags -Wnested-externs add_to warn_flags -Wendif-labels add_to warn_flags -Wexpansion-to-defined add_to warn_flags -Wimplicit-fallthrough=2 +add_to warn_flags -Wsuggest-attribute=format +add_to warn_flags -Wmissing-format-attribute nowarn_flags= add_to nowarn_flags -Wno-initializer-overrides
Signature · 1 line
2.38.1
Paolo Bonzini
AppliedQueued, thanks.
Paolo